com.sap.netweaver.bc.rf.common.security.acl
Interface IAclPermission

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

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 java.lang.String	ACL_PERMISSION_CHANGE_APPROVER
static java.lang.String	ACL_PERMISSION_DELETE
static java.lang.String	ACL_PERMISSION_DELETE_COLLABORATION
static java.lang.String	ACL_PERMISSION_FOLDERSETTINGS
static java.lang.String	ACL_PERMISSION_FULL_CONTROL permissions: full control always contains all other permissions
static java.lang.String	ACL_PERMISSION_READ repository permissions
static java.lang.String	ACL_PERMISSION_READWRITE
static java.lang.String	ACL_PERMISSION_SUBSCRIPTION_ACTIVE
static java.lang.String	ACL_PERMISSION_SUBSCRIPTION_FOLDER
static java.lang.String	ACL_PERMISSION_SUBSCRIPTION_PASSIVE
static java.lang.String	ACL_PERMISSION_SUBSCRIPTION_UNSUBSCRIBE service permissions
static java.lang.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
java.lang.String	getDescription() get the description of the permission
java.lang.String	getDescription(java.util.Locale locale) Get the description attribute of the IAclPermission object.
IAclPermissionList	getMembers() get a list of the members of the present permission
java.lang.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

public static final java.lang.String ACL_PERMISSION_FULL_CONTROL

permissions: full control always contains all other permissions

ACL_PERMISSION_READ

public static final java.lang.String ACL_PERMISSION_READ

repository permissions

ACL_PERMISSION_WRITE

public static final java.lang.String ACL_PERMISSION_WRITE

ACL_PERMISSION_READWRITE

public static final java.lang.String ACL_PERMISSION_READWRITE

ACL_PERMISSION_DELETE

public static final java.lang.String ACL_PERMISSION_DELETE

ACL_PERMISSION_SUBSCRIPTION_UNSUBSCRIBE

public static final java.lang.String ACL_PERMISSION_SUBSCRIPTION_UNSUBSCRIBE

service permissions

ACL_PERMISSION_SUBSCRIPTION_ACTIVE

public static final java.lang.String ACL_PERMISSION_SUBSCRIPTION_ACTIVE

ACL_PERMISSION_SUBSCRIPTION_PASSIVE

public static final java.lang.String ACL_PERMISSION_SUBSCRIPTION_PASSIVE

ACL_PERMISSION_SUBSCRIPTION_FOLDER

public static final java.lang.String ACL_PERMISSION_SUBSCRIPTION_FOLDER

ACL_PERMISSION_CHANGE_APPROVER

public static final java.lang.String ACL_PERMISSION_CHANGE_APPROVER

ACL_PERMISSION_DELETE_COLLABORATION

public static final java.lang.String ACL_PERMISSION_DELETE_COLLABORATION

ACL_PERMISSION_FOLDERSETTINGS

public static final java.lang.String ACL_PERMISSION_FOLDERSETTINGS

Method Detail

isAtomic

public boolean isAtomic()
                 throws AclPersistenceException

check whether the present permission has no members

Returns:

The atomic value

Throws:

AclPersistenceException - Exception raised in failure situation

isMember

public 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

public 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

public boolean addMember(IAclPermission permission)
                  throws AclPersistenceException,
                         AclPermissionExistsException,
                         AclPredefinedPermissionException,
                         AclPermissionUsedException

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

AclPermissionExistsException - Exception raised in failure situation

AclPredefinedPermissionException - Exception raised in failure situation

AclPermissionUsedException - Exception raised in failure situation

removeMember

public boolean removeMember(IAclPermission permission)
                     throws AclPersistenceException,
                            AclPredefinedPermissionException,
                            AclPermissionUsedException

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

AclPredefinedPermissionException - Exception raised in failure situation

AclPermissionUsedException - Exception raised in failure situation

isPredefined

public 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

public boolean isContained(IAclPermission permission)
                    throws AclPersistenceException

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

Parameters:

permission - permission to be checked

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

public java.lang.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

public java.lang.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

public java.lang.String getDescription(java.util.Locale locale)
                                throws AclPersistenceException

Get the description attribute of the IAclPermission object.

Parameters:

locale - locale of description

Returns:

The description value

Throws:

AclPersistenceException - Exception raised in failure situation

getSortIndex

public 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

public 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