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

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.ConnectAccessLogMessage
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ConnectAccessLogMessage
extends AccessLogMessage

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 connection that has been established.

See Also:
Serialized Form

Constructor Summary
ConnectAccessLogMessage(LogMessage m)
          Creates a new connect access log message from the provided log message.
ConnectAccessLogMessage(java.lang.String s)
          Creates a new connect access log message from the provided message string.
 
Method Summary
 java.lang.String getClientConnectionPolicy()
          Retrieves the name of the client connection policy that was selected for the client connection.
 AccessLogMessageType getMessageType()
          Retrieves the message type for this access log message.
 java.lang.String getProtocolName()
          Retrieves the name of the protocol the client is using to communicate with the Directory Server.
 java.lang.String getSourceAddress()
          Retrieves the source address for the client connection.
 java.lang.String getTargetAddress()
          Retrieves the server address to which the client connection is established.
 
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

ConnectAccessLogMessage

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

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

ConnectAccessLogMessage

public ConnectAccessLogMessage(LogMessage m)
Creates a new connect access log message from the provided log message.

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

getSourceAddress

public java.lang.String getSourceAddress()
Retrieves the source address for the client connection.

Returns:
The source address for the client connection, or null if it is not included in the log message.

getTargetAddress

public java.lang.String getTargetAddress()
Retrieves the server address to which the client connection is established.

Returns:
The server address to which the client connection is established, or null if it is not included in the log message.

getProtocolName

public java.lang.String getProtocolName()
Retrieves the name of the protocol the client is using to communicate with the Directory Server.

Returns:
The name of the protocol the client is using to communicate with the Directory Server, or null if it is not included in the log message.

getClientConnectionPolicy

public java.lang.String getClientConnectionPolicy()
Retrieves the name of the client connection policy that was selected for the client connection.

Returns:
The name of the client connection policy that was selected for the client connection, or null if it is not included in the log message.

getMessageType

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

Specified by:
getMessageType in class AccessLogMessage
Returns:
The message type for this access log message.