Class JSONConnectAccessLogMessage
- 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.JSONConnectAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,ConnectAccessLogMessage
,LogMessage
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONConnectAccessLogMessage extends JSONAccessLogMessage implements ConnectAccessLogMessage
This class provides a data structure that holds information about a JSON-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
-
-
Constructor Summary
Constructors Constructor Description JSONConnectAccessLogMessage(JSONObject jsonObject)
Creates a new JSON connect access log message from the provided JSON object.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.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.LogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
-
-
-
Constructor Detail
-
JSONConnectAccessLogMessage
public JSONConnectAccessLogMessage(@NotNull JSONObject jsonObject) throws LogException
Creates a new JSON connect 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
- 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 interfaceConnectAccessLogMessage
- 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 interfaceConnectAccessLogMessage
- 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 interfaceConnectAccessLogMessage
- 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 interfaceConnectAccessLogMessage
- 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 interfaceConnectAccessLogMessage
- 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 interfaceConnectAccessLogMessage
- 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.
-
-