com.sapportals.wcm.util.acl

Interface IAclPermission

All Known Implementing Classes:

AclPermissionImpl

public interface IAclPermission

An IAclPermission denominates a set of actions that can be carried out on an object and can be granted or denied to a principal.

• the mapping (IAction, IAclPermission) is done in the IAclSecurityManager
• IAclPermissions can be nested, so an IAclPermission may contain other IAclPermissions as members

Field Summary

static String	ACL_PERMISSION_CHANGE_APPROVER
static String	ACL_PERMISSION_DELETE
static String	ACL_PERMISSION_DELETE_COLLABORATION
static String	ACL_PERMISSION_FOLDERSETTINGS
static String	ACL_PERMISSION_FULL_CONTROL permissions: full control always contains all other permissions
static String	ACL_PERMISSION_READ repository permissions
static String	ACL_PERMISSION_READWRITE
static String	ACL_PERMISSION_SUBSCRIPTION_ACTIVE
static String	ACL_PERMISSION_SUBSCRIPTION_FOLDER
static String	ACL_PERMISSION_SUBSCRIPTION_PASSIVE
static String	ACL_PERMISSION_SUBSCRIPTION_UNSUBSCRIBE service permissions
static String	ACL_PERMISSION_WRITE

Method Summary

boolean	addMember(IAclPermission permission) add some permission as a new member to the present permission
boolean	equals(IAclPermission permission) check whether some permission equals the present permission
String	getDescription() get the description of the permission
String	getDescription(Locale locale)
IAclPermissionList	getMembers() get a list of the members of the present permission
String	getName() get the name of the permission
int	getSortIndex() get the sort index of the permission (for display in a control)
boolean	isAtomic() check whether the present permission has no members
boolean	isContained(IAclPermission permission) check whether a permission and all of its members are contained in the present permission
boolean	isMember(IAclPermission permission) check whether some permission is a member of the present permission
boolean	isPredefined() check whether the present permission is predefined
boolean	removeMember(IAclPermission permission) remove a member from the present permission

Field Detail

ACL_PERMISSION_FULL_CONTROL

static final String ACL_PERMISSION_FULL_CONTROL

permissions: full control always contains all other permissions

See Also:

Constant Field Values

ACL_PERMISSION_READ

static final String ACL_PERMISSION_READ

repository permissions

See Also:

Constant Field Values

ACL_PERMISSION_WRITE

static final String ACL_PERMISSION_WRITE

See Also:

Constant Field Values

ACL_PERMISSION_READWRITE

static final String ACL_PERMISSION_READWRITE

See Also:

Constant Field Values

ACL_PERMISSION_DELETE

static final String ACL_PERMISSION_DELETE

See Also:

Constant Field Values

ACL_PERMISSION_SUBSCRIPTION_UNSUBSCRIBE

static final String ACL_PERMISSION_SUBSCRIPTION_UNSUBSCRIBE

service permissions

See Also:

Constant Field Values

ACL_PERMISSION_SUBSCRIPTION_ACTIVE

static final String ACL_PERMISSION_SUBSCRIPTION_ACTIVE

See Also:

Constant Field Values

ACL_PERMISSION_SUBSCRIPTION_PASSIVE

static final String ACL_PERMISSION_SUBSCRIPTION_PASSIVE

See Also:

Constant Field Values

ACL_PERMISSION_SUBSCRIPTION_FOLDER

static final String ACL_PERMISSION_SUBSCRIPTION_FOLDER

See Also:

Constant Field Values

ACL_PERMISSION_CHANGE_APPROVER

static final String ACL_PERMISSION_CHANGE_APPROVER

See Also:

Constant Field Values

ACL_PERMISSION_DELETE_COLLABORATION

static final String ACL_PERMISSION_DELETE_COLLABORATION

See Also:

Constant Field Values

ACL_PERMISSION_FOLDERSETTINGS

static final String ACL_PERMISSION_FOLDERSETTINGS

See Also:

Constant Field Values

Method Detail

isAtomic

boolean isAtomic()
                 throws AclPersistenceException

check whether the present permission has no members

Returns:

true if the permission denominates

Throws:

AclPersistenceException - Exception raised in failure situation

isMember

boolean isMember(IAclPermission permission)
                 throws AclPersistenceException

check whether some permission is a member of the present permission

Parameters:

permission - a permission

Returns:

true iff the permission is a member of the present permission

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

getMembers

IAclPermissionList getMembers()
                              throws AclPersistenceException

get a list of the members of the present permission

Returns:

the members of the present permission

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

addMember

boolean addMember(IAclPermission permission)
                  throws AclPersistenceException,
                         PermissionExistsException,
                         PredefinedPermissionException,
                         PermissionUsedException

add some permission as a new member to the present permission

Parameters:

permission - the permission

Returns:

true iff the permission was added successfully

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

PermissionExistsException - the permission is already a member

PredefinedPermissionException - the permission is predefined and thus immutable

PermissionUsedException - the permission is used in some ACL and thus immutable

removeMember

boolean removeMember(IAclPermission permission)
                     throws AclPersistenceException,
                            PredefinedPermissionException,
                            PermissionUsedException

remove a member from the present permission

Parameters:

permission - the member permission

Returns:

true iff the member permission was removed successfully

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

PredefinedPermissionException - the permission is predefined and thus immutable

PermissionUsedException - the permission is used in some ACL and thus immutable

isPredefined

boolean isPredefined()
                     throws AclPersistenceException

check whether the present permission is predefined

Returns:

true iff the present permission is predefined

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

isContained

boolean isContained(IAclPermission permission)
                    throws AclPersistenceException

check whether a permission and all of its members are contained in the present permission

Parameters:

permission - TBD: Description of the incoming method parameter

Returns:

true iff a permission and all of its members are contained in the present permission

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

getName

String getName()
               throws AclPersistenceException

get the name of the permission

Returns:

the name of the permission

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

getDescription

String getDescription()
                      throws AclPersistenceException

get the description of the permission

Returns:

the description of the permission

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

getDescription

String getDescription(Locale locale)
                      throws AclPersistenceException

Throws:

AclPersistenceException

getSortIndex

int getSortIndex()
                 throws AclPersistenceException

get the sort index of the permission (for display in a control)

Returns:

the sort index of the permission

Throws:

AclPersistenceException - a problem with the storage where the ACLs are persisted occurred

equals

boolean equals(IAclPermission permission)
               throws AclPersistenceException

check whether some permission equals the present permission

Parameters:

permission - the permission to compare to

Returns:

true iff the permission equals the present permission

Throws:

AclPersistenceException - Exception raised in failure situation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM