Class PluginCfgDefn


  • public final class PluginCfgDefn
    extends ManagedObjectDefinition<PluginCfgClient,​PluginCfg>
    An interface for querying the Plugin managed object definition meta information.

    Plugins provide a mechanism for executing custom code at specified points in operation processing and in the course of other events like connection establishment and termination, server startup and shutdown, and LDIF import and export.

    • Method Detail

      • getInstance

        public static PluginCfgDefn getInstance()
        Get the Plugin configuration definition singleton.
        Returns:
        Returns the Plugin configuration definition singleton.
      • 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.