public class GroupManager extends InternalDirectoryServerPlugin implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>, org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>, org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>, LocalBackendInitializationListener
Constructor and Description |
---|
GroupManager(ServerContext serverContext)
Creates a new instance of this group manager.
|
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationAdd(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration) |
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration) |
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationDelete(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration) |
PluginResult.PostOperation |
doPostOperation(PostOperationAddOperation addOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core
processing for an add operation but before the response has been sent to the client.
|
PluginResult.PostOperation |
doPostOperation(PostOperationDeleteOperation deleteOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core
processing for a delete operation but before the response has been sent to the client.
|
PluginResult.PostOperation |
doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core
processing for a modify DN operation but before the response has been sent to the client.
|
PluginResult.PostOperation |
doPostOperation(PostOperationModifyOperation modifyOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core
processing for a modify operation but before the response has been sent to the client.
|
void |
doPostSynchronization(PostSynchronizationAddOperation addOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for an
add operation performed via synchronization.
|
void |
doPostSynchronization(PostSynchronizationDeleteOperation deleteOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a
delete operation performed via synchronization.
|
void |
doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a
modify DN operation performed via synchronization.
|
void |
doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a
modify operation performed via synchronization.
|
void |
finalizeGroupManager()
Performs any cleanup work that may be needed when the server is shutting down.
|
Iterable<Group<?>> |
getGroupImplementations()
Retrieves an
Iterable object that may be used to cursor across the group implementations defined in the
server. |
Group<?> |
getGroupInstance(org.forgerock.opendj.ldap.Dn entryDN)
Retrieves the group instance defined in the entry with the specified DN.
|
Iterable<Group<?>> |
getGroupInstances()
Retrieves an
Iterable object that may be used to cursor across the group instances defined in the server. |
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(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration,
List<LocalizableMessage> unacceptableReasons) |
boolean |
isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration,
List<LocalizableMessage> unacceptableReasons) |
boolean |
isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration,
List<LocalizableMessage> unacceptableReasons) |
void |
performBackendPostFinalizationProcessing(LocalBackend<?> backend)
Performs any processing that may be required whenever a backend is finalized.
|
void |
performBackendPostInitializationProcessing(LocalBackend<?> backend)
Performs any processing that may be required after the Initialisation cycle has been completed, that is all
listeners have received the initialisation event, and the backend has been put into service,.
|
void |
performBackendPreFinalizationProcessing(LocalBackend<?> backend)
Performs any processing that may be required before starting the finalisation cycle, that is invoked before any
listener receive the Finalization event.
|
void |
performBackendPreInitializationProcessing(LocalBackend<?> 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.
|
initializePlugin, isConfigurationAcceptable
doLDIFExport, doLDIFImport, doLDIFImportBegin, doLDIFImportEnd, doPostConnect, doPostDisconnect, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doShutdown, doStartup, finalizePlugin, getPluginEntryDN, getPluginTypes, getServerContext, initializeInternal, invokeForInternalOperations, processIntermediateResponse, processSearchEntry, processSearchReference, processSubordinateDelete, processSubordinateModifyDN, setInvokeForInternalOperations
public GroupManager(ServerContext serverContext) throws DirectoryException
serverContext
- The server context.DirectoryException
- If a problem occurs while creating an instance of the group manager.public void initializeGroupImplementations() throws org.forgerock.opendj.config.server.ConfigException, InitializationException
org.forgerock.opendj.config.server.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(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationAddAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationAdd(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration)
applyConfigurationAdd
in interface org.forgerock.opendj.config.server.ConfigurationAddListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>
public boolean isConfigurationDeleteAcceptable(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationDeleteAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationDelete(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration)
applyConfigurationDelete
in interface org.forgerock.opendj.config.server.ConfigurationDeleteListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>
public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.GroupImplementationCfg configuration)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.GroupImplementationCfg>
public void finalizeGroupManager()
public 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 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(org.forgerock.opendj.ldap.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 performBackendPreInitializationProcessing(LocalBackend<?> backend)
performBackendPreInitializationProcessing
in interface LocalBackendInitializationListener
backend
- The backend that has been initialized and is about to be put into service.public void performBackendPostFinalizationProcessing(LocalBackend<?> backend)
performBackendPostFinalizationProcessing
in interface LocalBackendInitializationListener
backend
- The backend that has been taken out of service and is about to be finalized.public void performBackendPostInitializationProcessing(LocalBackend<?> backend)
LocalBackendInitializationListener
performBackendPostInitializationProcessing
in interface LocalBackendInitializationListener
backend
- The backend that has been initialized and has been put into service.public void performBackendPreFinalizationProcessing(LocalBackend<?> backend)
LocalBackendInitializationListener
performBackendPreFinalizationProcessing
in interface LocalBackendInitializationListener
backend
- The backend that is about to be finalized.public PluginResult.PostOperation doPostOperation(PostOperationAddOperation addOperation)
DirectoryServerPlugin
doPostOperation
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
addOperation
- The add operation for which processing has completed but no response has yet been sent.public PluginResult.PostOperation doPostOperation(PostOperationDeleteOperation deleteOperation)
DirectoryServerPlugin
doPostOperation
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
deleteOperation
- The delete operation for which processing has completed but no response has yet been sent.public PluginResult.PostOperation doPostOperation(PostOperationModifyOperation modifyOperation)
DirectoryServerPlugin
doPostOperation
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
modifyOperation
- The modify operation for which processing has completed but no response has yet been sent.public PluginResult.PostOperation doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
DirectoryServerPlugin
doPostOperation
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
modifyDNOperation
- The modify DN operation for which processing has completed but no response has yet been sent.public void doPostSynchronization(PostSynchronizationAddOperation addOperation)
DirectoryServerPlugin
doPostSynchronization
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
addOperation
- The synchronized add operation for which processing has been completed.public void doPostSynchronization(PostSynchronizationDeleteOperation deleteOperation)
DirectoryServerPlugin
doPostSynchronization
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
deleteOperation
- The synchronized delete operation for which processing has been completed.public void doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)
DirectoryServerPlugin
doPostSynchronization
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
modifyOperation
- The synchronized modify operation for which processing has been completed.public void doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)
DirectoryServerPlugin
doPostSynchronization
in class DirectoryServerPlugin<org.forgerock.opendj.server.config.server.PluginCfg>
modifyDNOperation
- The synchronized modify DN operation for which processing has been completed.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()
Copyright © 2010–2017 ForgeRock AS. All rights reserved.