com.unboundid.ldap.sdk.experimental

Class DraftChuLDAPLogSchema00SearchEntry

java.lang.Object

com.unboundid.ldap.sdk.Entry

com.unboundid.ldap.sdk.ReadOnlyEntry

com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00Entry

com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00SearchEntry

All Implemented Interfaces:

LDIFRecord, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DraftChuLDAPLogSchema00SearchEntry
extends DraftChuLDAPLogSchema00Entry

This class represents an entry that holds information about a search operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_DEREFERENCE_POLICY The name of the attribute used to hold the alias dereference policy.
static java.lang.String	ATTR_ENTRIES_RETURNED The name of the attribute used to hold the number of entries returned.
static java.lang.String	ATTR_FILTER The name of the attribute used to hold the search filter.
static java.lang.String	ATTR_REQUESTED_ATTRIBUTE The name of the attribute used to hold a requested attribute.
static java.lang.String	ATTR_SCOPE The name of the attribute used to hold the search scope.
static java.lang.String	ATTR_SIZE_LIMIT The name of the attribute used to hold the requested size limit.
static java.lang.String	ATTR_TIME_LIMIT_SECONDS The name of the attribute used to hold the requested time limit in seconds.
static java.lang.String	ATTR_TYPES_ONLY The name of the attribute used to hold the value of the typesOnly flag.

Fields inherited from class com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00Entry

ATTR_AUTHORIZATION_IDENTITY_DN, ATTR_DIAGNOSTIC_MESSAGE, ATTR_OPERATION_TYPE, ATTR_PROCESSING_END_TIME, ATTR_PROCESSING_START_TIME, ATTR_REFERRAL_URL, ATTR_REQUEST_CONTROL, ATTR_RESPONSE_CONTROL, ATTR_RESULT_CODE, ATTR_SESSION_ID, ATTR_TARGET_ENTRY_DN

Constructor Summary

Constructors

Constructor and Description
DraftChuLDAPLogSchema00SearchEntry(Entry entry) Creates a new instance of this search access log entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
DereferencePolicy	getDereferencePolicy() Retrieves the alias dereference policy for the search request described by this search access log entry.
java.lang.Integer	getEntriesReturned() Retrieves the number of entries returned to the client in response to the search request described by this search access log entry, if available.
Filter	getFilter() Retrieves the filter for the search request described by this search access log entry, if available.
java.util.List<java.lang.String>	getRequestedAttributes() Retrieves the requested attributes for the search request described by this search access log entry, if available.
java.lang.Integer	getRequestedSizeLimit() Retrieves the requested size limit for the search request described by this search access log entry, if available.
java.lang.Integer	getRequestedTimeLimitSeconds() Retrieves the requested time limit (in seconds) for the search request described by this search access log entry, if available.
SearchScope	getScope() Retrieves the scope for the search request described by this search access log entry.
SearchRequest	toSearchRequest() Retrieves a SearchRequest created from this search access log entry.
boolean	typesOnly() Retrieves the value of the typesOnly flag for the search request described by this search access log entry.

Methods inherited from class com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00Entry

decode, getAuthorizationIdentityDN, getDiagnosticMessage, getOperationType, getProcessingEndTimeDate, getProcessingEndTimeString, getProcessingStartTimeDate, getProcessingStartTimeString, getReferralURLs, getRequestControls, getResponseControls, getResultCode, getSessionID, getTargetEntryDN, toLDAPResult

Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN

Methods inherited from class com.unboundid.ldap.sdk.Entry

addAttribute, applyModifications, applyModifications, applyModifyDN, applyModifyDN, diff, diff, diff, duplicate, equals, getAttribute, getAttribute, getAttributes, getAttributesWithOptions, getAttributeValue, getAttributeValueAsBoolean, getAttributeValueAsDate, getAttributeValueAsDN, getAttributeValueAsInteger, getAttributeValueAsLong, getAttributeValueByteArrays, getAttributeValueBytes, getAttributeValues, getDN, getObjectClassAttribute, getObjectClassValues, getParentDN, getParentDNString, getParsedDN, getRDN, getSchema, hasAttribute, hasAttribute, hasAttribute, hasAttributeValue, hasAttributeValue, hasAttributeValue, hasAttributeValue, hashCode, hasObjectClass, intersectEntries, matchesBaseAndScope, matchesBaseAndScope, mergeEntries, removeAttributeValue, removeAttributeValue, setAttribute, toLDIF, toLDIF, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toLDIFString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTR_DEREFERENCE_POLICY

@NotNull
public static final java.lang.String ATTR_DEREFERENCE_POLICY

The name of the attribute used to hold the alias dereference policy.

See Also:

Constant Field Values

ATTR_ENTRIES_RETURNED

@NotNull
public static final java.lang.String ATTR_ENTRIES_RETURNED

The name of the attribute used to hold the number of entries returned.

See Also:

Constant Field Values

ATTR_FILTER

@NotNull
public static final java.lang.String ATTR_FILTER

The name of the attribute used to hold the search filter.

See Also:

Constant Field Values

ATTR_REQUESTED_ATTRIBUTE

@NotNull
public static final java.lang.String ATTR_REQUESTED_ATTRIBUTE

The name of the attribute used to hold a requested attribute.

See Also:

Constant Field Values

ATTR_SCOPE

@NotNull
public static final java.lang.String ATTR_SCOPE

The name of the attribute used to hold the search scope.

See Also:

Constant Field Values

ATTR_SIZE_LIMIT

@NotNull
public static final java.lang.String ATTR_SIZE_LIMIT

The name of the attribute used to hold the requested size limit.

See Also:

Constant Field Values

ATTR_TIME_LIMIT_SECONDS

@NotNull
public static final java.lang.String ATTR_TIME_LIMIT_SECONDS

The name of the attribute used to hold the requested time limit in seconds.

See Also:

Constant Field Values

ATTR_TYPES_ONLY

@NotNull
public static final java.lang.String ATTR_TYPES_ONLY

The name of the attribute used to hold the value of the typesOnly flag.

See Also:

Constant Field Values

Constructor Detail

DraftChuLDAPLogSchema00SearchEntry

public DraftChuLDAPLogSchema00SearchEntry(@NotNull
                                          Entry entry)
                                   throws LDAPException

Creates a new instance of this search access log entry from the provided entry.

Parameters:

entry - The entry used to create this search access log entry.

Throws:

LDAPException - If the provided entry cannot be decoded as a valid search access log entry as per the specification contained in draft-chu-ldap-logschema-00.

Method Detail

getScope

@NotNull
public SearchScope getScope()

Retrieves the scope for the search request described by this search access log entry.

Returns:

The scope for the search request described by this search access log entry.

getDereferencePolicy

@NotNull
public DereferencePolicy getDereferencePolicy()

Retrieves the alias dereference policy for the search request described by this search access log entry.

Returns:

The alias dereference policy for the search request described by this search access log entry.

typesOnly

public boolean typesOnly()

Retrieves the value of the typesOnly flag for the search request described by this search access log entry.

Returns:

The value of the typesOnly flag for the search request described by this search access log entry.

getFilter

@Nullable
public Filter getFilter()

Retrieves the filter for the search request described by this search access log entry, if available.

Returns:

The filter for the search request described by this search access log entry, or null if no filter was included in the access log entry.

getRequestedSizeLimit

@Nullable
public java.lang.Integer getRequestedSizeLimit()

Retrieves the requested size limit for the search request described by this search access log entry, if available.

Returns:

The requested size limit for the search request described by this search access log entry, or null if no size limit was included in the access log entry.

getRequestedTimeLimitSeconds

@Nullable
public java.lang.Integer getRequestedTimeLimitSeconds()

Retrieves the requested time limit (in seconds) for the search request described by this search access log entry, if available.

Returns:

The requested time limit (in seconds) for the search request described by this search access log entry, or null if no time limit was included in the access log entry.

getRequestedAttributes

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

Retrieves the requested attributes for the search request described by this search access log entry, if available.

Returns:

The requested attributes for the search request described by this search access log entry, or an empty list if no requested attributes were included in the access log entry.

getEntriesReturned

@Nullable
public java.lang.Integer getEntriesReturned()

Retrieves the number of entries returned to the client in response to the search request described by this search access log entry, if available.

Returns:

The number of entries returned to the client in response to the search request described by this search access log entry, or null if the number of entries returned was not included in the access log entry.

toSearchRequest

@NotNull
public SearchRequest toSearchRequest()

Retrieves a SearchRequest created from this search access log entry. If the size limit or time limit was not present in the entry, a default of zero will be used. If the filter was not present in the entry, a default of "(objectClass=*)" will be used.

Returns:

The SearchRequest created from this search access log entry.