oracle.dss.persistence.security.common
Interface AclObject

All Superinterfaces:

Acl, oracle.jbo.ComponentObject, oracle.jbo.Properties

public interface AclObject

extends Acl, oracle.jbo.ComponentObject

Methods required for an access control list for a PersistenceManager. You use the methods in this interface to find information about the users of the associated PersistenceManager and information about the privileges that those users have. You also use the methods in this interface to set privileges for users. In order to manipulate privileges in the access control list, you must have full control privileges to the folder.

To get access to the AclObject for a PersistenceManager, call the getAcl method of the PersistenceManager. Then downcast the returned Acl to an AclObject.

See Also:

User, Privilege, Acl, AclEntry, AclObject, PersistenceManager, PersistenceManagerImpl.getAcl()

Method Summary

boolean	checkPrivilege(Privilege privilege) Indicates whether the caller has the specified Privilege.
boolean	checkUserPrivilege(User user, Privilege privilege) Indicates whether a user has the specified Privilege.
Privilege	getUserPrivilege(User user) Retrieves the highest privilege that a user has, either as an individual user or as a member of a group.

Methods inherited from interface oracle.dss.bicontext.Acl

addEntries, entries, getPrivilege, removeEntries

Methods inherited from interface oracle.jbo.ComponentObject

getDefFullName, getDefName, getFullName, getName, remove

Methods inherited from interface oracle.jbo.Properties

getProperties, getProperty, refreshProperty

Method Detail

checkPrivilege

public boolean checkPrivilege(Privilege privilege)
                       throws javax.naming.NamingException

Indicates whether the caller has the specified Privilege. The specified Privilege can be equivalent to the Privilege of this AclObject, or it can be implied by the Privilege of this AclObject. For example, if you pass a Read Privilege to this method, and you have Write Privilege, then this method returns true.

You might call this method to make sure that you have full control before you call the addEntries method, for example.

Parameters:

privilege - The Privilege that identifies the access rights that you want to find out about.

Returns:

true if the caller has privilege rights, false if the caller does not.

Throws:

BINoPermissonException - If the caller does not have sufficient privilege to check privileges.

BINamingException - If any other naming exception occurs.

checkUserPrivilege

public boolean checkUserPrivilege(User user,
Privilege privilege)
                           throws javax.naming.NamingException

Indicates whether a user has the specified Privilege. This method indicates whether the specified user has the access rights that the specified Privilege identifies. The specified Privilege can be equivalent to the Privilege of this AclObject, or it can be implied by the Privilege of this AclObject. For example, if you pass a Read Privilege to this method, and the user has Write Privilege, then this method returns true.

Parameters:

user - The User whose privilege you want to know about.

privilege - The Privilege that identifies the access rights that you want to find out about.

Returns:

true if user has privilege rights, false if the User does not, or if the caller does not have full control privileges to the folder.

getUserPrivilege

public Privilege getUserPrivilege(User user)
                           throws javax.naming.NamingException

Retrieves the highest privilege that a user has, either as an individual user or as a member of a group.

Parameters:

user - The user whose privilege you want to know.

Returns:

The highest privilege of the user, either as a user or as a member of a group.

Throws:

javax.naming.NamingException - If the caller does not have the privilege to get the privilege of another user.