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

Class JSONSearchForwardFailedAccessLogMessage

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

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

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

All Implemented Interfaces:

AccessLogMessage, LogMessage, OperationForwardAccessLogMessage, OperationForwardFailedAccessLogMessage, OperationRequestAccessLogMessage, SearchForwardAccessLogMessage, SearchForwardFailedAccessLogMessage, SearchRequestAccessLogMessage, Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JSONSearchForwardFailedAccessLogMessage
extends JSONSearchForwardAccessLogMessage
implements SearchForwardFailedAccessLogMessage

This class provides a data structure that holds information about a JSON-formatted search forward failed 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
JSONSearchForwardFailedAccessLogMessage(JSONObject jsonObject)	Creates a new JSON search forward failed access log message from the provided JSON object.

Method Summary

Modifier and Type	Method	Description
String	getDiagnosticMessage()	Retrieves the diagnostic message received for the forwarded operation.
AccessLogMessageType	getMessageType()	Retrieves the message type for this access log message.
ResultCode	getResultCode()	Retrieves the result code received for the forwarded operation.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONSearchForwardAccessLogMessage

getTargetHost, getTargetPort, getTargetProtocol

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONSearchRequestAccessLogMessage

getBaseDN, getDereferencePolicy, getFilter, getOperationType, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONRequestAccessLogMessage

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, 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, 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.OperationForwardAccessLogMessage

getTargetHost, getTargetPort, getTargetProtocol

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage

getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.SearchRequestAccessLogMessage

getBaseDN, getDereferencePolicy, getFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimitSeconds, getTypesOnly

Constructor Details

JSONSearchForwardFailedAccessLogMessage

public JSONSearchForwardFailedAccessLogMessage(@NotNull
 JSONObject jsonObject)
                                        throws LogException

Creates a new JSON search forward failed 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 Details

getMessageType

@NotNull
public AccessLogMessageType getMessageType()

Retrieves the message type for this access log message.

Specified by:

getMessageType in interface AccessLogMessage

Overrides:

getMessageType in class JSONSearchForwardAccessLogMessage

Returns:

The message type for this access log message.

getResultCode

@Nullable
public ResultCode getResultCode()

Retrieves the result code received for the forwarded operation.

Specified by:

getResultCode in interface OperationForwardFailedAccessLogMessage

Returns:

The result code received for the forwarded operation, or null if it is not included in the log message.

getDiagnosticMessage

@Nullable
public String getDiagnosticMessage()

Retrieves the diagnostic message received for the forwarded operation.

Specified by:

getDiagnosticMessage in interface OperationForwardFailedAccessLogMessage

Returns:

The diagnostic message received for the forwarded operation, or null if it is not included in the log message.