Package org.forgerock.opendj.ldap

Class Entries.DiffOptions

java.lang.Object
org.forgerock.opendj.ldap.Entries.DiffOptions
Enclosing class:
Entries
public static final class Entries.DiffOptions extends Object
Options for controlling the behavior of the diffEntries method. DiffOptions specify which attributes are compared, how they are compared, and the type of modifications generated.
See Also:

  • Method Details

    • attributes

      public Entries.DiffOptions attributes(AttributeFilter attributeFilter)
      Specifies an attribute filter which will be used to determine which attributes will be compared. By default only user attributes will be compared.
      Parameters:
      attributeFilter - The filter which will be used to determine which attributes will be compared.
      Returns:
      A reference to this set of options.

    • attributes

      public Entries.DiffOptions attributes(String... attributeDescriptions)
      Specifies the list of attributes to be compared. By default only user attributes will be compared.
      Parameters:
      attributeDescriptions - The names of the attributes to be compared.
      Returns:
      A reference to this set of options.

    • useExactMatching

      public Entries.DiffOptions useExactMatching()
      Requests that attribute values should be compared byte for byte, rather than using their matching rules. This is useful when a client wishes to perform trivial changes to an attribute value which would otherwise be ignored by the matching rule, such as removing extra white space from an attribute, or capitalizing a user's name.
      Returns:
      A reference to this set of options.

    • alwaysReplaceAttributes

      public Entries.DiffOptions alwaysReplaceAttributes()
      Requests that all generated changes should use the REPLACE modification type, rather than a combination of DELETE and ADD.

      Note that the generated changes will not be reversible, nor will they be efficient for attributes containing many values (such as groups). Enabling this option may result in more efficient updates for single valued attributes and reduce the amount of replication meta-data that needs to be maintained..

      Returns:
      A reference to this set of options.

    • replaceSingleValuedAttributes

      public Entries.DiffOptions replaceSingleValuedAttributes()
      Requests that the generated changes should use the REPLACE modification type when the new attribute contains at most one attribute value. All other changes will use a combination of DELETE then ADD.

      Specifying this option will usually provide the best overall performance for single and multi-valued attribute updates, but the generated changes will probably not be reversible.

      Returns:
      A reference to this set of options.