Class SearchRequestAccessLogMessage
- 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
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
SearchEntryAccessLogMessage
,SearchForwardAccessLogMessage
,SearchForwardFailedAccessLogMessage
,SearchReferenceAccessLogMessage
,SearchResultAccessLogMessage
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class SearchRequestAccessLogMessage extends OperationRequestAccessLogMessage
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 received from 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 SearchRequestAccessLogMessage(LogMessage m)
Creates a new search request access log message from the provided log message.SearchRequestAccessLogMessage(java.lang.String s)
Creates a new search request access log message from the provided message string.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getBaseDN()
Retrieves the base DN for the search request.DereferencePolicy
getDereferencePolicy()
Retrieves the dereference policy for the search request.java.lang.String
getFilter()
Retrieves a string representation of the filter for the search request.AccessLogOperationType
getOperationType()
Retrieves the operation type for the associated operation.Filter
getParsedFilter()
Retrieves a parsed representation of the filter for the search request.java.util.List<java.lang.String>
getRequestedAttributes()
Retrieves the list of requested attributes for the search request.SearchScope
getScope()
Retrieves the scope for the search request.java.lang.Integer
getSizeLimit()
Retrieves the size limit for the search request.java.lang.Integer
getTimeLimit()
Retrieves the time limit for the search request.java.lang.Boolean
typesOnly()
Retrieves the typesOnly value for the search request.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
getIntermediateClientRequest, getMessageType, 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
-
SearchRequestAccessLogMessage
public SearchRequestAccessLogMessage(java.lang.String s) throws LogException
Creates a new search request access log message from the provided message string.- Parameters:
s
- The string to be parsed as a search request access log message.- Throws:
LogException
- If the provided string cannot be parsed as a valid log message.
-
SearchRequestAccessLogMessage
public SearchRequestAccessLogMessage(LogMessage m)
Creates a new search request access log message from the provided log message.- Parameters:
m
- The log message to be parsed as a search request access log message.
-
-
Method Detail
-
getBaseDN
public final java.lang.String getBaseDN()
Retrieves the base DN for the search request.- Returns:
- The base DN for the search request, or
null
if it is not included in the log message.
-
getScope
public final SearchScope getScope()
Retrieves the scope for the search request.- Returns:
- The scope for the search request, or
null
if it is not included in the log message.
-
getFilter
public final java.lang.String getFilter()
Retrieves a string representation of the filter for the search request.- Returns:
- A string representation of the filter for the search request, or
null
if it is not included in the log message.
-
getParsedFilter
public final Filter getParsedFilter()
Retrieves a parsed representation of the filter for the search request.- Returns:
- A parsed representation of the filter for the search request, or
null
if it is not included in the log message or the filter string cannot be parsed as a filter.
-
getDereferencePolicy
public final DereferencePolicy getDereferencePolicy()
Retrieves the dereference policy for the search request.- Returns:
- The dereference policy for the search request, or
null
if it is not included in the log message or the value cannot be parsed as a validDereferencePolicy
value.
-
getSizeLimit
public final java.lang.Integer getSizeLimit()
Retrieves the size limit for the search request.- Returns:
- The size limit for the search request, or
null
if it is not included in the log message or the value cannot be parsed as an integer.
-
getTimeLimit
public final java.lang.Integer getTimeLimit()
Retrieves the time limit for the search request.- Returns:
- The time limit for the search request, or
null
if it is not included in the log message or the value cannot be parsed as an integer.
-
typesOnly
public final java.lang.Boolean typesOnly()
Retrieves the typesOnly value for the search request.- Returns:
true
if only attribute type names should be included in entries that are returned,false
if both attribute types and values should be returned, ornull
if is not included in the log message or cannot be parsed as a Boolean.
-
getRequestedAttributes
public final java.util.List<java.lang.String> getRequestedAttributes()
Retrieves the list of requested attributes for the search request.- Returns:
- The list of requested attributes for the search request, an empty
list if the client did not explicitly request any attributes, or
null
if it is not included in the log message.
-
getOperationType
public final AccessLogOperationType getOperationType()
Retrieves the operation type for the associated operation.- Specified by:
getOperationType
in classOperationAccessLogMessage
- Returns:
- The operation type for this access log message.
-
-