Interface SearchRequestAccessLogMessage
-
- All Superinterfaces:
AccessLogMessage
,LogMessage
,OperationRequestAccessLogMessage
,java.io.Serializable
- All Known Subinterfaces:
SearchEntryAccessLogMessage
,SearchForwardAccessLogMessage
,SearchForwardFailedAccessLogMessage
,SearchReferenceAccessLogMessage
,SearchResultAccessLogMessage
- All Known Implementing Classes:
JSONSearchEntryAccessLogMessage
,JSONSearchForwardAccessLogMessage
,JSONSearchForwardFailedAccessLogMessage
,JSONSearchReferenceAccessLogMessage
,JSONSearchRequestAccessLogMessage
,JSONSearchResultAccessLogMessage
,TextFormattedSearchEntryAccessLogMessage
,TextFormattedSearchForwardAccessLogMessage
,TextFormattedSearchForwardFailedAccessLogMessage
,TextFormattedSearchReferenceAccessLogMessage
,TextFormattedSearchRequestAccessLogMessage
,TextFormattedSearchResultAccessLogMessage
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public interface SearchRequestAccessLogMessage extends OperationRequestAccessLogMessage
This class provides a data structure that holds information about a search request access log message.
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.
-
-
Method Summary
All Methods Instance Methods Abstract 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.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
getTimeLimitSeconds()
Retrieves the time limit for the search request, in seconds.java.lang.Boolean
getTypesOnly()
Retrieves the typesOnly value for the search request.-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage
getConnectionID, getInstanceName, getMessageType, getProductName, getStartupID, getThreadID
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogMessage
getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString
-
Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.OperationRequestAccessLogMessage
getAdministrativeOperationMessage, getMessageID, getOperationID, getOperationType, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread
-
-
-
-
Method Detail
-
getBaseDN
@Nullable 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
@Nullable 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
@Nullable 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.
-
getDereferencePolicy
@Nullable 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
@Nullable 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.
-
getTimeLimitSeconds
@Nullable java.lang.Integer getTimeLimitSeconds()
Retrieves the time limit for the search request, in seconds.- 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.
-
getTypesOnly
@Nullable java.lang.Boolean getTypesOnly()
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
@NotNull 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.
-
-