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

Interface ReferentialIntegrityPluginCfgClient

  • All Superinterfaces:
    ConfigurationClient, PluginCfgClient
    public interface ReferentialIntegrityPluginCfgClient
extends PluginCfgClient
    A client-side interface for reading and modifying Referential Integrity Plugin settings.

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

    • Method Detail

      • 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 the values of the "attribute-type" property.

      • setAttributeType

        void setAttributeType​(Collection<org.forgerock.opendj.ldap.schema.AttributeType> values)
               throws PropertyException
        Sets 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).

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

      • 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 the values of the "base-dn" property.

      • setBaseDN

        void setBaseDN​(Collection<org.forgerock.opendj.ldap.DN> values)
        throws PropertyException
        Sets the "base-dn" property.

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

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

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

      • setCheckReferences

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

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

      • 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 the values of the "check-references-filter-criteria" property.

      • setCheckReferencesFilterCriteria

        void setCheckReferencesFilterCriteria​(Collection<String> values)
                               throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "check-references-filter-criteria" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

      • setCheckReferencesScopeCriteria

        void setCheckReferencesScopeCriteria​(ReferentialIntegrityPluginCfgDefn.CheckReferencesScopeCriteria value)
                              throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "check-references-scope-criteria" property.
        Throws:
        PropertyException - If the new value is invalid.

      • 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 PluginCfgClient
        Returns:
        Returns the value of the "java-class" property.

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

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

        Specified by:
        setJavaClass in interface PluginCfgClient
        Parameters:
        value - The value of the "java-class" property.
        Throws:
        PropertyException - If the new value is invalid.

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

      • setLogFile

        void setLogFile​(String value)
         throws PropertyException
        Sets 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".

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

      • 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 PluginCfgClient
        Returns:
        Returns 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.

      • setUpdateInterval

        void setUpdateInterval​(Long value)
                throws PropertyException
        Sets 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.

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