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

Class SevenBitCleanPluginCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<SevenBitCleanPluginCfgClient,SevenBitCleanPluginCfg>
org.forgerock.opendj.server.config.meta.SevenBitCleanPluginCfgDefn
public final class SevenBitCleanPluginCfgDefn extends ManagedObjectDefinition<SevenBitCleanPluginCfgClient,SevenBitCleanPluginCfg>
An interface for querying the Seven Bit Clean Plugin managed object definition meta information.

The Seven Bit Clean Plugin ensures that values for a specified set of attributes are 7-bit clean.

  • Method Details

    • getInstance

      public static SevenBitCleanPluginCfgDefn getInstance()
      Get the Seven Bit Clean Plugin configuration definition singleton.
      Returns:
      Returns the Seven Bit Clean Plugin configuration definition singleton.

    • createClientConfiguration

      public SevenBitCleanPluginCfgClient createClientConfiguration(ManagedObject<? extends SevenBitCleanPluginCfgClient> 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<SevenBitCleanPluginCfgClient,SevenBitCleanPluginCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

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

    • getServerConfigurationClass

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

    • getAttributeTypePropertyDefinition

      public AttributeTypePropertyDefinition getAttributeTypePropertyDefinition()
      Get the "attribute-type" property definition.

      Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean.

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

    • getBaseDnPropertyDefinition

      public DnPropertyDefinition getBaseDnPropertyDefinition()
      Get the "base-dn" property definition.

      Specifies the base DN below which the checking is performed.

      Any attempt to update a value for one of the configured attributes below this base DN must be 7-bit clean for the operation to be allowed.

      Returns:
      Returns the "base-dn" property 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.