Class SearchReferenceAccessLogMessage
- 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.SearchReferenceAccessLogMessage
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchReferenceAccessLogMessage 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 result reference returned to a client.
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 SearchReferenceAccessLogMessage(LogMessage m)
Creates a new search result reference access log message from the provided log message.SearchReferenceAccessLogMessage(java.lang.String s)
Creates a new search result reference access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessLogMessageType
getMessageType()
Retrieves the message type for this access log message.java.util.List<java.lang.String>
getReferralURLs()
Retrieves the list of referral URLs returned to the client.java.util.List<java.lang.String>
getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.-
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
-
SearchReferenceAccessLogMessage
public SearchReferenceAccessLogMessage(@NotNull java.lang.String s) throws LogException
Creates a new search result reference access log message from the provided message string.- Parameters:
s
- The string to be parsed as a search result reference access log message.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
SearchReferenceAccessLogMessage
public SearchReferenceAccessLogMessage(@NotNull LogMessage m)
Creates a new search result reference access log message from the provided log message.- Parameters:
m
- The log message to be parsed as a search reference access log message.
-
-
Method Detail
-
getReferralURLs
@NotNull public java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs returned to the client.- Returns:
- The list of referral URLs returned to the client, or an empty list if it is not included in the log message.
-
getResponseControlOIDs
@NotNull public java.util.List<java.lang.String> getResponseControlOIDs()
Retrieves the OIDs of any response controls contained in the log message.- Returns:
- The OIDs of any response controls contained in the log message, or an empty list 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.
-
-