Class ModifyAuditLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.AuditLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.ModifyAuditLogMessage
-
- All Implemented Interfaces:
java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ModifyAuditLogMessage extends AuditLogMessage
This class provides a data structure that holds information about an audit log message that represents a modify 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 Summary
Constructors Constructor Description ModifyAuditLogMessage(java.lang.String... logMessageLines)
Creates a new modify audit log message from the provided set of lines.ModifyAuditLogMessage(java.util.List<java.lang.String> logMessageLines)
Creates a new modify audit log message from the provided set of lines.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LDIFModifyChangeRecord
getChangeRecord()
Retrieves an LDIF change record that encapsulates the change represented by this audit log message.ChangeType
getChangeType()
Retrieves the change type for this audit log message.java.lang.String
getDN()
Retrieves the DN of the entry targeted by the associated operation.java.lang.Boolean
getIsSoftDeletedEntry()
Retrieves the value of the flag that indicates whether this modify operation targeted an entry that had previously been soft deleted, if available.java.util.List<Modification>
getModifications()
Retrieves a list of the modifications included in the associated modify operation.java.util.List<LDIFChangeRecord>
getRevertChangeRecords()
Retrieves a list of the change records that can be used to revert the changes described by this audit log message.boolean
isRevertible()
Indicates whether it is possible to use theAuditLogMessage.getRevertChangeRecords()
method to obtain a list of LDIF change records that can be used to revert the changes described by this audit log message.void
toString(java.lang.StringBuilder buffer)
Appends a single-line string representation of this audit log message to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AuditLogMessage
decodeCommentedEntry, getAlternateAuthorizationDN, getCommentedHeaderLine, getConnectionID, getHeaderNamedValues, getInstanceName, getIntermediateClientRequestControl, getLogMessageLines, getNamedValueAsBoolean, getNamedValueAsLong, getOperationID, getOperationPurposeRequestControl, getOrigin, getProductName, getReplicationChangeID, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getStartupID, getThreadID, getTimestamp, getTransactionID, getTriggeredByConnectionID, getTriggeredByOperationID, getUncommentedHeaderLine, getUsingAdminSessionWorkerThread, toMultiLineString, toString
-
-
-
-
Constructor Detail
-
ModifyAuditLogMessage
public ModifyAuditLogMessage(@NotNull java.lang.String... logMessageLines) throws AuditLogException
Creates a new modify audit log message from the provided set of lines.- Parameters:
logMessageLines
- The lines that comprise the log message. It must not benull
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 line) that serves as the message header.- Throws:
AuditLogException
- If a problem is encountered while processing the provided list of log message lines.
-
ModifyAuditLogMessage
public ModifyAuditLogMessage(@NotNull java.util.List<java.lang.String> logMessageLines) throws AuditLogException
Creates a new modify audit log message from the provided set of lines.- Parameters:
logMessageLines
- The lines that comprise the log message. It must not benull
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 line) that serves as the message header.- Throws:
AuditLogException
- If a problem is encountered while processing the 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 classAuditLogMessage
- Returns:
- The DN of the entry targeted by the associated operation.
-
getModifications
@NotNull public java.util.List<Modification> getModifications()
Retrieves a list of the modifications included in the associated modify operation.- Returns:
- A list of the modifications included in the associated modify operation.
-
getIsSoftDeletedEntry
@Nullable public java.lang.Boolean getIsSoftDeletedEntry()
Retrieves the value of the flag that indicates whether this modify operation targeted an entry that had previously been soft deleted, if available.- Returns:
Boolean.TRUE
if it is known that the operation targeted a soft-deleted entry,Boolean.FALSE
if it is known that the operation did not target a soft-deleted entry, ornull
if this is not available.
-
getChangeType
@NotNull public ChangeType getChangeType()
Retrieves the change type for this audit log message.- Specified by:
getChangeType
in classAuditLogMessage
- Returns:
- The change type for this audit log message.
-
getChangeRecord
@NotNull public LDIFModifyChangeRecord getChangeRecord()
Retrieves an LDIF change record that encapsulates the change represented by this audit log message.- Specified by:
getChangeRecord
in classAuditLogMessage
- 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 theAuditLogMessage.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 classAuditLogMessage
- Returns:
true
if it is possible to use theAuditLogMessage.getRevertChangeRecords()
method to obtain a list of LDIF change records that can be used to revert the changes described by this audit log message, orfalse
if not.
-
getRevertChangeRecords
@NotNull public java.util.List<LDIFChangeRecord> getRevertChangeRecords() throws AuditLogException
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 classAuditLogMessage
- Returns:
- A list of the change records that can be used to revert the changes described by this audit log message.
- Throws:
AuditLogException
- If this audit log message cannot be reverted.
-
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 byAuditLogMessage.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 classAuditLogMessage
- Parameters:
buffer
- The buffer to which the information should be appended.
-
-