|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00Entry
com.unboundid.ldap.sdk.experimental.DraftChuLDAPLogSchema00SearchEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DraftChuLDAPLogSchema00SearchEntry
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.
Field Summary | |
---|---|
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 | |
---|---|
DraftChuLDAPLogSchema00SearchEntry(Entry entry)
Creates a new instance of this search access log entry from the provided entry. |
Method Summary | |
---|---|
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 java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTR_DEREFERENCE_POLICY
public static final java.lang.String ATTR_ENTRIES_RETURNED
public static final java.lang.String ATTR_FILTER
public static final java.lang.String ATTR_REQUESTED_ATTRIBUTE
public static final java.lang.String ATTR_SCOPE
public static final java.lang.String ATTR_SIZE_LIMIT
public static final java.lang.String ATTR_TIME_LIMIT_SECONDS
public static final java.lang.String ATTR_TYPES_ONLY
Constructor Detail |
---|
public DraftChuLDAPLogSchema00SearchEntry(Entry entry) throws LDAPException
entry
- The entry used to create this search access log entry.
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 |
---|
public SearchScope getScope()
public DereferencePolicy getDereferencePolicy()
public boolean typesOnly()
public Filter getFilter()
null
if no filter was included in the access
log entry.public java.lang.Integer getRequestedSizeLimit()
null
if no size limit was
included in the access log entry.public java.lang.Integer getRequestedTimeLimitSeconds()
null
if no
time limit was included in the access log entry.public java.util.List<java.lang.String> getRequestedAttributes()
public java.lang.Integer getEntriesReturned()
null
if the number of entries returned was not included in
the access log entry.public SearchRequest toSearchRequest()
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.
SearchRequest
created from this search access log
entry.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |