public interface Managers
Manager.ADMINISTER
privileges can invoke in order to manage other Managers. These operations always occur in the context of the object that implements this interface.
For example, calling the addManager
method on an Enterprise
instance will add an existing Manager to the set of Managers that can control that Enterprise
. Within that Enterprise
, the newly added manager will be able to perform the types of operations defined by his set of privileges (see the Manager
documentation for an explanation of privileges). Outside that Enterprise
, the newly added manager will not be able to perform any operations.
Modifier and Type | Method and Description |
---|---|
Manager |
addManager(java.lang.String managerId,
java.lang.String password,
java.lang.String[] privileges)
Adds a new Manager to the set of Managers that control the object implementing this Managers interface.
|
void |
delManager(java.lang.String managerId)
Remove a manager from the set of Managers that control the object implementing this Managers interface.
|
Manager |
getManager(java.lang.String managerId)
Returns the Manager with the specified login ID.
|
PersistentIterator |
getManagers()
Returns an iterator over the set of Managers that control the object implementing this Managers interface.
|
Manager addManager(java.lang.String managerId, java.lang.String password, java.lang.String[] privileges) throws CommunicationException, DuplicateNameException, UnknownIdentityException, AccessControlException
Manager.setPrivileges(java.lang.String[])
for a definition of the privileges
parameter. The Manager is added to relevant group entries in the directory. A group entry is an LDAP entry that contains all the Managers with a specific permission and control over a specific
Enterprise, Site, or Access.managerId
- The login ID of the manager. This is the part of the principal (i.e. the optionally
qualified login ID) that precedes the "@" character.password
- The password of the manager.privileges
- The privileges of the manage.CommunicationException
- Thrown if there is a problem accessing the directory.UnknownIdentityException
- Thrown if a group entry for one of the privilges of the new manager is missing from the directory.DuplicateNameException
- Thrown if there is already a manager with the given name.AccessControlException
- Thrown if the currently bound manager (i.e. the manager
that is invoking this method) does not have Manager.ADMINISTER
privileges.void delManager(java.lang.String managerId) throws CommunicationException, UnknownIdentityException, AccessControlException
managerId
- The login ID of the manager. This is the part of the principal (i.e. the optionally
qualified login ID) that precedes the "@" character.CommunicationException
- Thrown if there is a problem accessing the directory.UnknownIdentityException
- Thrown if there is no manager with the given name.AccessControlException
- Thrown if the currently bound manager (i.e. the manager
that is invoking this method) does not have Manager.ADMINISTER
privileges, or if the currently bound manager
tries to delete himselfManager getManager(java.lang.String managerId) throws CommunicationException, UnknownIdentityException, AccessControlException
managerId
- The login ID of the manager. This is the part of the principal (i.e. the optionally
qualified login ID) that precedes the "@" character.CommunicationException
- Thrown if there is a problem accessing the directory.UnknownIdentityException
- Thrown if there is no manager with the given name.AccessControlException
- Thrown if the currently bound manager (i.e. the manager
that is invoking this method) does not have Manager.ADMINISTER
privileges.PersistentIterator getManagers() throws AccessControlException, CommunicationException
CommunicationException
- Thrown if there is a problem accessing the directory.AccessControlException
- Thrown if the currently bound manager (i.e. the manager
that is invoking this method) does not have Manager.ADMINISTER
privileges.