com.sapportals.wcm.util.acl

Interface IAcl

All Superinterfaces:

IOwner

All Known Subinterfaces:

IAcl4Tx, IAclProvidingDBVersion, IAclRaw, IAclVersioned

public interface IAcl
extends IOwner

An IAcl is a Access Control List which defines the access permissions to an object.
Abbreviations:

• ACL: Access Control List
• ACE: Access Control List Entry

Method Summary

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)

Methods inherited from interface com.sapportals.wcm.util.acl.IOwner

addOwner, addOwner, getOwners, getOwnersUME, isAuthorized, isAuthorized, isOwner, isOwner, removeOwner, removeOwner

Method Detail

addEntry

boolean addEntry(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
                 IAclEntry aclEntry)
                 throws AclPersistenceException,
                        InvalidClassException,
                        NotAuthorizedException,
                        AlreadyAssignedToAclException,
                        PermissionNotSupportedException

Deprecated. As of NetWeaver 7.1, replaced by addEntry(com.sap.security.api.IPrincipal,IAclEntry)

add an ACE to the ACL

Parameters:

caller - a principal which must be an owner of the ACL

aclEntry - the ACE

Returns:

TBD: Description of the outgoing return value

Throws:

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

InvalidClassException - the ACE was created by a foreign resource acl manager

NotAuthorizedException - the caller in not an owner

AlreadyAssignedToAclException - the ACE is already assigned to an ACL

PermissionNotSupportedException - the permission of the ACE is not supported for the type of the ACL's object

addEntry

boolean addEntry(IPrincipal caller,
                 IAclEntry aclEntry)
                 throws AclPersistenceException,
                        InvalidClassException,
                        NotAuthorizedException,
                        AlreadyAssignedToAclException,
                        PermissionNotSupportedException

add an ACE to the ACL

Parameters:

caller - a principal which must be an owner of the ACL

aclEntry - the ACE

Returns:

TBD: Description of the outgoing return value

Throws:

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

InvalidClassException - the ACE was created by a foreign resource acl manager

NotAuthorizedException - the caller in not an owner

AlreadyAssignedToAclException - the ACE is already assigned to an ACL

PermissionNotSupportedException - the permission of the ACE is not supported for the type of the ACL's object

Since:

NetWeaver 7.1

removeEntry

boolean removeEntry(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
                    IAclEntry aclEntry)
                    throws AclPersistenceException,
                           InvalidClassException,
                           NotAuthorizedException

Deprecated. As of NetWeaver 7.1, replaced by removeEntry(com.sap.security.api.IPrincipal,IAclEntry)

remove an ACE from the ACL

Parameters:

caller - a principal which must be an owner of the ACL

aclEntry - the ACE

Returns:

TBD: Description of the outgoing return value

Throws:

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

InvalidClassException - the ACE was created by a foreign resource acl manager

NotAuthorizedException - the caller in not an owner

removeEntry

boolean removeEntry(IPrincipal caller,
                    IAclEntry aclEntry)
                    throws AclPersistenceException,
                           InvalidClassException,
                           NotAuthorizedException

remove an ACE from the ACL

Parameters:

caller - a principal which must be an owner of the ACL

aclEntry - the ACE

Returns:

TBD: Description of the outgoing return value

Throws:

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

InvalidClassException - the ACE was created by a foreign resource acl manager

NotAuthorizedException - the caller in not an owner

Since:

NetWeaver 7.1

getEntries

IAclEntryList getEntries()
                         throws AclPersistenceException

get the ACEs of the ACL

Returns:

entries

Throws:

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

getEntries

IAclEntryList getEntries(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
                         throws AclPersistenceException

Deprecated. As of NetWeaver 7.1, replaced by getEntries(com.sap.security.api.IPrincipal)

get the ACEs of the ACL concerning a specific principal

Parameters:

principal - the principal

Returns:

entries

Throws:

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

getEntries

IAclEntryList getEntries(IPrincipal principal)
                         throws AclPersistenceException

get the ACEs of the ACL concerning a specific principal

Parameters:

principal - the principal

Returns:

entries

Throws:

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

Since:

NetWeaver 7.1

checkPermission

boolean checkPermission(com.sapportals.portal.security.usermanagement.IUMPrincipal principal,
                        IAclPermission permission)
                        throws AclPersistenceException

Deprecated. As of NetWeaver 7.1, replaced by checkPermission(com.sap.security.api.IPrincipal,IAclPermission)

check whether the ACL grants a specific permission to a user

Parameters:

permission - the permission

principal - TBD: Description of the incoming method parameter

Returns:

true iff the permission is granted

Throws:

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

checkPermission

boolean checkPermission(IPrincipal principal,
                        IAclPermission permission)
                        throws AclPersistenceException

check whether the ACL grants a specific permission to a user

Parameters:

permission - the permission

principal - TBD: Description of the incoming method parameter

Returns:

true iff the permission is granted

Throws:

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

Since:

NetWeaver 7.1

lock

boolean lock(com.sapportals.portal.security.usermanagement.IUMPrincipal caller)
             throws AclPersistenceException,
                    NotAuthorizedException

Deprecated. As of NetWeaver 7.1, replaced by lock(com.sap.security.api.IPrincipal)

lock the ACL (the lock is cooperative and affects only the result of subsequent calls to lock() or isLocked())

Parameters:

caller - TBD: Description of the incoming method parameter

Returns:

true iff the ACL was locked successfully

Throws:

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

NotAuthorizedException - the caller is not an owner

lock

boolean lock(IPrincipal caller)
             throws AclPersistenceException,
                    NotAuthorizedException

lock the ACL (the lock is cooperative and affects only the result of subsequent calls to lock() or isLocked())

Parameters:

caller - TBD: Description of the incoming method parameter

Returns:

true iff the ACL was locked successfully

Throws:

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

NotAuthorizedException - the caller is not an owner

Since:

NetWeaver 7.1

isLocked

boolean isLocked()
                 throws AclPersistenceException

check whether the ACL is locked

Returns:

true iff the ACL is locked

Throws:

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

getLockingUser

com.sapportals.portal.security.usermanagement.IUMPrincipal getLockingUser()
                                                                          throws AclPersistenceException

Deprecated. As of NetWeaver 7.1, replaced by getLockingUserUME()

get the user which locked the ACL

Returns:

the user which locked the ACL or null in case the ACL is not locked

Throws:

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

getLockingUserUME

IPrincipal getLockingUserUME()
                             throws AclPersistenceException

get the user which locked the ACL

Returns:

the user which locked the ACL or null in case the ACL is not locked

Throws:

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

Since:

NetWeaver 7.1

unlock

void unlock(com.sapportals.portal.security.usermanagement.IUMPrincipal caller)
            throws AclPersistenceException,
                   NotAuthorizedException

Deprecated. As of NetWeaver 7.1, replaced by unlock(com.sap.security.api.IPrincipal)

unlock the ACL

Parameters:

caller - TBD: Description of the incoming method parameter

Throws:

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

NotAuthorizedException - the caller is not the user which locked the ACL

unlock

void unlock(IPrincipal caller)
            throws AclPersistenceException,
                   NotAuthorizedException

unlock the ACL

Parameters:

caller - TBD: Description of the incoming method parameter

Throws:

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

NotAuthorizedException - the caller is not the user which locked the ACL

Since:

NetWeaver 7.1

hasDescendantsWithAcl

boolean hasDescendantsWithAcl(String postFix)
                              throws AclPersistenceException

check whether the ACl has descendants that have an ACL too

Parameters:

postFix - is appended to the ACL ID before the descendants are identified as all ACLs whose IDs start with this ID

Returns:

true iff the ACL has descendants that have an ACL too

Throws:

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

getDescendantsWithAcl

List getDescendantsWithAcl(String postFix)
                           throws AclPersistenceException

get a list of all IDs of the descendants of the ACL that have an ACL too

Parameters:

postFix - is appended to the ACL ID before the descendants are identified as all ACLs whose IDs start with this ID

Returns:

the IDs of the descendants

Throws:

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

isReadOnly

boolean isReadOnly()
                   throws AclPersistenceException

check whether the ACL is read only

Returns:

true iff the ACL is read only

Throws:

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

isUpToDate

boolean isUpToDate()
                   throws AclPersistenceException

check whether the ACL is up to date (check change level of persisted ACL) (used to invalidate ACL caches)

Returns:

true iff the persisted ACL has the same change level

Throws:

AclPersistenceException - Exception raised in failure situation

Access Rights

This class can be accessed from:

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