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

Class JSONClientCertificateAccessLogMessage

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

All Implemented Interfaces:

AccessLogMessage, ClientCertificateAccessLogMessage, LogMessage, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JSONClientCertificateAccessLogMessage
extends JSONAccessLogMessage
implements ClientCertificateAccessLogMessage

This class provides a data structure that holds information about a JSON-formatted client certificate 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 and Description
JSONClientCertificateAccessLogMessage(JSONObject jsonObject) Creates a new JSON client certificate access log message from the provided JSON object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutoAuthenticatedAsDN() Retrieves the DN of the user that was automatically authenticated by the client certificate.
java.util.List<java.lang.String>	getIssuerSubjectDNs() Retrieves the subject of the issuer certificate.
AccessLogMessageType	getMessageType() Retrieves the message type for this access log message.
java.util.List<JSONCertificate>	getPeerCertificateChain() Retrieves the peer certificate chain for this log message.
java.lang.String	getPeerSubjectDN() Retrieves the subject of the peer certificate.

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

JSONClientCertificateAccessLogMessage

public JSONClientCertificateAccessLogMessage(@NotNull
                                             JSONObject jsonObject)
                                      throws LogException

Creates a new JSON client certificate 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 be null.

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

Returns:

The message type for this access log message.

getPeerCertificateChain

@NotNull
public java.util.List<JSONCertificate> getPeerCertificateChain()

Retrieves the peer certificate chain for this log message.

Returns:

The peer certificate chain for this log message, or null if it is not included in the log message.

getPeerSubjectDN

@Nullable
public java.lang.String getPeerSubjectDN()

Retrieves the subject of the peer certificate.

Specified by:

getPeerSubjectDN in interface ClientCertificateAccessLogMessage

Returns:

The subject of the peer certificate, or null if it is not included in the log message.

getIssuerSubjectDNs

@NotNull
public java.util.List<java.lang.String> getIssuerSubjectDNs()

Retrieves the subject of the issuer certificate.

Specified by:

getIssuerSubjectDNs in interface ClientCertificateAccessLogMessage

Returns:

The subject of the issuer certificate, or an empty list if it is not included in the log message.

getAutoAuthenticatedAsDN

@Nullable
public java.lang.String getAutoAuthenticatedAsDN()

Retrieves the DN of the user that was automatically authenticated by the client certificate.

Specified by:

getAutoAuthenticatedAsDN in interface ClientCertificateAccessLogMessage

Returns:

The Dn of the user that was automatically authenticated by the client certificate, or null if it is not included in the log message.