|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.core.GroupManager
public class GroupManager
This class provides a mechanism for interacting with all groups defined in
the Directory Server. It will handle all necessary processing at server
startup to identify and load all group implementations, as well as to find
all group instances within the server.
FIXME: At the present time, it assumes that all of the necessary
information about all of the groups defined in the server can be held in
memory. If it is determined that this approach is not workable in all cases,
then we will need an alternate strategy.
Constructor Summary | |
---|---|
GroupManager()
Creates a new instance of this group manager. |
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationAdd(GroupImplementationCfg configuration)
Adds a new configuration to this add listener. |
ConfigChangeResult |
applyConfigurationChange(GroupImplementationCfg configuration)
Applies the configuration changes to this change listener. |
ConfigChangeResult |
applyConfigurationDelete(GroupImplementationCfg configuration)
Deletes an existing configuration from this delete listener. |
void |
finalizeGroupManager()
Performs any cleanup work that may be needed when the server is shutting down. |
java.lang.Iterable<Group> |
getGroupImplementations()
Retrieves an Iterable object that may be used to cursor across the
group implementations defined in the server. |
Group |
getGroupInstance(DN entryDN)
Retrieves the group instance defined in the entry with the specified DN. |
java.lang.Iterable<Group> |
getGroupInstances()
Retrieves an Iterable object that may be used to cursor across the
group instances defined in the server. |
void |
handleAddOperation(PostResponseAddOperation addOperation,
Entry entry)
Performs any processing that may be required after an add operation. |
void |
handleDeleteOperation(PostResponseDeleteOperation deleteOperation,
Entry entry)
Performs any processing that may be required after a delete operation. |
void |
handleModifyDNOperation(PostResponseModifyDNOperation modifyDNOperation,
Entry oldEntry,
Entry newEntry)
Performs any processing that may be required after a modify DN operation. |
void |
handleModifyOperation(PostResponseModifyOperation modifyOperation,
Entry oldEntry,
Entry newEntry)
Performs any processing that may be required after a modify operation. |
boolean |
hasInstancesChanged(long token)
Compare the specified token against the current group manager token value. |
void |
initializeGroupImplementations()
Initializes all group implementations currently defined in the Directory Server configuration. |
boolean |
isConfigurationAddAcceptable(GroupImplementationCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed addition of a new configuration is acceptable to this add listener. |
boolean |
isConfigurationChangeAcceptable(GroupImplementationCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
boolean |
isConfigurationDeleteAcceptable(GroupImplementationCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener. |
void |
performBackendFinalizationProcessing(Backend backend)
Performs any processing that may be required whenever a backend is finalized. |
void |
performBackendInitializationProcessing(Backend backend)
Performs any processing that may be required whenever a backend is initialized for use in the Directory Server. |
long |
refreshToken()
Return the current refresh token value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GroupManager()
Method Detail |
---|
public void initializeGroupImplementations() throws ConfigException, InitializationException
ConfigException
- If a configuration problem causes the group
implementation initialization process to fail.
InitializationException
- If a problem occurs while initializing
the group implementations that is not
related to the server configuration.public boolean isConfigurationAddAcceptable(GroupImplementationCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAddAcceptable
in interface ConfigurationAddListener<GroupImplementationCfg>
configuration
- The configuration that will be added.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed addition is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationAdd(GroupImplementationCfg configuration)
applyConfigurationAdd
in interface ConfigurationAddListener<GroupImplementationCfg>
configuration
- The configuration that will be added.
public boolean isConfigurationDeleteAcceptable(GroupImplementationCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationDeleteAcceptable
in interface ConfigurationDeleteListener<GroupImplementationCfg>
configuration
- The configuration that will be deleted.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed deletion is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationDelete(GroupImplementationCfg configuration)
applyConfigurationDelete
in interface ConfigurationDeleteListener<GroupImplementationCfg>
configuration
- The existing configuration that will be deleted.
public boolean isConfigurationChangeAcceptable(GroupImplementationCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<GroupImplementationCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(GroupImplementationCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<GroupImplementationCfg>
configuration
- The new configuration containing the changes.
public void finalizeGroupManager()
public java.lang.Iterable<Group> getGroupImplementations()
Iterable
object that may be used to cursor across the
group implementations defined in the server.
Iterable
object that may be used to cursor across the
group implementations defined in the server.public java.lang.Iterable<Group> getGroupInstances()
Iterable
object that may be used to cursor across the
group instances defined in the server.
Iterable
object that may be used to cursor across the
group instances defined in the server.public Group getGroupInstance(DN entryDN)
entryDN
- The DN of the entry containing the definition of the group
instance to retrieve.
null
if no such group is currently defined.public void performBackendInitializationProcessing(Backend backend)
performBackendInitializationProcessing
in interface BackendInitializationListener
backend
- The backend that has been initialized and is
about to be put into service.public void performBackendFinalizationProcessing(Backend backend)
performBackendFinalizationProcessing
in interface BackendInitializationListener
backend
- The backend that has been taken out of service
and is about to be finalized.public void handleAddOperation(PostResponseAddOperation addOperation, Entry entry)
handleAddOperation
in interface ChangeNotificationListener
addOperation
- The add operation that was performed in the
server.entry
- The entry that was added to the server.public void handleDeleteOperation(PostResponseDeleteOperation deleteOperation, Entry entry)
handleDeleteOperation
in interface ChangeNotificationListener
deleteOperation
- The delete operation that was performed
in the server.entry
- The entry that was removed from the
server.public void handleModifyOperation(PostResponseModifyOperation modifyOperation, Entry oldEntry, Entry newEntry)
handleModifyOperation
in interface ChangeNotificationListener
modifyOperation
- The modify operation that was performed
in the server.oldEntry
- The entry before it was updated.newEntry
- The entry after it was updated.public void handleModifyDNOperation(PostResponseModifyDNOperation modifyDNOperation, Entry oldEntry, Entry newEntry)
handleModifyDNOperation
in interface ChangeNotificationListener
modifyDNOperation
- The modify DN operation that was
performed in the server.oldEntry
- The entry before it was updated.newEntry
- The entry after it was updated.public boolean hasInstancesChanged(long token)
token
- The current token that the group class holds.
true
if the group class should reload its nested groups,
or false
if it shouldn't.public long refreshToken()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |