org.opends.server.core

Class GroupManager

java.lang.Object

org.opends.server.api.plugin.DirectoryServerPlugin<PluginCfg>

org.opends.server.api.plugin.InternalDirectoryServerPlugin

org.opends.server.core.GroupManager

All Implemented Interfaces:

ConfigurationAddListener<GroupImplementationCfg>, ConfigurationChangeListener<GroupImplementationCfg>, ConfigurationDeleteListener<GroupImplementationCfg>, LocalBackendInitializationListener

public class GroupManager
extends InternalDirectoryServerPlugin
implements ConfigurationChangeListener<GroupImplementationCfg>, ConfigurationAddListener<GroupImplementationCfg>, ConfigurationDeleteListener<GroupImplementationCfg>, LocalBackendInitializationListener

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

Constructors

Constructor and Description
GroupManager(ServerContext serverContext) Creates a new instance of this group manager.

Method Summary

Modifier and Type	Method and Description
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.
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 modifyOp) 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.
<R,E extends Exception> R	doWithSharedLock(Function<Void,R,E> function) Executes the provided function after acquiring this group manager's read lock.
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(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(GroupImplementationCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed addition of a new configuration is acceptable to this add listener.
boolean	isConfigurationChangeAcceptable(GroupImplementationCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
boolean	isConfigurationDeleteAcceptable(GroupImplementationCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.
void	performBackendPostFinalizationProcessing(LocalBackend<?> backend) Performs any processing that may be required whenever a backend is finalized.
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.

Methods inherited from class org.opends.server.api.plugin.InternalDirectoryServerPlugin

initializePlugin, isConfigurationAcceptable

Methods inherited from class org.opends.server.api.plugin.DirectoryServerPlugin

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opends.server.api.LocalBackendInitializationListener

performBackendPostInitializationProcessing, performBackendPreFinalizationProcessing

Constructor Detail

GroupManager

public GroupManager(ServerContext serverContext)

Creates a new instance of this group manager.

Parameters:

serverContext - The server context.

Method Detail

initializeGroupImplementations

public void initializeGroupImplementations()
                                    throws ConfigException

Initializes all group implementations currently defined in the Directory Server configuration. This should only be called at Directory Server startup.

Throws:

ConfigException - If a configuration problem causes the group implementation initialization process to fail.

applyConfigurationAdd

public ConfigChangeResult applyConfigurationAdd(GroupImplementationCfg configuration)

Description copied from interface: ConfigurationAddListener

Adds a new configuration to this add listener.

Specified by:

applyConfigurationAdd in interface ConfigurationAddListener<GroupImplementationCfg>

Parameters:

configuration - The configuration that will be added.

Returns:

Returns information about the result of adding the configuration.

isConfigurationDeleteAcceptable

public boolean isConfigurationDeleteAcceptable(GroupImplementationCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationDeleteListener

Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener.

Specified by:

isConfigurationDeleteAcceptable in interface ConfigurationDeleteListener<GroupImplementationCfg>

Parameters:

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.

Returns:

Returns true if the proposed deletion is acceptable, or false if it is not.

applyConfigurationDelete

public ConfigChangeResult applyConfigurationDelete(GroupImplementationCfg configuration)

Description copied from interface: ConfigurationDeleteListener

Deletes an existing configuration from this delete listener.

Specified by:

applyConfigurationDelete in interface ConfigurationDeleteListener<GroupImplementationCfg>

Parameters:

configuration - The existing configuration that will be deleted.

Returns:

Returns information about the result of deleting the configuration.

isConfigurationAddAcceptable

public boolean isConfigurationAddAcceptable(GroupImplementationCfg configuration,
                                            List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationAddListener

Indicates whether the proposed addition of a new configuration is acceptable to this add listener.

Specified by:

isConfigurationAddAcceptable in interface ConfigurationAddListener<GroupImplementationCfg>

Parameters:

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.

Returns:

Returns true if the proposed addition is acceptable, or false if it is not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(GroupImplementationCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<GroupImplementationCfg>

Parameters:

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.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(GroupImplementationCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<GroupImplementationCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

finalizeGroupManager

public void finalizeGroupManager()

Performs any cleanup work that may be needed when the server is shutting down.

getGroupImplementations

public Iterable<Group<?>> getGroupImplementations()

Retrieves an Iterable object that may be used to cursor across the group implementations defined in the server.

Returns:

An Iterable object that may be used to cursor across the group implementations defined in the server.

getGroupInstances

public Iterable<Group<?>> getGroupInstances()

Retrieves an Iterable object that may be used to cursor across the group instances defined in the server.

Returns:

An Iterable object that may be used to cursor across the group instances defined in the server.

getGroupInstance

public Group<?> getGroupInstance(Dn entryDN)

Retrieves the group instance defined in the entry with the specified DN.

Parameters:

entryDN - The DN of the entry containing the definition of the group instance to retrieve.

Returns:

The group instance defined in the entry with the specified DN, or null if no such group is currently defined.

performBackendPreInitializationProcessing

public void performBackendPreInitializationProcessing(LocalBackend<?> backend)

Performs any processing that may be required whenever a backend is initialized for use in the Directory Server. This method will be invoked after the backend has been initialized but before it has been put into service.

In this case, the server will search the backend to find all group instances that it may contain and register them with this group manager.

Specified by:

performBackendPreInitializationProcessing in interface LocalBackendInitializationListener

Parameters:

backend - The backend that has been initialized and is about to be put into service.

performBackendPostFinalizationProcessing

public void performBackendPostFinalizationProcessing(LocalBackend<?> backend)

Performs any processing that may be required whenever a backend is finalized. This method will be invoked after the backend has been taken out of service but before it has been finalized.

In this case, the server will de-register all group instances associated with entries in the provided backend.

Specified by:

performBackendPostFinalizationProcessing in interface LocalBackendInitializationListener

Parameters:

backend - The backend that has been taken out of service and is about to be finalized.

doPostOperation

public PluginResult.PostOperation doPostOperation(PostOperationAddOperation addOperation)

Description copied from class: DirectoryServerPlugin

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.

Overrides:

doPostOperation in class DirectoryServerPlugin<PluginCfg>

Parameters:

addOperation - The add operation for which processing has completed but no response has yet been sent.

Returns:

Information about the result of the plugin processing.

doPostOperation

public PluginResult.PostOperation doPostOperation(PostOperationDeleteOperation deleteOperation)

Description copied from class: DirectoryServerPlugin

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.

Overrides:

doPostOperation in class DirectoryServerPlugin<PluginCfg>

Parameters:

deleteOperation - The delete operation for which processing has completed but no response has yet been sent.

Returns:

Information about the result of the plugin processing.

doPostOperation

public PluginResult.PostOperation doPostOperation(PostOperationModifyOperation modifyOp)

Description copied from class: DirectoryServerPlugin

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.

Overrides:

doPostOperation in class DirectoryServerPlugin<PluginCfg>

Parameters:

modifyOp - The modify operation for which processing has completed but no response has yet been sent.

Returns:

Information about the result of the plugin processing.

doPostOperation

public PluginResult.PostOperation doPostOperation(PostOperationModifyDNOperation modifyDNOperation)

Description copied from class: DirectoryServerPlugin

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.

Overrides:

doPostOperation in class DirectoryServerPlugin<PluginCfg>

Parameters:

modifyDNOperation - The modify DN operation for which processing has completed but no response has yet been sent.

Returns:

Information about the result of the plugin processing.

doPostSynchronization

public void doPostSynchronization(PostSynchronizationAddOperation addOperation)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed processing for an add operation performed via synchronization.

Overrides:

doPostSynchronization in class DirectoryServerPlugin<PluginCfg>

Parameters:

addOperation - The synchronized add operation for which processing has been completed.

doPostSynchronization

public void doPostSynchronization(PostSynchronizationDeleteOperation deleteOperation)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed processing for a delete operation performed via synchronization.

Overrides:

doPostSynchronization in class DirectoryServerPlugin<PluginCfg>

Parameters:

deleteOperation - The synchronized delete operation for which processing has been completed.

doPostSynchronization

public void doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed processing for a modify operation performed via synchronization.

Overrides:

doPostSynchronization in class DirectoryServerPlugin<PluginCfg>

Parameters:

modifyOperation - The synchronized modify operation for which processing has been completed.

doPostSynchronization

public void doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done after the Directory Server has completed processing for a modify DN operation performed via synchronization.

Overrides:

doPostSynchronization in class DirectoryServerPlugin<PluginCfg>

Parameters:

modifyDNOperation - The synchronized modify DN operation for which processing has been completed.

doWithSharedLock

public <R,E extends Exception> R doWithSharedLock(Function<Void,R,E> function)
                                           throws E extends Exception

Executes the provided function after acquiring this group manager's read lock.

Type Parameters:

R - The return type of the function

E - the exception that may be thrown by the function

Parameters:

function - the function to execute

Returns:

The value returned by the provided function.

Throws:

E - the exception thrown by the function

E extends Exception

hasInstancesChanged

public boolean hasInstancesChanged(long token)

Compare the specified token against the current group manager token value. Can be used to reload cached group instances if there has been a group instance change.

Parameters:

token - The current token that the group class holds.

Returns:

true if the group class should reload its nested groups, or false if it shouldn't.

refreshToken

public long refreshToken()

Return the current refresh token value. Can be used to reload cached group instances if there has been a group instance change.

Returns:

The current token value.