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

Class AddAuditLogMessage

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.AuditLogMessage
com.unboundid.ldap.sdk.unboundidds.logs.AddAuditLogMessage
All Implemented Interfaces:
Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AddAuditLogMessage extends AuditLogMessage
This class provides a data structure that holds information about an audit log message that represents an add 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:

  • Constructor Details

    • AddAuditLogMessage

      public AddAuditLogMessage(@NotNull String... logMessageLines) throws AuditLogException
      Creates a new add 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.

    • AddAuditLogMessage

      public AddAuditLogMessage(@NotNull List<String> logMessageLines) throws AuditLogException
      Creates a new add 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.

  • Method Details

    • getDN

      @NotNull public 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.

    • getEntry

      @NotNull public ReadOnlyEntry getEntry()
      Retrieves a read-only representation of the entry that was added.
      Returns:
      A read-only representation of the entry that was added.

    • getIsUndelete

      @Nullable public Boolean getIsUndelete()
      Retrieves the value of the "isUndelete" flag from this log message, which indicates whether the add operation attempted to undelete a previously soft-deleted entry, if available.
      Returns:
      The value of the "isUndelete" flag from this log message, or null if it is not available.

    • getUndeleteRequestEntry

      @Nullable public ReadOnlyEntry getUndeleteRequestEntry()
      Retrieves the entry that comprised the undelete request, available.
      Returns:
      The entry that comprised the undelete request, or null if it is not available.

    • getChangeType

      @NotNull public ChangeType getChangeType()
      Retrieves the change type for this audit log message.
      Specified by:
      getChangeType in class AuditLogMessage
      Returns:
      The change type for this audit log message.

    • getChangeRecord

      @NotNull public LDIFAddChangeRecord getChangeRecord()
      Retrieves an LDIF change record that encapsulates the change represented by this audit log message.
      Specified by:
      getChangeRecord in class AuditLogMessage
      Returns:
      An LDIF change record that encapsulates the change represented by this audit log message.

    • isRevertible

      public boolean isRevertible()
      Indicates whether it is possible to use the AuditLogMessage.getRevertChangeRecords() method to obtain a list of LDIF change records that can be used to revert the changes described by this audit log message.
      Specified by:
      isRevertible in class AuditLogMessage
      Returns:
      true if it is possible to use the AuditLogMessage.getRevertChangeRecords() method to obtain a list of LDIF change records that can be used to revert the changes described by this audit log message, or false if not.

    • getRevertChangeRecords

      @NotNull public List<LDIFChangeRecord> getRevertChangeRecords()
      Retrieves a list of the change records that can be used to revert the changes described by this audit log message.
      Specified by:
      getRevertChangeRecords in class AuditLogMessage
      Returns:
      A list of the change records that can be used to revert the changes described by this audit log message.

    • toString

      public void toString(@NotNull 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.