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

Class TextFormattedModifyDNRequestAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedModifyDNRequestAccessLogMessage

All Implemented Interfaces:

AccessLogMessage, LogMessage, ModifyDNRequestAccessLogMessage, OperationRequestAccessLogMessage, Serializable

Direct Known Subclasses:

TextFormattedModifyDNForwardAccessLogMessage, TextFormattedModifyDNResultAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class TextFormattedModifyDNRequestAccessLogMessage
extends TextFormattedRequestAccessLogMessage
implements ModifyDNRequestAccessLogMessage

This class provides a data structure that holds information about a text-formatted modify DN request access log message.

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

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

NO_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
TextFormattedModifyDNRequestAccessLogMessage(String logMessageString)	Creates a new text-formatted modify DN request access log message from the provided message string.

Method Summary

Modifier and Type	Method	Description
final Boolean	getDeleteOldRDN()	Indicates whether the old RDN value(s) should be removed from the entry.
final String	getDN()	Retrieves the DN of the entry to rename.
final String	getNewRDN()	Retrieves the new RDN to use for the entry.
final String	getNewSuperiorDN()	Retrieves the new superior DN to use for the entry.
final AccessLogOperationType	getOperationType()	Retrieves the operation type for the associated operation.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getMessageType, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage

getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage

getAdministrativeOperationMessage, getMessageID, getOperationID, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Constructor Details

TextFormattedModifyDNRequestAccessLogMessage

public TextFormattedModifyDNRequestAccessLogMessage(@NotNull
 String logMessageString)
                                             throws LogException

Creates a new text-formatted modify DN request access log message from the provided message string.

Parameters:

logMessageString - The string representation of this log message. It must not be null.

Throws:

LogException - If the provided string cannot be parsed as a valid log message.

Method Details

getOperationType

@NotNull
public final AccessLogOperationType getOperationType()

Retrieves the operation type for the associated operation.

Specified by:

getOperationType in interface OperationRequestAccessLogMessage

Returns:

The operation type for this access log message.

getDN

@Nullable
public final String getDN()

Retrieves the DN of the entry to rename.

Specified by:

getDN in interface ModifyDNRequestAccessLogMessage

Returns:

The DN of the entry to rename, or null if it is not included in the log message.

getNewRDN

@Nullable
public final String getNewRDN()

Retrieves the new RDN to use for the entry.

Specified by:

getNewRDN in interface ModifyDNRequestAccessLogMessage

Returns:

The new RDN to use for the entry, or null if it is not included in the log message.

getDeleteOldRDN

@Nullable
public final Boolean getDeleteOldRDN()

Indicates whether the old RDN value(s) should be removed from the entry.

Specified by:

getDeleteOldRDN in interface ModifyDNRequestAccessLogMessage

Returns:

Boolean.TRUE if the old RDN value(s) should be removed from the entry, Boolean.FALSE if the old RDN value(s) should be kept in the entry, or null if it is not included in the log message.

getNewSuperiorDN

@Nullable
public final String getNewSuperiorDN()

Retrieves the new superior DN to use for the entry.

Specified by:

getNewSuperiorDN in interface ModifyDNRequestAccessLogMessage

Returns:

The new superior DN to use for the entry, or null if it is not included in the log message.