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

Interface PluginCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
AttributeCleanupPluginCfg, ChangeNumberControlPluginCfg, EntityTagPluginCfg, EntryUuidPluginCfg, FractionalLdifImportPluginCfg, GraphiteMonitorReporterPluginCfg, LastModPluginCfg, LdapAttributeDescriptionListPluginCfg, PasswordPolicyImportPluginCfg, ReferentialIntegrityPluginCfg, SambaPasswordPluginCfg, SevenBitCleanPluginCfg, UniqueAttributePluginCfg
public interface PluginCfg extends Configuration
A server-side interface for querying Plugin settings.

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 Details

    • configurationClass

      Class<? extends PluginCfg> configurationClass()
      Gets the configuration class associated with this Plugin.
      Specified by:
      configurationClass in interface Configuration
      Returns:
      Returns the configuration class associated with this Plugin.

    • addChangeListener

      void addChangeListener(ConfigurationChangeListener<PluginCfg> listener)
      Register to be notified when this Plugin is changed.
      Parameters:
      listener - The Plugin configuration change listener.

    • removeChangeListener

      void removeChangeListener(ConfigurationChangeListener<PluginCfg> listener)
      Deregister an existing Plugin configuration change listener.
      Parameters:
      listener - The Plugin configuration change listener.

    • isEnabled

      boolean isEnabled()
      Gets the "enabled" property.

      Indicates whether the plug-in is enabled for use.

      Returns:
      Returns the value of the "enabled" property.

    • isInvokeForInternalOperations

      boolean isInvokeForInternalOperations()
      Gets the "invoke-for-internal-operations" property.

      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.

      Default value: true

      Returns:
      Returns the value of the "invoke-for-internal-operations" property.

    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

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

      Returns:
      Returns the value of the "java-class" property.

    • getPluginType

      SortedSet<PluginCfgDefn.PluginType> getPluginType()
      Gets the "plugin-type" property.

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

      Returns:
      Returns an unmodifiable set containing the values of the "plugin-type" property.