|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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
@NotExtensible @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public class SearchRequestAccessLogMessage
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.
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 |
---|
public SearchRequestAccessLogMessage(java.lang.String s) throws LogException
s
- The string to be parsed as a search request access log message.
LogException
- If the provided string cannot be parsed as a valid
log message.public SearchRequestAccessLogMessage(LogMessage m)
m
- The log message to be parsed as a search request access log
message.Method Detail |
---|
public final java.lang.String getBaseDN()
null
if it is not
included in the log message.public final SearchScope getScope()
null
if it is not
included in the log message.public final java.lang.String getFilter()
null
if it is not included in the log message.public final Filter getParsedFilter()
null
if it is not included in the log message or the
filter string cannot be parsed as a filter.public final DereferencePolicy getDereferencePolicy()
null
if
it is not included in the log message or the value cannot be
parsed as a valid DereferencePolicy
value.public final java.lang.Integer getSizeLimit()
null
if it is
not included in the log message or the value cannot be parsed as
an integer.public final java.lang.Integer getTimeLimit()
null
if it is
not included in the log message or the value cannot be parsed as
an integer.public final java.lang.Boolean typesOnly()
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.public final java.util.List<java.lang.String> getRequestedAttributes()
null
if it is not included in the log message.public final AccessLogOperationType getOperationType()
getOperationType
in class OperationAccessLogMessage
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |