Package com.unboundid.ldap.sdk.unboundidds.logs.v2.text

Class TextFormattedSearchRequestAccessLogMessage

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage

com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedSearchRequestAccessLogMessage

All Implemented Interfaces:

AccessLogMessage, LogMessage, OperationRequestAccessLogMessage, SearchRequestAccessLogMessage, java.io.Serializable

Direct Known Subclasses:

TextFormattedSearchEntryAccessLogMessage, TextFormattedSearchForwardAccessLogMessage, TextFormattedSearchReferenceAccessLogMessage, TextFormattedSearchResultAccessLogMessage

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class TextFormattedSearchRequestAccessLogMessage
extends TextFormattedRequestAccessLogMessage
implements SearchRequestAccessLogMessage

This class provides a data structure that holds information about a text-formatted 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.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

NO_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
TextFormattedSearchRequestAccessLogMessage(java.lang.String logMessageString)	Creates a new text-formatted search request access log message from the provided message string.

Method Summary

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.
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 class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedRequestAccessLogMessage

getAdministrativeOperationMessage, getIntermediateClientRequestControl, getMessageID, getMessageType, getOperationID, getOperationPurposeRequestControl, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedAccessLogMessage

getConnectionID, getInstanceName, getProductName, getStartupID, getThreadID

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.logs.v2.text.TextFormattedLogMessage

getBoolean, getDouble, getFields, getGeneralizedTime, getInteger, getLong, getRFC3339Timestamp, getString, getTimestamp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getOrigin, getRequestControlOIDs, getRequesterDN, getRequesterIPAddress, getTriggeredByConnectionID, getTriggeredByOperationID, getUsingAdminSessionWorkerThread

Constructor Detail

TextFormattedSearchRequestAccessLogMessage

public TextFormattedSearchRequestAccessLogMessage(@NotNull
                                                  java.lang.String logMessageString)
                                           throws LogException

Creates a new text-formatted search request access log message from the provided message string.

Parameters:

logMessageString - The string representation of this log message. It must not be null.

Throws:

LogException - If the provided string cannot be parsed as a valid log message.

Method Detail

getOperationType

@NotNull
public final AccessLogOperationType getOperationType()

Retrieves the operation type for the associated operation.

Specified by:

getOperationType in interface OperationRequestAccessLogMessage

Returns:

The operation type for this access log message.

getBaseDN

@Nullable
public final java.lang.String getBaseDN()

Retrieves the base DN for the search request.

Specified by:

getBaseDN in interface SearchRequestAccessLogMessage

Returns:

The base DN for the search request, or null if it is not included in the log message.

getScope

@Nullable
public final SearchScope getScope()

Retrieves the scope for the search request.

Specified by:

getScope in interface SearchRequestAccessLogMessage

Returns:

The scope for the search request, or null if it is not included in the log message.

getFilter

@Nullable
public final java.lang.String getFilter()

Retrieves a string representation of the filter for the search request.

Specified by:

getFilter in interface SearchRequestAccessLogMessage

Returns:

A string representation of the filter for the search request, or null if it is not included in the log message.

getDereferencePolicy

@Nullable
public final DereferencePolicy getDereferencePolicy()

Retrieves the dereference policy for the search request.

Specified by:

getDereferencePolicy in interface SearchRequestAccessLogMessage

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

@Nullable
public final java.lang.Integer getSizeLimit()

Retrieves the size limit for the search request.

Specified by:

getSizeLimit in interface SearchRequestAccessLogMessage

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
public final java.lang.Integer getTimeLimitSeconds()

Retrieves the time limit for the search request, in seconds.

Specified by:

getTimeLimitSeconds in interface SearchRequestAccessLogMessage

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
public final java.lang.Boolean getTypesOnly()

Retrieves the typesOnly value for the search request.

Specified by:

getTypesOnly in interface SearchRequestAccessLogMessage

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

@NotNull
public final java.util.List<java.lang.String> getRequestedAttributes()

Retrieves the list of requested attributes for the search request.

Specified by:

getRequestedAttributes in interface SearchRequestAccessLogMessage

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.