com.unboundid.ldap.sdk.unboundidds.logs

Class ConnectAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.LogMessage

com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage

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

All Implemented Interfaces:

java.io.Serializable

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

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.

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 and Description
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

Modifier and Type	Method and Description
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(@NotNull
                               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(@NotNull
                               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

@Nullable
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

@Nullable
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

@Nullable
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

@Nullable
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

@NotNull
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.