Class SearchForwardFailedAccessLogMessage
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.SearchRequestAccessLogMessage
-
- com.unboundid.ldap.sdk.unboundidds.logs.SearchForwardFailedAccessLogMessage
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchForwardFailedAccessLogMessage extends SearchRequestAccessLogMessage
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search request that was forwarded to a backend server but did not complete successfully.
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 SearchForwardFailedAccessLogMessage(LogMessage m)
Creates a new search forward failed access log message from the provided log message.SearchForwardFailedAccessLogMessage(java.lang.String s)
Creates a new search 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.java.lang.Integer
getResultCode()
Retrieves the result code received for the forwarded operation.java.lang.String
getTargetHost()
Retrieves the address of the backend server to which the request has been forwarded.java.lang.Integer
getTargetPort()
Retrieves the port of the backend server to which the request has been forwarded.java.lang.String
getTargetProtocol()
Retrieves the protocol used to forward the request to the backend server.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.SearchRequestAccessLogMessage
getBaseDN, getDereferencePolicy, getFilter, getOperationType, getParsedFilter, getRequestedAttributes, getScope, getSizeLimit, getTimeLimit, typesOnly
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, getOperationPurpose, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, usingAdminSessionWorkerThread
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
getMessageID, getOperationID, getOrigin, getTriggeredByConnectionID, getTriggeredByOperationID
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
getConnectionID, getInstanceName, getProductName, getStartupID, parse
-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
getNamedValue, getNamedValueAsBoolean, getNamedValueAsDouble, getNamedValueAsInteger, getNamedValueAsLong, getNamedValues, getTimestamp, getUnnamedValues, hasUnnamedValue, toString
-
-
-
-
Constructor Detail
-
SearchForwardFailedAccessLogMessage
public SearchForwardFailedAccessLogMessage(@NotNull java.lang.String s) throws LogException
Creates a new search forward failed access log message from the provided message string.- Parameters:
s
- The string to be parsed as a search forward failed access log message.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
SearchForwardFailedAccessLogMessage
public SearchForwardFailedAccessLogMessage(@NotNull LogMessage m)
Creates a new search forward failed access log message from the provided log message.- Parameters:
m
- The log message to be parsed as a search forward failed access log message.
-
-
Method Detail
-
getTargetHost
@Nullable public java.lang.String getTargetHost()
Retrieves the address of the backend server to which the request has been forwarded.- Returns:
- The address of the backend server to which the request has been
forwarded, or
null
if it is not included in the log message.
-
getTargetPort
@Nullable public java.lang.Integer getTargetPort()
Retrieves the port of the backend server to which the request has been forwarded.- Returns:
- The port of the backend server to which the request has been
forwarded, or
null
if it is not included in the log message.
-
getTargetProtocol
@Nullable public java.lang.String getTargetProtocol()
Retrieves the protocol used to forward the request to the backend server.- Returns:
- The protocol used to forward the request to the backend server, or
null
if it is not included in the log message.
-
getResultCode
@Nullable public java.lang.Integer getResultCode()
Retrieves the result code received for the forwarded operation.- 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.- Returns:
- The diagnostic message received for the forwarded operation, or
null
if it is not included in the log message.
-
getMessageType
@NotNull public AccessLogMessageType getMessageType()
Retrieves the message type for this access log message.- Overrides:
getMessageType
in classOperationRequestAccessLogMessage
- Returns:
- The message type for this access log message.
-
-