public interface IAcl extends IOwner
IAcl
is a Access Control List which defines the access
permissions to an object. Modifier and Type | Method and Description |
---|---|
boolean |
addEntry(IPrincipal caller,
IAclEntry aclEntry)
add an ACE to the ACL
|
boolean |
addEntry(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
IAclEntry aclEntry)
Deprecated.
As of NetWeaver 7.1, replaced by
addEntry(com.sap.security.api.IPrincipal,IAclEntry) |
boolean |
checkPermission(IPrincipal principal,
IAclPermission permission)
check whether the ACL grants a specific permission to a user
|
boolean |
checkPermission(com.sapportals.portal.security.usermanagement.IUMPrincipal principal,
IAclPermission permission)
Deprecated.
As of NetWeaver 7.1, replaced by
checkPermission(com.sap.security.api.IPrincipal,IAclPermission) |
List |
getDescendantsWithAcl(String postFix)
get a list of all IDs of the descendants of the ACL that have an ACL too
|
IAclEntryList |
getEntries()
get the ACEs of the ACL
|
IAclEntryList |
getEntries(IPrincipal principal)
get the ACEs of the ACL concerning a specific principal
|
IAclEntryList |
getEntries(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
Deprecated.
As of NetWeaver 7.1, replaced by
getEntries(com.sap.security.api.IPrincipal) |
com.sapportals.portal.security.usermanagement.IUMPrincipal |
getLockingUser()
Deprecated.
As of NetWeaver 7.1, replaced by
getLockingUserUME() |
IPrincipal |
getLockingUserUME()
get the user which locked the ACL
|
boolean |
hasDescendantsWithAcl(String postFix)
check whether the ACl has descendants that have an ACL too
|
boolean |
isLocked()
check whether the ACL is locked
|
boolean |
isReadOnly()
check whether the ACL is read only
|
boolean |
isUpToDate()
check whether the ACL is up to date (check change level of persisted ACL)
(used to invalidate ACL caches)
|
boolean |
lock(IPrincipal caller)
lock the ACL (the lock is cooperative and affects only the result of
subsequent calls to lock() or isLocked())
|
boolean |
lock(com.sapportals.portal.security.usermanagement.IUMPrincipal caller)
Deprecated.
As of NetWeaver 7.1, replaced by
lock(com.sap.security.api.IPrincipal) |
boolean |
removeEntry(IPrincipal caller,
IAclEntry aclEntry)
remove an ACE from the ACL
|
boolean |
removeEntry(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
IAclEntry aclEntry)
Deprecated.
As of NetWeaver 7.1, replaced by
removeEntry(com.sap.security.api.IPrincipal,IAclEntry) |
void |
unlock(IPrincipal caller)
unlock the ACL
|
void |
unlock(com.sapportals.portal.security.usermanagement.IUMPrincipal caller)
Deprecated.
As of NetWeaver 7.1, replaced by
unlock(com.sap.security.api.IPrincipal) |
addOwner, addOwner, getOwners, getOwnersUME, isAuthorized, isAuthorized, isOwner, isOwner, removeOwner, removeOwner
boolean addEntry(com.sapportals.portal.security.usermanagement.IUMPrincipal caller, IAclEntry aclEntry) throws AclPersistenceException, InvalidClassException, NotAuthorizedException, AlreadyAssignedToAclException, PermissionNotSupportedException
addEntry(com.sap.security.api.IPrincipal,IAclEntry)
caller
- a principal which must be an owner of the ACLaclEntry
- the ACEAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredInvalidClassException
- the ACE was created by a foreign resource
acl managerNotAuthorizedException
- the caller in not an ownerAlreadyAssignedToAclException
- the ACE is already assigned to an
ACLPermissionNotSupportedException
- the permission of the ACE is not
supported for the type of the ACL's objectboolean addEntry(IPrincipal caller, IAclEntry aclEntry) throws AclPersistenceException, InvalidClassException, NotAuthorizedException, AlreadyAssignedToAclException, PermissionNotSupportedException
caller
- a principal which must be an owner of the ACLaclEntry
- the ACEAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredInvalidClassException
- the ACE was created by a foreign resource
acl managerNotAuthorizedException
- the caller in not an ownerAlreadyAssignedToAclException
- the ACE is already assigned to an
ACLPermissionNotSupportedException
- the permission of the ACE is not
supported for the type of the ACL's objectboolean removeEntry(com.sapportals.portal.security.usermanagement.IUMPrincipal caller, IAclEntry aclEntry) throws AclPersistenceException, InvalidClassException, NotAuthorizedException
removeEntry(com.sap.security.api.IPrincipal,IAclEntry)
caller
- a principal which must be an owner of the ACLaclEntry
- the ACEAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredInvalidClassException
- the ACE was created by a foreign resource
acl managerNotAuthorizedException
- the caller in not an ownerboolean removeEntry(IPrincipal caller, IAclEntry aclEntry) throws AclPersistenceException, InvalidClassException, NotAuthorizedException
caller
- a principal which must be an owner of the ACLaclEntry
- the ACEAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredInvalidClassException
- the ACE was created by a foreign resource
acl managerNotAuthorizedException
- the caller in not an ownerIAclEntryList getEntries() throws AclPersistenceException
AclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredIAclEntryList getEntries(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) throws AclPersistenceException
getEntries(com.sap.security.api.IPrincipal)
principal
- the principalAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredIAclEntryList getEntries(IPrincipal principal) throws AclPersistenceException
principal
- the principalAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredboolean checkPermission(com.sapportals.portal.security.usermanagement.IUMPrincipal principal, IAclPermission permission) throws AclPersistenceException
checkPermission(com.sap.security.api.IPrincipal,IAclPermission)
permission
- the permissionprincipal
- TBD: Description of the incoming method parameterAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredboolean checkPermission(IPrincipal principal, IAclPermission permission) throws AclPersistenceException
permission
- the permissionprincipal
- TBD: Description of the incoming method parameterAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredboolean lock(com.sapportals.portal.security.usermanagement.IUMPrincipal caller) throws AclPersistenceException, NotAuthorizedException
lock(com.sap.security.api.IPrincipal)
caller
- TBD: Description of the incoming method parameterAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredNotAuthorizedException
- the caller is not an ownerboolean lock(IPrincipal caller) throws AclPersistenceException, NotAuthorizedException
caller
- TBD: Description of the incoming method parameterAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredNotAuthorizedException
- the caller is not an ownerboolean isLocked() throws AclPersistenceException
AclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredcom.sapportals.portal.security.usermanagement.IUMPrincipal getLockingUser() throws AclPersistenceException
getLockingUserUME()
AclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredIPrincipal getLockingUserUME() throws AclPersistenceException
AclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredvoid unlock(com.sapportals.portal.security.usermanagement.IUMPrincipal caller) throws AclPersistenceException, NotAuthorizedException
unlock(com.sap.security.api.IPrincipal)
caller
- TBD: Description of the incoming method parameterAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredNotAuthorizedException
- the caller is not the user which locked
the ACLvoid unlock(IPrincipal caller) throws AclPersistenceException, NotAuthorizedException
caller
- TBD: Description of the incoming method parameterAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredNotAuthorizedException
- the caller is not the user which locked
the ACLboolean hasDescendantsWithAcl(String postFix) throws AclPersistenceException
postFix
- is appended to the ACL ID before the descendants are
identified as all ACLs whose IDs start with this IDAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredList getDescendantsWithAcl(String postFix) throws AclPersistenceException
postFix
- is appended to the ACL ID before the descendants are
identified as all ACLs whose IDs start with this IDAclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredboolean isReadOnly() throws AclPersistenceException
AclPersistenceException
- a problem with the storage where the
ACLs are persisted occurredboolean isUpToDate() throws AclPersistenceException
AclPersistenceException
- Exception raised in failure situationAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice