Package com.unboundid.ldif

Class LDIFModifyDNChangeRecord

java.lang.Object
com.unboundid.ldif.LDIFChangeRecord
com.unboundid.ldif.LDIFModifyDNChangeRecord
All Implemented Interfaces:
LDIFRecord, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFModifyDNChangeRecord extends LDIFChangeRecord
This class defines an LDIF modify DN change record, which can be used to represent an LDAP modify DN request. See the documentation for the LDIFChangeRecord class for an example demonstrating the process for interacting with LDIF change records.
See Also:

  • Constructor Details

    • LDIFModifyDNChangeRecord

      public LDIFModifyDNChangeRecord(@NotNull String dn, @NotNull String newRDN, boolean deleteOldRDN, @Nullable String newSuperiorDN)
      Creates a new LDIF modify DN change record with the provided information.
      Parameters:
      dn - The current DN for the entry. It must not be null.
      newRDN - The new RDN value for the entry. It must not be null.
      deleteOldRDN - Indicates whether to delete the currentRDN value from the entry.
      newSuperiorDN - The new superior DN for this LDIF modify DN change record. It may be null if the entry is not to be moved below a new parent.

    • LDIFModifyDNChangeRecord

      public LDIFModifyDNChangeRecord(@NotNull String dn, @NotNull String newRDN, boolean deleteOldRDN, @Nullable String newSuperiorDN, @Nullable List<Control> controls)
      Creates a new LDIF modify DN change record with the provided information.
      Parameters:
      dn - The current DN for the entry. It must not be null.
      newRDN - The new RDN value for the entry. It must not be null.
      deleteOldRDN - Indicates whether to delete the currentRDN value from the entry.
      newSuperiorDN - The new superior DN for this LDIF modify DN change record. It may be null if the entry is not to be moved below a new parent.
      controls - The set of controls for this LDIF modify DN change record. It may be null or empty if there are no controls.

    • LDIFModifyDNChangeRecord

      public LDIFModifyDNChangeRecord(@NotNull ModifyDNRequest modifyDNRequest)
      Creates a new LDIF modify DN change record from the provided modify DN request.
      Parameters:
      modifyDNRequest - The modify DN request to use to create this LDIF modify DN change record. It must not be null.

  • Method Details

    • getNewRDN

      @NotNull public String getNewRDN()
      Retrieves the new RDN value for the entry.
      Returns:
      The new RDN value for the entry.

    • getParsedNewRDN

      @NotNull public RDN getParsedNewRDN() throws LDAPException
      Retrieves the parsed new RDN value for the entry.
      Returns:
      The parsed new RDN value for the entry.
      Throws:
      LDAPException - If a problem occurs while trying to parse the new RDN.

    • deleteOldRDN

      public boolean deleteOldRDN()
      Indicates whether to delete the current RDN value from the entry.
      Returns:
      true if the current RDN value should be removed from the entry, or false if not.

    • getNewSuperiorDN

      @Nullable public String getNewSuperiorDN()
      Retrieves the new superior DN for the entry, if applicable.
      Returns:
      The new superior DN for the entry, or null if the entry is not to be moved below a new parent.

    • getParsedNewSuperiorDN

      @Nullable public DN getParsedNewSuperiorDN() throws LDAPException
      Retrieves the parsed new superior DN for the entry, if applicable.
      Returns:
      The parsed new superior DN for the entry, or null if the entry is not to be moved below a new parent.
      Throws:
      LDAPException - If a problem occurs while trying to parse the new superior DN.

    • getNewDN

      @NotNull public DN getNewDN() throws LDAPException
      Retrieves the DN that the entry should have after the successful completion of the operation.
      Returns:
      The DN that the entry should have after the successful completion of the operation.
      Throws:
      LDAPException - If a problem occurs while trying to parse the target DN, new RDN, or new superior DN.

    • toModifyDNRequest

      @NotNull public ModifyDNRequest toModifyDNRequest()
      Creates a modify DN request from this LDIF modify DN change record. Any change record controls will be included in the request
      Returns:
      The modify DN request created from this LDIF modify DN change record.

    • toModifyDNRequest

      @NotNull public ModifyDNRequest toModifyDNRequest(boolean includeControls)
      Creates a modify DN request from this LDIF modify DN change record, optionally including any change record controls in the request.
      Parameters:
      includeControls - Indicates whether to include any controls in the request.
      Returns:
      The modify DN request created from this LDIF modify DN change record.

    • getChangeType

      @NotNull public ChangeType getChangeType()
      Retrieves the type of operation represented by this LDIF change record.
      Specified by:
      getChangeType in class LDIFChangeRecord
      Returns:
      The type of operation represented by this LDIF change record.

    • duplicate

      @NotNull public LDIFModifyDNChangeRecord duplicate(@Nullable Control... controls)
      Creates a duplicate of this LDIF change record with the provided set of controls.
      Specified by:
      duplicate in class LDIFChangeRecord
      Parameters:
      controls - The set of controls to include in the duplicate change record. It may be null or empty if no controls should be included.
      Returns:
      A duplicate of this LDIF change record with the provided set of controls.

    • processChange

      @NotNull public LDAPResult processChange(@NotNull LDAPInterface connection, boolean includeControls) throws LDAPException
      Apply the change represented by this LDIF change record to a directory server using the provided connection, optionally including any change record controls in the request.
      Specified by:
      processChange in class LDIFChangeRecord
      Parameters:
      connection - The connection to use to apply the change.
      includeControls - Indicates whether to include any controls in the request.
      Returns:
      An object providing information about the result of the operation.
      Throws:
      LDAPException - If an error occurs while processing this change in the associated directory server.

    • toLDIF

      @NotNull public String[] toLDIF(int wrapColumn)
      Retrieves a string array whose lines contain an LDIF representation of this change record.
      Specified by:
      toLDIF in interface LDIFRecord
      Specified by:
      toLDIF in class LDIFChangeRecord
      Parameters:
      wrapColumn - The column at which to wrap long lines. A value that is less than or equal to two indicates that no wrapping should be performed.
      Returns:
      A string array whose lines contain an LDIF representation of this change record.

    • toLDIF

      public void toLDIF(@NotNull ByteStringBuffer buffer, int wrapColumn)
      Appends an LDIF string representation of this change record to the provided buffer.
      Specified by:
      toLDIF in interface LDIFRecord
      Specified by:
      toLDIF in class LDIFChangeRecord
      Parameters:
      buffer - The buffer to which to append an LDIF representation of this change record.
      wrapColumn - The column at which to wrap long lines. A value that is less than or equal to two indicates that no wrapping should be performed.

    • toLDIFString

      public void toLDIFString(@NotNull StringBuilder buffer, int wrapColumn)
      Appends an LDIF string representation of this change record to the provided buffer.
      Specified by:
      toLDIFString in interface LDIFRecord
      Specified by:
      toLDIFString in class LDIFChangeRecord
      Parameters:
      buffer - The buffer to which to append an LDIF representation of this change record.
      wrapColumn - The column at which to wrap long lines. A value that is less than or equal to two indicates that no wrapping should be performed.

    • hashCode

      public int hashCode()
      Retrieves a hash code for this change record.
      Specified by:
      hashCode in class LDIFChangeRecord
      Returns:
      A hash code for this change record.

    • equals

      public boolean equals(@Nullable Object o)
      Indicates whether the provided object is equal to this LDIF change record.
      Specified by:
      equals in class LDIFChangeRecord
      Parameters:
      o - The object for which to make the determination.
      Returns:
      true if the provided object is equal to this LDIF change record, or false if not.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a single-line string representation of this change record to the provided buffer.
      Specified by:
      toString in interface LDIFRecord
      Specified by:
      toString in class LDIFChangeRecord
      Parameters:
      buffer - The buffer to which the information should be written.