Class DeleteAuditLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.AuditLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.DeleteAuditLogMessage
-
- All Implemented Interfaces:
java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DeleteAuditLogMessage extends AuditLogMessage
This class provides a data structure that holds information about an audit log message that represents a delete 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 DeleteAuditLogMessage(java.lang.String... logMessageLines)
Creates a new delete audit log message from the provided set of lines.DeleteAuditLogMessage(java.util.List<java.lang.String> logMessageLines)
Creates a new delete audit log message from the provided set of lines.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LDIFDeleteChangeRecord
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.Boolean
getDeletedAsPartOfSubtreeDelete()
Retrieves the value of the flag that indicates whether this delete audit log record represents an entry that was deleted as part of a subtree delete (and is not the base entry for that subtree delete), if available.ReadOnlyEntry
getDeletedEntry()
Retrieves a read-only copy of the entry that was deleted, if available.java.util.List<Attribute>
getDeletedEntryVirtualAttributes()
Retrieves a list of the virtual attributes from the entry that was deleted, if available.java.lang.String
getDN()
Retrieves the DN of the entry targeted by the associated operation.java.lang.Boolean
getIsSoftDelete()
Retrieves the value of the flag that indicates whether this delete operation was a soft delete, if available.java.lang.Boolean
getIsSoftDeletedEntry()
Retrieves the value of the flag that indicates whether this delete operation targeted an entry that had previously been soft deleted, if available.java.lang.Boolean
getIsSubtreeDelete()
Retrieves the value of the flag that indicates whether this delete audit log message represents the delete of the base entry of a subtree delete operation, if available.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.java.lang.String
getSoftDeletedEntryDN()
Retrieves the DN of the entry after it was been soft deleted, if available.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
-
DeleteAuditLogMessage
public DeleteAuditLogMessage(java.lang.String... logMessageLines) throws AuditLogException
Creates a new delete 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 lines) that serves as the message header.- Throws:
AuditLogException
- If a problem is encountered while processing the provided list of log message lines.
-
DeleteAuditLogMessage
public DeleteAuditLogMessage(java.util.List<java.lang.String> logMessageLines) throws AuditLogException
Creates a new delete 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 lines) 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
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.
-
getIsSubtreeDelete
public java.lang.Boolean getIsSubtreeDelete()
Retrieves the value of the flag that indicates whether this delete audit log message represents the delete of the base entry of a subtree delete operation, if available.- Returns:
Boolean.TRUE
if it is known that the operation was a subtree delete,Boolean.FALSE
if it is known that the operation was not a subtree delete, ornull
if this is not available.
-
getDeletedAsPartOfSubtreeDelete
public java.lang.Boolean getDeletedAsPartOfSubtreeDelete()
Retrieves the value of the flag that indicates whether this delete audit log record represents an entry that was deleted as part of a subtree delete (and is not the base entry for that subtree delete), if available.- Returns:
Boolean.TRUE
if it is known that the entry was deleted as part of a subtree delete,Boolean.FALSE
if it is known that the entry was not deleted as part of a subtree delete, ornull
if this is not available.
-
getIsSoftDelete
public java.lang.Boolean getIsSoftDelete()
Retrieves the value of the flag that indicates whether this delete operation was a soft delete, if available.- Returns:
Boolean.TRUE
if it is known that the operation was a soft delete,Boolean.FALSE
if it is known that the operation was not a soft delete, ornull
if this is not available.
-
getSoftDeletedEntryDN
public java.lang.String getSoftDeletedEntryDN()
Retrieves the DN of the entry after it was been soft deleted, if available.- Returns:
- The DN of the entry after it was soft deleted, or
null
if this is not available.
-
getIsSoftDeletedEntry
public java.lang.Boolean getIsSoftDeletedEntry()
Retrieves the value of the flag that indicates whether this delete 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.
-
getDeletedEntry
public ReadOnlyEntry getDeletedEntry()
Retrieves a read-only copy of the entry that was deleted, if available.- Returns:
- A read-only copy of the entry that was deleted, or
null
if it is not available.
-
getDeletedEntryVirtualAttributes
public java.util.List<Attribute> getDeletedEntryVirtualAttributes()
Retrieves a list of the virtual attributes from the entry that was deleted, if available.- Returns:
- A list of the virtual attributes from the entry that was deleted,
or
null
if it is not available.
-
getChangeType
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
public LDIFDeleteChangeRecord 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
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(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.
-
-