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

Class TextFormattedClientCertificateAccessLogMessage

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

All Implemented Interfaces:

AccessLogMessage, ClientCertificateAccessLogMessage, LogMessage, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TextFormattedClientCertificateAccessLogMessage
extends TextFormattedAccessLogMessage
implements ClientCertificateAccessLogMessage

This class provides a data structure that holds information about a text-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

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

NO_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
TextFormattedClientCertificateAccessLogMessage(java.lang.String logMessageString) Creates a new text-formatted client certificate access log message from the provided message string.

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.lang.String	getPeerSubjectDN() Retrieves the subject of the peer certificate.

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

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

Constructor Detail

TextFormattedClientCertificateAccessLogMessage

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

Creates a new text-formatted client certificate 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

Returns:

The message type for this access 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.