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

Interface ReferentialIntegrityPluginCfg

  • All Superinterfaces:
    Configuration, PluginCfg
    public interface ReferentialIntegrityPluginCfg
extends PluginCfg
    A server-side interface for querying Referential Integrity Plugin settings.

    The Referential Integrity Plugin maintains referential integrity for DN valued attributes.

    • Method Detail

      • addReferentialIntegrityChangeListener

        void addReferentialIntegrityChangeListener​(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)
        Register to be notified when this Referential Integrity Plugin is changed.
        Parameters:
        listener - The Referential Integrity Plugin configuration change listener.

      • removeReferentialIntegrityChangeListener

        void removeReferentialIntegrityChangeListener​(ConfigurationChangeListener<ReferentialIntegrityPluginCfg> listener)
        Deregister an existing Referential Integrity Plugin configuration change listener.
        Parameters:
        listener - The Referential Integrity Plugin configuration change listener.

      • getAttributeType

        SortedSet<org.forgerock.opendj.ldap.schema.AttributeType> getAttributeType()
        Gets the "attribute-type" property.

        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 an unmodifiable set containing the values of the "attribute-type" property.

      • getBaseDN

        SortedSet<org.forgerock.opendj.ldap.DN> getBaseDN()
        Gets the "base-dn" property.

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

        Returns:
        Returns an unmodifiable set containing the values of the "base-dn" property.

      • isCheckReferences

        boolean isCheckReferences()
        Gets the "check-references" property.

        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 value of the "check-references" property.

      • getCheckReferencesFilterCriteria

        SortedSet<String> getCheckReferencesFilterCriteria()
        Gets the "check-references-filter-criteria" property.

        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 an unmodifiable set containing the values of the "check-references-filter-criteria" property.

      • getCheckReferencesScopeCriteria

        ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria getCheckReferencesScopeCriteria()
        Gets the "check-references-scope-criteria" property.

        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 value of the "check-references-scope-criteria" property.

      • getJavaClass

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

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

        Specified by:
        getJavaClass in interface PluginCfg
        Returns:
        Returns the value of the "java-class" property.

      • getLogFile

        String getLogFile()
        Gets the "log-file" property.

        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 value of the "log-file" 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.

        Specified by:
        getPluginType in interface PluginCfg
        Returns:
        Returns an unmodifiable set containing the values of the "plugin-type" property.

      • getUpdateInterval

        long getUpdateInterval()
        Gets the "update-interval" property.

        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 value of the "update-interval" property.