Class JSONBindRequestAccessLogMessage
- 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.JSONBindRequestAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,BindRequestAccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
- Direct Known Subclasses:
JSONBindForwardAccessLogMessage
,JSONBindResultAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class JSONBindRequestAccessLogMessage extends JSONRequestAccessLogMessage implements BindRequestAccessLogMessage
This class provides a data structure that holds information about a JSON-formatted bind request 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 JSONBindRequestAccessLogMessage(JSONObject jsonObject)
Creates a new JSON bind request access log message from the provided JSON object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BindRequestAuthenticationType
getAuthenticationType()
Retrieves the type of authentication requested by the client.java.lang.String
getDN()
Retrieves the DN of the user attempting to bind.AccessLogOperationType
getOperationType()
Retrieves the operation type for the associated operation.java.lang.String
getProtocolVersion()
Retrieves the protocol version for the bind request.java.lang.String
getSASLMechanismName()
Retrieves the name of the requested SASL mechanism.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getMessageType, 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, getMessageType, 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
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
-
-
-
Constructor Detail
-
JSONBindRequestAccessLogMessage
public JSONBindRequestAccessLogMessage(@NotNull JSONObject jsonObject) throws LogException
Creates a new JSON bind request 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
-
getOperationType
@NotNull public final AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.- Specified by:
getOperationType
in interfaceOperationRequestAccessLogMessage
- Returns:
- The operation type for this access log message.
-
getAuthenticationType
@Nullable public final BindRequestAuthenticationType getAuthenticationType()
Retrieves the type of authentication requested by the client.- Specified by:
getAuthenticationType
in interfaceBindRequestAccessLogMessage
- Returns:
- The type of authentication requested by the client, or
null
if it is not included in the log message.
-
getDN
@Nullable public final java.lang.String getDN()
Retrieves the DN of the user attempting to bind. This value may not be useful for authentication types other than "SIMPLE".- Specified by:
getDN
in interfaceBindRequestAccessLogMessage
- Returns:
- The DN of the user attempting to bind, or
null
if it is not included in the log message.
-
getProtocolVersion
@Nullable public final java.lang.String getProtocolVersion()
Retrieves the protocol version for the bind request.- Specified by:
getProtocolVersion
in interfaceBindRequestAccessLogMessage
- Returns:
- The protocol version for the bind request, or
null
if it is not included in the log message.
-
getSASLMechanismName
@Nullable public final java.lang.String getSASLMechanismName()
Retrieves the name of the requested SASL mechanism. This should only be included for SASL bind attempts.- Specified by:
getSASLMechanismName
in interfaceBindRequestAccessLogMessage
- Returns:
- The name of the requested SASL mechanism, or
null
if it is not included in the log message.
-
-