Class SevenBitCleanPluginCfgDefn

    • Method Detail

      • getInstance

        public static SevenBitCleanPluginCfgDefn getInstance()
        Get the Seven Bit Clean Plugin configuration definition singleton.
        Returns:
        Returns the Seven Bit Clean Plugin configuration definition singleton.
      • 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 operatons 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.