Class TextFormattedAbandonForwardFailedAccessLogMessage
- 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.TextFormattedRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAbandonRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAbandonForwardAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAbandonForwardFailedAccessLogMessage
-
- All Implemented Interfaces:
AbandonForwardAccessLogMessage
,AbandonForwardFailedAccessLogMessage
,AbandonRequestAccessLogMessage
,AccessLogMessage
,LogMessage
,OperationForwardAccessLogMessage
,OperationForwardFailedAccessLogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TextFormattedAbandonForwardFailedAccessLogMessage extends TextFormattedAbandonForwardAccessLogMessage implements AbandonForwardFailedAccessLogMessage
This class provides a data structure that holds information about a text-formatted abandon 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
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage
NO_FIELD_NAME
-
-
Constructor Summary
Constructors Constructor Description TextFormattedAbandonForwardFailedAccessLogMessage(TextFormattedLogMessage logMessage)
Creates a new text-formatted abandon forward failed access log message from the provided message.TextFormattedAbandonForwardFailedAccessLogMessage(java.lang.String logMessageString)
Creates a new text-formatted abandon forward failed access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.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.text.TextFormattedAbandonForwardAccessLogMessage
getTargetHost, getTargetPort, getTargetProtocol
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAbandonRequestAccessLogMessage
getMessageIDToAbandon, getOperationType
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage
getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
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.AbandonRequestAccessLogMessage
getMessageIDToAbandon
-
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
-
-
-
-
Constructor Detail
-
TextFormattedAbandonForwardFailedAccessLogMessage
public TextFormattedAbandonForwardFailedAccessLogMessage(@NotNull java.lang.String logMessageString) throws LogException
Creates a new text-formatted abandon forward failed access log message from the provided message string.- Parameters:
logMessageString
- The string representation of this log message. It must not benull
.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
TextFormattedAbandonForwardFailedAccessLogMessage
public TextFormattedAbandonForwardFailedAccessLogMessage(@NotNull TextFormattedLogMessage logMessage) throws LogException
Creates a new text-formatted abandon forward failed access log message from the provided message.- Parameters:
logMessage
- The log message to use to create this abandon forward failed access log message. It must not benull
.- 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 interfaceAccessLogMessage
- Overrides:
getMessageType
in classTextFormattedAbandonForwardAccessLogMessage
- 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 interfaceOperationForwardFailedAccessLogMessage
- Returns:
- The result code received for the forwarded operation, or
null
if it is not included in the log message.
-
getDiagnosticMessage
@Nullable public java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message received for the forwarded operation.- Specified by:
getDiagnosticMessage
in interfaceOperationForwardFailedAccessLogMessage
- Returns:
- The diagnostic message received for the forwarded operation, or
null
if it is not included in the log message.
-
-