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

Class TextFormattedConnectAccessLogMessage

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.TextFormattedConnectAccessLogMessage

All Implemented Interfaces:

AccessLogMessage, ConnectAccessLogMessage, LogMessage, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TextFormattedConnectAccessLogMessage
extends TextFormattedAccessLogMessage
implements ConnectAccessLogMessage

This class provides a data structure that holds information about a text-formatted connect 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
TextFormattedConnectAccessLogMessage(java.lang.String logMessageString)	Creates a new text-formatted connect access log message from the provided message string.

Method Summary

Modifier and Type	Method	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.Integer	getSourcePort()	Retrieves the source port for the client connection.
java.lang.String	getTargetAddress()	Retrieves the server address to which the client connection is established.
java.lang.Integer	getTargetPort()	Retrieves the target port for the client connection.

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, 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

Constructor Detail

TextFormattedConnectAccessLogMessage

public TextFormattedConnectAccessLogMessage(@NotNull
                                            java.lang.String logMessageString)
                                     throws LogException

Creates a new text-formatted connect access log message from the provided message string.

Parameters:

logMessageString - The string representation of the log message to create. It must not be null.

Throws:

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

Method Detail

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Returns:

The message type for this access log message.

getSourceAddress

@Nullable
public java.lang.String getSourceAddress()

Retrieves the source address for the client connection.

Specified by:

getSourceAddress in interface ConnectAccessLogMessage

Returns:

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

getSourcePort

@Nullable
public java.lang.Integer getSourcePort()

Retrieves the source port for the client connection.

Specified by:

getSourcePort in interface ConnectAccessLogMessage

Returns:

The source port 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.

Specified by:

getTargetAddress in interface ConnectAccessLogMessage

Returns:

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

getTargetPort

@Nullable
public java.lang.Integer getTargetPort()

Retrieves the target port for the client connection.

Specified by:

getTargetPort in interface ConnectAccessLogMessage

Returns:

The target port for the client connection, 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.

Specified by:

getProtocolName in interface ConnectAccessLogMessage

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.

Specified by:

getClientConnectionPolicy in interface ConnectAccessLogMessage

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.