com.unboundid.ldap.sdk.unboundidds.logs
Class ModifyDNRequestAccessLogMessage

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
                  extended by com.unboundid.ldap.sdk.unboundidds.logs.ModifyDNRequestAccessLogMessage
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ModifyDNForwardAccessLogMessage, ModifyDNForwardFailedAccessLogMessage, ModifyDNResultAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class ModifyDNRequestAccessLogMessage
extends OperationRequestAccessLogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify DN request received from a client.

See Also:
Serialized Form

Constructor Summary
ModifyDNRequestAccessLogMessage(LogMessage m)
          Creates a new modify DN request access log message from the provided log message.
ModifyDNRequestAccessLogMessage(java.lang.String s)
          Creates a new modify DN request access log message from the provided message string.
 
Method Summary
 java.lang.Boolean deleteOldRDN()
          Indicates whether the old RDN value(s) should be removed from the entry.
 java.lang.String getDN()
          Retrieves the DN of the entry to rename.
 java.lang.String getNewRDN()
          Retrieves the new RDN to use for the entry.
 java.lang.String getNewSuperiorDN()
          Retrieves the new superior DN to use for the entry.
 AccessLogOperationType getOperationType()
          Retrieves the operation type for the associated operation.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, getMessageType, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
getMessageID, getOperationID, getOrigin
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, parse
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModifyDNRequestAccessLogMessage

public ModifyDNRequestAccessLogMessage(java.lang.String s)
                                throws LogException
Creates a new modify DN request access log message from the provided message string.

Parameters:
s - The string to be parsed as a modify DN request access log message.
Throws:
LogException - If the provided string cannot be parsed as a valid log message.

ModifyDNRequestAccessLogMessage

public ModifyDNRequestAccessLogMessage(LogMessage m)
Creates a new modify DN request access log message from the provided log message.

Parameters:
m - The log message to be parsed as a modify DN request access log message.
Method Detail

getDN

public final java.lang.String getDN()
Retrieves the DN of the entry to rename.

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

getNewRDN

public final java.lang.String getNewRDN()
Retrieves the new RDN to use for the entry.

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

deleteOldRDN

public final java.lang.Boolean deleteOldRDN()
Indicates whether the old RDN value(s) should be removed from the entry.

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

public final java.lang.String getNewSuperiorDN()
Retrieves the new superior DN to use for the entry.

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

getOperationType

public final AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.

Specified by:
getOperationType in class OperationAccessLogMessage
Returns:
The operation type for this access log message.