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

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.ModifyRequestAccessLogMessage
                      extended by com.unboundid.ldap.sdk.unboundidds.logs.ModifyForwardAccessLogMessage
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ModifyForwardAccessLogMessage
extends ModifyRequestAccessLogMessage

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 request forwarded to a backend server.

See Also:
Serialized Form

Constructor Summary
ModifyForwardAccessLogMessage(LogMessage m)
          Creates a new modify forward access log message from the provided log message.
ModifyForwardAccessLogMessage(java.lang.String s)
          Creates a new modify forward access log message from the provided message string.
 
Method Summary
 AccessLogMessageType getMessageType()
          Retrieves the message type for this access log message.
 java.lang.String getTargetHost()
          Retrieves the address of the backend server to which the request has been forwarded.
 java.lang.Integer getTargetPort()
          Retrieves the port of the backend server to which the request has been forwarded.
 java.lang.String getTargetProtocol()
          Retrieves the protocol used to forward the request to the backend server.
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.ModifyRequestAccessLogMessage
getAttributeNames, getDN, getOperationType
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, 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

ModifyForwardAccessLogMessage

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

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

ModifyForwardAccessLogMessage

public ModifyForwardAccessLogMessage(LogMessage m)
Creates a new modify forward access log message from the provided log message.

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

getTargetHost

public java.lang.String getTargetHost()
Retrieves the address of the backend server to which the request has been forwarded.

Returns:
The address of the backend server to which the request has been forwarded, or null if it is not included in the log message.

getTargetPort

public java.lang.Integer getTargetPort()
Retrieves the port of the backend server to which the request has been forwarded.

Returns:
The port of the backend server to which the request has been forwarded, or null if it is not included in the log message.

getTargetProtocol

public java.lang.String getTargetProtocol()
Retrieves the protocol used to forward the request to the backend server.

Returns:
The protocol used to forward the request to the backend server, or null if it is not included in the log message.

getMessageType

public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.

Overrides:
getMessageType in class OperationRequestAccessLogMessage
Returns:
The message type for this access log message.