com.sapportals.wcm.util.acl

Interface IOwner

All Known Subinterfaces:

IAcl, IAcl4Tx, IAclProvidingDBVersion, IAclRaw, IAclVersioned

public interface IOwner

An IOwner holds a list of principals that are the owners of an ACL.

Method Summary

boolean	addOwner(IPrincipal caller, IPrincipal principal) add a new owner to the list
boolean	addOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal caller, com.sapportals.portal.security.usermanagement.IUMPrincipal principal) Deprecated. As of NetWeaver 7.1, replaced by addOwner(com.sap.security.api.IPrincipal,com.sap.security.api.IPrincipal)
IUMPrincipalList	getOwners() Deprecated. As of NetWeaver 7.1, replaced by getOwnersUME()
List	getOwnersUME() get a list of the owners of the ACL
boolean	isAuthorized(IPrincipal principal) check whether a principal is an owner or a member of some owner group/role of the ACL
boolean	isAuthorized(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) Deprecated. As of NetWeaver 7.1, replaced by isAuthorized(com.sap.security.api.IPrincipal)
boolean	isOwner(IPrincipal principal) check whether a principal is part of the owner list of the ACL
boolean	isOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) Deprecated. As of NetWeaver 7.1, replaced by isOwner(com.sap.security.api.IPrincipal)
boolean	removeOwner(IPrincipal caller, IPrincipal owner) remove an owner from the list
boolean	removeOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal caller, com.sapportals.portal.security.usermanagement.IUMPrincipal owner) Deprecated. As of NetWeaver 7.1, replaced by removeOwner(com.sap.security.api.IPrincipal,com.sap.security.api.IPrincipal)

Method Detail

addOwner

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

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

add a new owner to the list

Parameters:

caller - the caller must be an owner of the ACL

principal - the new owner

Returns:

true iff the owner was added successfully

Throws:

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

NotAuthorizedException - the caller is not an owner

addOwner

boolean addOwner(IPrincipal caller,
                 IPrincipal principal)
                 throws AclPersistenceException,
                        NotAuthorizedException

add a new owner to the list

Parameters:

caller - the caller must be an owner of the ACL

principal - the new owner

Returns:

true iff the owner was added 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

removeOwner

boolean removeOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal caller,
                    com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
                    throws AclPersistenceException,
                           NotAuthorizedException,
                           LastOwnerException

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

remove an owner from the list

Parameters:

caller - the caller must be an owner of the ACL

owner - the owner

Returns:

true iff the owner was removed successfully

Throws:

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

NotAuthorizedException - the caller is not an owner

LastOwnerException - attempt to remove the last owner of the ACL (which is forbidden)

removeOwner

boolean removeOwner(IPrincipal caller,
                    IPrincipal owner)
                    throws AclPersistenceException,
                           NotAuthorizedException,
                           LastOwnerException

remove an owner from the list

Parameters:

caller - the caller must be an owner of the ACL

owner - the owner

Returns:

true iff the owner was removed successfully

Throws:

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

NotAuthorizedException - the caller is not an owner

LastOwnerException - attempt to remove the last owner of the ACL (which is forbidden)

Since:

NetWeaver 7.1

isOwner

boolean isOwner(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
                throws AclPersistenceException

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

check whether a principal is part of the owner list of the ACL

Parameters:

principal - the principal

Returns:

true iff the principal is part of the owner list of the ACL

Throws:

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

isOwner

boolean isOwner(IPrincipal principal)
                throws AclPersistenceException

check whether a principal is part of the owner list of the ACL

Parameters:

principal - the principal

Returns:

true iff the principal is part of the owner list of the ACL

Throws:

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

Since:

NetWeaver 7.1

isAuthorized

boolean isAuthorized(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
                     throws AclPersistenceException

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

check whether a principal is an owner or a member of some owner group/role of the ACL

Parameters:

principal - the principal

Returns:

true iff the principal an owner or a member of some owner group of the ACL

Throws:

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

isAuthorized

boolean isAuthorized(IPrincipal principal)
                     throws AclPersistenceException

check whether a principal is an owner or a member of some owner group/role of the ACL

Parameters:

principal - the principal

Returns:

true iff the principal an owner or a member of some owner group of the ACL

Throws:

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

Since:

NetWeaver 7.1

getOwners

IUMPrincipalList getOwners()
                           throws AclPersistenceException

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

get a list of the owners of the ACL

Returns:

the list of the owners of the ACL

Throws:

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

getOwnersUME

List getOwnersUME()
                  throws AclPersistenceException

get a list of the owners of the ACL

Returns:

a java.util.List containing objects of type com.sap.security.api.IPrincipal, which represent an owner of the ACL

Throws:

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

Since:

NetWeaver 7.1

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