org.opends.server.plugins

Class LDAPADListPlugin

java.lang.Object

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

org.opends.server.plugins.LDAPADListPlugin

All Implemented Interfaces:

ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg>

public final class LDAPADListPlugin
extends DirectoryServerPlugin<LDAPAttributeDescriptionListPluginCfg>
implements ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg>

This pre-parse plugin modifies the operation to allow an object class identifier to be specified in attributes lists, such as in Search requests, to request the return all attributes belonging to an object class as per the specification in RFC 4529. The "@" character is used to distinguish an object class identifier from an attribute descriptions.

Constructor Summary

Constructors

Constructor and Description
LDAPADListPlugin() Creates a new instance of this Directory Server plugin.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(LDAPAttributeDescriptionListPluginCfg configuration) Applies the configuration changes to this change listener.
PluginResult.PreParse	doPreParse(PreParseSearchOperation searchOperation) Performs any necessary processing that should be done before the Directory Server parses the elements of a search request.
void	finalizePlugin() Performs any necessary finalization for this plugin.
void	initializePlugin(Set<PluginType> pluginTypes, LDAPAttributeDescriptionListPluginCfg configuration) Performs any initialization necessary for this plugin.
boolean	isConfigurationAcceptable(PluginCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this plugin.
boolean	isConfigurationChangeAcceptable(LDAPAttributeDescriptionListPluginCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
static Set<String>	normalizedObjectClasses(Set<String> attributes) Filters the set of attributes provided in a search request or pre- / post- read controls according to RFC 4529.

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

doLDIFExport, doLDIFImport, doLDIFImportBegin, doLDIFImportEnd, doPostConnect, doPostDisconnect, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doShutdown, doStartup, getPluginEntryDN, getPluginTypes, 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

Constructor Detail

LDAPADListPlugin

public LDAPADListPlugin()

Creates a new instance of this Directory Server plugin. Every plugin must implement a default constructor (it is the only one that will be used to create plugins defined in the configuration), and every plugin constructor must call super() as its first element.

Method Detail

normalizedObjectClasses

public static Set<String> normalizedObjectClasses(Set<String> attributes)

Filters the set of attributes provided in a search request or pre- / post- read controls according to RFC 4529. More specifically, this method iterates through the requested attributes to see if any of them reference an object class, as indicated by a "@" prefix, and substitutes the object class reference with the attribute types contained in the object class, as well as any of the attribute types contained in any superior object classes.

Parameters:

attributes - The attribute list to be normalized.

Returns:

The normalized attribute list.

initializePlugin

public final void initializePlugin(Set<PluginType> pluginTypes,
                    LDAPAttributeDescriptionListPluginCfg configuration)
                            throws org.forgerock.opendj.config.server.ConfigException

Performs any initialization necessary for this plugin. This will be called as soon as the plugin has been loaded and before it is registered with the server.

Specified by:

initializePlugin in class DirectoryServerPlugin<LDAPAttributeDescriptionListPluginCfg>

Parameters:

pluginTypes - The set of plugin types that indicate the ways in which this plugin will be invoked.

configuration - The configuration for this plugin.

Throws:

org.forgerock.opendj.config.server.ConfigException - If the provided entry does not contain a valid configuration for this plugin.

finalizePlugin

public final void finalizePlugin()

Performs any necessary finalization for this plugin. This will be called just after the plugin has been deregistered with the server but before it has been unloaded.

Overrides:

finalizePlugin in class DirectoryServerPlugin<LDAPAttributeDescriptionListPluginCfg>

doPreParse

public final PluginResult.PreParse doPreParse(PreParseSearchOperation searchOperation)

Performs any necessary processing that should be done before the Directory Server parses the elements of a search request.

Overrides:

doPreParse in class DirectoryServerPlugin<LDAPAttributeDescriptionListPluginCfg>

Parameters:

searchOperation - The search operation that has been requested.

Returns:

Information about the result of the plugin processing.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(PluginCfg configuration,
                                List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided configuration is acceptable for this plugin. It should be possible to call this method on an uninitialized plugin instance in order to determine whether the plugin would be able to use the provided configuration.

Overrides:

isConfigurationAcceptable in class DirectoryServerPlugin<LDAPAttributeDescriptionListPluginCfg>

Parameters:

configuration - The plugin configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this plugin, or false if not.

isConfigurationChangeAcceptable

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

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg>

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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(LDAPAttributeDescriptionListPluginCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<LDAPAttributeDescriptionListPluginCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.