Package org.forgerock.opendj.server.config.meta

Class LastModPluginCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<LastModPluginCfgClient,LastModPluginCfg>
org.forgerock.opendj.server.config.meta.LastModPluginCfgDefn
public final class LastModPluginCfgDefn extends ManagedObjectDefinition<LastModPluginCfgClient,LastModPluginCfg>
An interface for querying the Last Mod Plugin managed object definition meta information.

The Last Mod Plugin is used to ensure that the creatorsName and createTimestamp attributes are included in an entry whenever it is added to the server and also to ensure that the modifiersName and modifyTimestamp attributes are updated whenever an entry is modified or renamed.

  • Method Details

    • getInstance

      public static LastModPluginCfgDefn getInstance()
      Get the Last Mod Plugin configuration definition singleton.
      Returns:
      Returns the Last Mod Plugin configuration definition singleton.

    • createClientConfiguration

      public LastModPluginCfgClient createClientConfiguration(ManagedObject<? extends LastModPluginCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<LastModPluginCfgClient,LastModPluginCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public LastModPluginCfg createServerConfiguration(ServerManagedObject<? extends LastModPluginCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<LastModPluginCfgClient,LastModPluginCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<LastModPluginCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<LastModPluginCfgClient,LastModPluginCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the plug-in is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getInvokeForInternalOperationsPropertyDefinition

      public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
      Get the "invoke-for-internal-operations" property definition.

      Indicates whether the plug-in should be invoked for internal operations.

      Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operations that can cause the same plug-in to be re-invoked.

      Returns:
      Returns the "invoke-for-internal-operations" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

      Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

      Returns:
      Returns the "java-class" property definition.

    • getPluginTypePropertyDefinition

      public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
      Get the "plugin-type" property definition.

      Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

      Returns:
      Returns the "plugin-type" property definition.