Class JSONExtendedForwardAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONExtendedRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONExtendedForwardAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,ExtendedForwardAccessLogMessage
,ExtendedRequestAccessLogMessage
,LogMessage
,OperationForwardAccessLogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
- Direct Known Subclasses:
JSONExtendedForwardFailedAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class JSONExtendedForwardAccessLogMessage extends JSONExtendedRequestAccessLogMessage implements ExtendedForwardAccessLogMessage
This class provides a data structure that holds information about a JSON-formatted extended 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
-
-
Constructor Summary
Constructors Constructor Description JSONExtendedForwardAccessLogMessage(JSONObject jsonObject)
Creates a new JSON extended forward access log message from the provided JSON object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.json.JSONExtendedRequestAccessLogMessage
getOperationType, getRequestOID, getRequestType
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONAccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONLogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getJSONObject, getLogType, 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.ExtendedRequestAccessLogMessage
getRequestOID, getRequestType
-
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 Detail
-
JSONExtendedForwardAccessLogMessage
public JSONExtendedForwardAccessLogMessage(@NotNull JSONObject jsonObject) throws LogException
Creates a new JSON extended forward access log message from the provided JSON object.- Parameters:
jsonObject
- The JSON object that contains an encoded representation of this log message. It must not benull
.- Throws:
LogException
- If the provided JSON object 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 interfaceAccessLogMessage
- Overrides:
getMessageType
in classJSONRequestAccessLogMessage
- 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 interfaceOperationForwardAccessLogMessage
- 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 interfaceOperationForwardAccessLogMessage
- 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 interfaceOperationForwardAccessLogMessage
- Returns:
- The protocol used to forward the request to the backend server, or
null
if it is not included in the log message.
-
-