Package com.unboundid.ldap.sdk.unboundidds.logs

Class ModifyDNAuditLogMessage

  • All Implemented Interfaces:
    java.io.Serializable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ModifyDNAuditLogMessage
extends AuditLogMessage
    This class provides a data structure that holds information about an audit log message that represents a modify DN operation.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form

    • Constructor Detail

      • ModifyDNAuditLogMessage

        public ModifyDNAuditLogMessage​(@NotNull
                               java.lang.String... logMessageLines)
                        throws AuditLogException
        Creates a new modify DN audit log message from the provided set of lines.
        Parameters:
        logMessageLines - The lines that comprise the log message. It must not be null or empty, and it must not contain any blank lines, although it may contain comments. In fact, it must contain at least one comment line that appears before any non-comment lines (but possibly after other comment lines) that serves as the message header.
        Throws:
        AuditLogException - If a problem is encountered while processing the provided list of log message lines.

      • ModifyDNAuditLogMessage

        public ModifyDNAuditLogMessage​(@NotNull
                               java.util.List<java.lang.String> logMessageLines)
                        throws AuditLogException
        Creates a new modify DN audit log message from the provided set of lines.
        Parameters:
        logMessageLines - The lines that comprise the log message. It must not be null or empty, and it must not contain any blank lines, although it may contain comments. In fact, it must contain at least one comment line that appears before any non-comment lines (but possibly after other comment lines) that serves as the message header.
        Throws:
        AuditLogException - If a problem is encountered while processing audit provided list of log message lines.

    • Method Detail

      • getDN

        @NotNull
public java.lang.String getDN()
        Retrieves the DN of the entry targeted by the associated operation.
        Specified by:
        getDN in class AuditLogMessage
        Returns:
        The DN of the entry targeted by the associated operation.

      • getNewRDN

        @NotNull
public java.lang.String getNewRDN()
        Retrieves the new RDN for the associated modify DN operation.
        Returns:
        The new RDN for the associated modify DN operation.

      • deleteOldRDN

        public boolean deleteOldRDN()
        Indicates whether the old RDN attribute values were removed from the entry.
        Returns:
        true if the old RDN attribute values were removed from the entry, or false if not.

      • getNewSuperiorDN

        @Nullable
public java.lang.String getNewSuperiorDN()
        Retrieves the new superior DN for the associated modify DN operation, if available.
        Returns:
        The new superior DN for the associated modify DN operation, or null if there was no new superior DN.

      • getAttributeModifications

        @Nullable
public java.util.List<Modification> getAttributeModifications()
        Retrieves the list of attribute modifications for the associated modify DN operation, if available.
        Returns:
        The list of attribute modifications for the associated modify DN operation, or null if it is not available. If it is known that there were no attribute modifications, then an empty list will be returned.

      • toString

        public void toString​(@NotNull
                     java.lang.StringBuilder buffer)
        Appends a single-line string representation of this audit log message to the provided buffer. The message will start with the string returned by AuditLogMessage.getUncommentedHeaderLine(), but will also contain additional name-value pairs that are pertinent to the type of operation that the audit log message represents.
        Specified by:
        toString in class AuditLogMessage
        Parameters:
        buffer - The buffer to which the information should be appended.