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

Class TextFormattedSearchForwardAccessLogMessage

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

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

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

All Implemented Interfaces:

AccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, SearchForwardAccessLogMessage, SearchRequestAccessLogMessage, java.io.Serializable

Direct Known Subclasses:

TextFormattedSearchForwardFailedAccessLogMessage

@NotExtensible
 @NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public class TextFormattedSearchForwardAccessLogMessage
extends TextFormattedSearchRequestAccessLogMessage
implements SearchForwardAccessLogMessage

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

Method Summary

Modifier and Type	Method and Description
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.v2.text.TextFormattedSearchRequestAccessLogMessage

getBaseDN, getDereferencePolicy, getFilter, getOperationType, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

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

getBaseDN, getDereferencePolicy, getFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage

getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

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

TextFormattedSearchForwardAccessLogMessage

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

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

Parameters:

logMessageString - The string representation of this log message. 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

Overrides:

getMessageType in class TextFormattedRequestAccessLogMessage

Returns:

The message type for this access log message.

getTargetHost

@Nullable
public final java.lang.String getTargetHost()

Retrieves the address of the backend server to which the request has been forwarded.

Specified by:

getTargetHost in interface OperationForwardAccessLogMessage

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

@Nullable
public final java.lang.Integer getTargetPort()

Retrieves the port of the backend server to which the request has been forwarded.

Specified by:

getTargetPort in interface OperationForwardAccessLogMessage

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

@Nullable
public final java.lang.String getTargetProtocol()

Retrieves the protocol used to forward the request to the backend server.

Specified by:

getTargetProtocol in interface OperationForwardAccessLogMessage

Returns:

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