Class JSONExtendedRequestAccessLogMessage
- 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.JSONExtendedRequestAccessLogMessage
-
- All Implemented Interfaces:
AccessLogMessage
,ExtendedRequestAccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
- Direct Known Subclasses:
JSONExtendedForwardAccessLogMessage
,JSONExtendedResultAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class JSONExtendedRequestAccessLogMessage extends JSONRequestAccessLogMessage implements ExtendedRequestAccessLogMessage
This class provides a data structure that holds information about a JSON-formatted extended 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 JSONExtendedRequestAccessLogMessage(JSONObject jsonObject)
Creates a new JSON extended request access log message from the provided JSON object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessLogOperationType
getOperationType()
Retrieves the operation type for the associated operation.java.lang.String
getRequestOID()
Retrieves the OID of the extended request.java.lang.String
getRequestType()
Retrieves the type of extended operation being processed.-
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
-
JSONExtendedRequestAccessLogMessage
public JSONExtendedRequestAccessLogMessage(@NotNull JSONObject jsonObject) throws LogException
Creates a new JSON extended 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.
-
getRequestOID
@Nullable public final java.lang.String getRequestOID()
Retrieves the OID of the extended request.- Specified by:
getRequestOID
in interfaceExtendedRequestAccessLogMessage
- Returns:
- The OID of the extended request, or
null
if it is not included in the log message.
-
getRequestType
@Nullable public final java.lang.String getRequestType()
Retrieves the type of extended operation being processed. This is generally a human-readable name for the operation.- Specified by:
getRequestType
in interfaceExtendedRequestAccessLogMessage
- Returns:
- The type of extended operation, or
null
if it is not included in the log message.
-
-