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

Interface PluginCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
AttributeCleanupPluginCfgClient, ChangeNumberControlPluginCfgClient, EntityTagPluginCfgClient, EntryUuidPluginCfgClient, FractionalLdifImportPluginCfgClient, GraphiteMonitorReporterPluginCfgClient, LastModPluginCfgClient, LdapAttributeDescriptionListPluginCfgClient, PasswordPolicyImportPluginCfgClient, ReferentialIntegrityPluginCfgClient, SambaPasswordPluginCfgClient, SevenBitCleanPluginCfgClient, UniqueAttributePluginCfgClient
public interface PluginCfgClient extends ConfigurationClient
A client-side interface for reading and modifying 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

    • definition

      ManagedObjectDefinition<? extends PluginCfgClient,? extends PluginCfg> definition()
      Get the configuration definition associated with this Plugin.
      Specified by:
      definition in interface ConfigurationClient
      Returns:
      Returns the configuration definition associated with this Plugin.

    • isEnabled

      @MandatoryProperty ValueOrExpression<Boolean> isEnabled()
      Gets the "enabled" property.

      Indicates whether the plug-in is enabled for use.

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

    • setEnabled

      @MandatoryProperty void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "enabled" property.

      Indicates whether the plug-in is enabled for use.

      Parameters:
      value - The value of the "enabled" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isInvokeForInternalOperations

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

    • setInvokeForInternalOperations

      void setInvokeForInternalOperations(ValueOrExpression<Boolean> value) throws PropertyException
      Sets 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.

      Parameters:
      value - The value of the "invoke-for-internal-operations" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<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.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

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

      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getPluginType

      @MandatoryProperty SortedSet<ValueOrExpression<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 the values of the "plugin-type" property.

    • setPluginType

      @MandatoryProperty void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
      Sets 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.

      Parameters:
      values - The values of the "plugin-type" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.