Package org.opends.server.plugins

Class LastModPlugin

java.lang.Object
org.opends.server.api.plugin.DirectoryServerPlugin<LastModPluginCfg>
org.opends.server.plugins.LastModPlugin
All Implemented Interfaces:
ConfigurationChangeListener<LastModPluginCfg>
public final class LastModPlugin extends DirectoryServerPlugin<LastModPluginCfg> implements ConfigurationChangeListener<LastModPluginCfg>
This class implements a Directory Server plugin that will add the creatorsName and createTimestamp attributes to an entry whenever it is added to the server, and will add the modifiersName and modifyTimestamp attributes whenever the entry is modified or renamed.

  • Constructor Details

    • LastModPlugin

      public LastModPlugin()
      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 Details

    • initializePlugin

      public void initializePlugin(Set<PluginType> pluginTypes, LastModPluginCfg configuration) throws ConfigException
      Description copied from class: DirectoryServerPlugin
      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<LastModPluginCfg>
      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:
      ConfigException - If the provided entry does not contain a valid configuration for this plugin.

    • finalizePlugin

      public void finalizePlugin()
      Description copied from class: DirectoryServerPlugin
      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<LastModPluginCfg>

    • doPreOperation

      public void doPreOperation(PreOperationAddOperation addOperation)
      Description copied from class: DirectoryServerPlugin
      Performs any necessary processing that should be done just before the Directory Server performs the core processing for an add operation. This method is not called when processing synchronization operations.
      Overrides:
      doPreOperation in class DirectoryServerPlugin<LastModPluginCfg>
      Parameters:
      addOperation - The add operation to be processed.

    • doPreOperation

      public void doPreOperation(PreOperationModifyOperation modifyOperation) throws LdapException
      Description copied from class: DirectoryServerPlugin
      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<LastModPluginCfg>
      Parameters:
      modifyOperation - The modify operation to be processed.
      Throws:
      LdapException - if this pre operation failed.

    • doPreOperation

      public void doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
      Description copied from class: DirectoryServerPlugin
      Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify DN operation. This method is not called when processing synchronization operations.
      Overrides:
      doPreOperation in class DirectoryServerPlugin<LastModPluginCfg>
      Parameters:
      modifyDNOperation - The modify DN operation to be processed.

    • isConfigurationAcceptable

      public boolean isConfigurationAcceptable(LastModPluginCfg cfg, List<LocalizableMessage> unacceptableReasons)
      Description copied from class: DirectoryServerPlugin
      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<LastModPluginCfg>
      Parameters:
      cfg - 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(LastModPluginCfg 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<LastModPluginCfg>
      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(LastModPluginCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<LastModPluginCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.