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

Class TextFormattedDeleteForwardAccessLogMessage

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

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

All Implemented Interfaces:

AccessLogMessage, DeleteForwardAccessLogMessage, DeleteRequestAccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationRequestAccessLogMessage, Serializable

Direct Known Subclasses:

TextFormattedDeleteForwardFailedAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class TextFormattedDeleteForwardAccessLogMessage
extends TextFormattedDeleteRequestAccessLogMessage
implements DeleteForwardAccessLogMessage

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

Method Summary

Modifier and Type	Method	Description
AccessLogMessageType	getMessageType()	Retrieves the message type for this access log message.
final String	getTargetHost()	Retrieves the address of the backend server to which the request has been forwarded.
final Integer	getTargetPort()	Retrieves the port of the backend server to which the request has been forwarded.
final 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.TextFormattedDeleteRequestAccessLogMessage

getDN, getOperationType

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

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

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

getDN

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

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

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

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

Constructor Details

TextFormattedDeleteForwardAccessLogMessage

public TextFormattedDeleteForwardAccessLogMessage(@NotNull
 String logMessageString)
                                           throws LogException

Creates a new text-formatted delete 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 Details

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