com.unboundid.ldap.sdk.unboundidds.logs
Class SearchRequestAccessLogMessage

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.logs.LogMessage
      extended by com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessage
          extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationAccessLogMessage
              extended by com.unboundid.ldap.sdk.unboundidds.logs.OperationRequestAccessLogMessage
                  extended by 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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

See Also:
Serialized Form

Constructor Summary
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
 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
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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 valid DereferencePolicy 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, or null 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 class OperationAccessLogMessage
Returns:
The operation type for this access log message.