com.ibm.portal.cp.ac
Interface CPPermissionManager

public interface CPPermissionManager

Interface that performs access control checks, e. g. this can be used to test if a user is allowed to create ratings or to view tags.

For portal resources this interface is backed by the default portal access control layer whereas for custom resources an extension point is provided allowing to plug-in custom access control logic for tags and ratings.

Since:

7.0.0

Note:

This interface is designed to be implemented by clients.

Method Summary

boolean	canCreateCollaborativeResource(CollaborativeResourceType aType, ObjectID userID) Checks if the given user is allowed to create a collaborative resource of the given type
boolean	canCreatePrivateResource(CollaborativeResourceType aType, ObjectID userID) Checks if the given user is allowed to create a private collaborative resource of the given type
boolean	canCreateTag(CollaborativeResourceType aType, ObjectID userID, java.lang.String aTagName, boolean isPrivate) Checks if the given user is allowed to create a concrete tag.
<C extends CollaborativeResource> boolean	canDeleteCollaborativeResource(CollaborativeResourceType aType, ObjectID userID, C aResource) Checks if the given user is allowed to delete the given collaborative resource
<C extends CollaborativeResource> boolean	canDeletePrivateResource(CollaborativeResourceType aType, ObjectID userID, C aResource) Checks if the given user is allowed to delete the given private collaborative resource
boolean	canDeleteTag(CollaborativeResourceType aType, ObjectID userID, Tag aTag) Checks if the given user is allowed to delete a concrete tag.
boolean	canUpdateTag(CollaborativeResourceType aType, ObjectID userID, Tag aTag) Checks if the given user is allowed to update a concrete tag.
boolean	canViewCollaborativeResource(CollaborativeResourceType aType, ObjectID userID) Checks if the given user is allowed to read (view) a collaborative resource of the given type
boolean	canViewTag(CollaborativeResourceType aType, ObjectID userID, java.lang.String aTagName) Checks if the given user is allowed to read (view) a concrete tag.

Method Detail

canCreateCollaborativeResource

boolean canCreateCollaborativeResource(CollaborativeResourceType aType,
                                       ObjectID userID)
                                       throws CPPermissionManagerException

Checks if the given user is allowed to create a collaborative resource of the given type

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

Returns:

true if the user is allowed to create a collaborative resources of the given type

Throws:

CPPermissionManagerException

canCreatePrivateResource

boolean canCreatePrivateResource(CollaborativeResourceType aType,
                                 ObjectID userID)
                                 throws CPPermissionManagerException

Checks if the given user is allowed to create a private collaborative resource of the given type

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

Returns:

true if the user is allowed to create a private collaborative resources of the given type

Throws:

CPPermissionManagerException

canViewCollaborativeResource

boolean canViewCollaborativeResource(CollaborativeResourceType aType,
                                     ObjectID userID)
                                     throws CPPermissionManagerException

Checks if the given user is allowed to read (view) a collaborative resource of the given type

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

Returns:

true if the user is allowed to create a collaborative resources of the given type

Throws:

CPPermissionManagerException

canDeleteCollaborativeResource

<C extends CollaborativeResource> boolean canDeleteCollaborativeResource(CollaborativeResourceType aType,
                                                                         ObjectID userID,
                                                                         C aResource)
                                       throws CPPermissionManagerException

Checks if the given user is allowed to delete the given collaborative resource

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

aResource - The private collaborative resource the user wants to delete

Returns:

true if the user is allowed to delete the given collaborative resource

Throws:

CPPermissionManagerException

canDeletePrivateResource

<C extends CollaborativeResource> boolean canDeletePrivateResource(CollaborativeResourceType aType,
                                                                   ObjectID userID,
                                                                   C aResource)
                                 throws CPPermissionManagerException

Checks if the given user is allowed to delete the given private collaborative resource

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

aResource - The private collaborative resource the user wants to delete

Returns:

true if the user is allowed to delete the given collaborative resource

Throws:

CPPermissionManagerException

canCreateTag

boolean canCreateTag(CollaborativeResourceType aType,
                     ObjectID userID,
                     java.lang.String aTagName,
                     boolean isPrivate)
                     throws CPPermissionManagerException

Checks if the given user is allowed to create a concrete tag.

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

aTagName - The name of the Tag to be created

isPrivate - Flag indicating whether the Tag is private

Returns:

true if the user is allowed to create the concrete tag.

Throws:

CPPermissionManagerException

canViewTag

boolean canViewTag(CollaborativeResourceType aType,
                   ObjectID userID,
                   java.lang.String aTagName)
                   throws CPPermissionManagerException

Checks if the given user is allowed to read (view) a concrete tag.

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

aTagName - The name of the Tag to be created * @return true if the user is allowed to read (view) the concrete tag.

Throws:

CPPermissionManagerException

canUpdateTag

boolean canUpdateTag(CollaborativeResourceType aType,
                     ObjectID userID,
                     Tag aTag)
                     throws CPPermissionManagerException

Checks if the given user is allowed to update a concrete tag.

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

aTag - The Tag to be updated

Returns:

true if the user is allowed to update the concrete tag.

Throws:

CPPermissionManagerException

canDeleteTag

boolean canDeleteTag(CollaborativeResourceType aType,
                     ObjectID userID,
                     Tag aTag)
                     throws CPPermissionManagerException

Checks if the given user is allowed to delete a concrete tag.

Parameters:

aType - The collaborative resource type

userID - The ObjectID of the user

aTag - The Tag to be deleted

Returns:

true if the user is allowed to delete the concrete tag.

Throws:

CPPermissionManagerException