org.opends.server.plugins

Class SambaPasswordPlugin

java.lang.Object

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

org.opends.server.plugins.SambaPasswordPlugin

All Implemented Interfaces:

ConfigurationChangeListener<SambaPasswordPluginCfg>

public final class SambaPasswordPlugin
extends DirectoryServerPlugin<SambaPasswordPluginCfg>
implements ConfigurationChangeListener<SambaPasswordPluginCfg>

The Samba password synchronization plugin implementation class.

This plugin synchronizes the userPassword attribute with the Samba password attribute(s) for all entries containing the specified Samba object class.

It handles clear-text userPassword modify operations and password modify extended operations. It does not cover the case of using pre-encoded password.

Constructor Summary

Constructors

Constructor and Description
SambaPasswordPlugin() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(SambaPasswordPluginCfg newConfig) Applies the configuration changes to this change listener.
PluginResult.PostOperation	doPostOperation(PostOperationExtendedOperation extendedOperation) Performs any necessary processing that should be done after the Directory Server has completed the core processing for an extended operation but before the response has been sent to the client.
PluginResult.PreOperation	doPreOperation(PreOperationModifyOperation modifyOperation) Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify operation.
void	initializePlugin(Set<PluginType> pluginTypes, SambaPasswordPluginCfg configuration) Performs any initialization necessary for this plugin.
boolean	isConfigurationAcceptable(SambaPasswordPluginCfg configuration, List<LocalizableMessage> unacceptableReasons) Verifies if the plugin configuration is acceptable.
boolean	isConfigurationChangeAcceptable(SambaPasswordPluginCfg newConfig, List<LocalizableMessage> messages) Indicates whether the proposed change to the configuration is acceptable to this change listener.

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, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doShutdown, doStartup, finalizePlugin, getPluginEntryDN, getPluginTypes, initializeInternal, invokeForInternalOperations, isConfigurationAcceptable, 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

SambaPasswordPlugin

public SambaPasswordPlugin()

Default constructor.

Method Detail

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(SambaPasswordPluginCfg newConfig)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<SambaPasswordPluginCfg>

Parameters:

newConfig - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

doPostOperation

public PluginResult.PostOperation doPostOperation(PostOperationExtendedOperation extendedOperation)

Performs any necessary processing that should be done after the Directory Server has completed the core processing for an extended operation but before the response has been sent to the client.

Overrides:

doPostOperation in class DirectoryServerPlugin<SambaPasswordPluginCfg>

Parameters:

extendedOperation - The extended operation for which processing has completed but no response has yet been sent.

Returns:

Information about the result of the plugin processing.

doPreOperation

public PluginResult.PreOperation doPreOperation(PreOperationModifyOperation modifyOperation)

Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify operation. This method is not called when processing synchronization operations.

Overrides:

doPreOperation in class DirectoryServerPlugin<SambaPasswordPluginCfg>

Parameters:

modifyOperation - The modify operation to be processed.

Returns:

Information about the result of the plugin processing.

initializePlugin

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

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<SambaPasswordPluginCfg>

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.

InitializationException - If a problem occurs while initializing the plugin that is not related to the server configuration.

isConfigurationAcceptable

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

Verifies if the plugin configuration is acceptable.

Parameters:

configuration - The plugin configuration.

unacceptableReasons - Reasons why the configuration is not acceptable.

Returns:

Returns true for the correct configuration and false for the incorrect one.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(SambaPasswordPluginCfg newConfig,
                                      List<LocalizableMessage> messages)

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<SambaPasswordPluginCfg>

Parameters:

newConfig - The new configuration containing the changes.

messages - 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.