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

Class TextFormattedSecurityNegotiationAccessLogMessage

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

All Implemented Interfaces:

AccessLogMessage, LogMessage, SecurityNegotiationAccessLogMessage, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class TextFormattedSecurityNegotiationAccessLogMessage
extends TextFormattedAccessLogMessage
implements SecurityNegotiationAccessLogMessage

This class provides a data structure that holds information about a text-formatted security negotiation 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
TextFormattedSecurityNegotiationAccessLogMessage(java.lang.String logMessageString) Creates a new text-formatted security negotiation access log message from the provided message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCipher() Retrieves the name of the cipher suite that was negotiated.
AccessLogMessageType	getMessageType() Retrieves the message type for this access log message.
java.lang.String	getProtocol() Retrieves the name of the security protocol that was negotiated.

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

TextFormattedSecurityNegotiationAccessLogMessage

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

Creates a new text-formatted security negotiation access log message from the provided message.

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.

getProtocol

@Nullable
public java.lang.String getProtocol()

Retrieves the name of the security protocol that was negotiated.

Specified by:

getProtocol in interface SecurityNegotiationAccessLogMessage

Returns:

The name of the security protocol that was negotiated.

getCipher

@Nullable
public java.lang.String getCipher()

Retrieves the name of the cipher suite that was negotiated.

Specified by:

getCipher in interface SecurityNegotiationAccessLogMessage

Returns:

The name of the cipher suite that was negotiated.