Class ReferentialIntegrityPluginCfgDefn

    • Method Detail

      • getInstance

        public static ReferentialIntegrityPluginCfgDefn getInstance()
        Get the Referential Integrity Plugin configuration definition singleton.
        Returns:
        Returns the Referential Integrity Plugin configuration definition singleton.
      • getAttributeTypePropertyDefinition

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

        Specifies the attribute types for which referential integrity is to be maintained.

        At least one attribute type must be specified, and the syntax of any attributes must be either a distinguished name (1.3.6.1.4.1.1466.115.121.1.12) or name and optional UID (1.3.6.1.4.1.1466.115.121.1.34).

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

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

        Specifies the base DN that limits the scope within which referential integrity is maintained.

        Returns:
        Returns the "base-dn" property definition.
      • getCheckReferencesPropertyDefinition

        public BooleanPropertyDefinition getCheckReferencesPropertyDefinition()
        Get the "check-references" property definition.

        Specifies whether reference attributes must refer to existing entries.

        When this property is set to true, this plugin will ensure that any new references added as part of an add or modify operation point to existing entries, and that the referenced entries match the filter criteria for the referencing attribute, if specified.

        Returns:
        Returns the "check-references" property definition.
      • getCheckReferencesFilterCriteriaPropertyDefinition

        public StringPropertyDefinition getCheckReferencesFilterCriteriaPropertyDefinition()
        Get the "check-references-filter-criteria" property definition.

        Specifies additional filter criteria which will be enforced when checking references.

        If a reference attribute has filter criteria defined then this plugin will ensure that any new references added as part of an add or modify operation refer to an existing entry which matches the specified filter.

        Returns:
        Returns the "check-references-filter-criteria" property definition.
      • getCheckReferencesScopeCriteriaPropertyDefinition

        public EnumPropertyDefinition<ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria> getCheckReferencesScopeCriteriaPropertyDefinition()
        Get the "check-references-scope-criteria" property definition.

        Specifies whether referenced entries must reside within the same naming context as the entry containing the reference.

        The reference scope will only be enforced when reference checking is enabled.

        Returns:
        Returns the "check-references-scope-criteria" 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.
      • getLogFilePropertyDefinition

        public StringPropertyDefinition getLogFilePropertyDefinition()
        Get the "log-file" property definition.

        Specifies the log file location where the update records are written when the plug-in is in background-mode processing.

        The default location is the logs directory of the server instance, using the file name "referint".

        Returns:
        Returns the "log-file" 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.
      • getUpdateIntervalPropertyDefinition

        public DurationPropertyDefinition getUpdateIntervalPropertyDefinition()
        Get the "update-interval" property definition.

        Specifies the interval in seconds when referential integrity updates are made.

        If this value is 0, then the updates are made synchronously in the foreground.

        Returns:
        Returns the "update-interval" property definition.