|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.protocol.SearchRequestProtocolOp
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchRequestProtocolOp
This class provides an implementation of an LDAP search request protocol op.
Constructor Summary | |
---|---|
SearchRequestProtocolOp(SearchRequest request)
Creates a new search request protocol op from the provided search request object. |
|
SearchRequestProtocolOp(java.lang.String baseDN,
SearchScope scope,
DereferencePolicy derefPolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
Filter filter,
java.util.List<java.lang.String> attributes)
Creates a new search request protocol op with the provided information. |
Method Summary | |
---|---|
static SearchRequestProtocolOp |
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a search request protocol op. |
ASN1Element |
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message. |
java.util.List<java.lang.String> |
getAttributes()
Retrieves the set of requested attributes for this search request. |
java.lang.String |
getBaseDN()
Retrieves the base DN for this search request. |
DereferencePolicy |
getDerefPolicy()
Retrieves the policy to use for any aliases encountered during the search. |
Filter |
getFilter()
Retrieves the filter for this search request. |
byte |
getProtocolOpType()
Retrieves the BER type for this protocol op. |
SearchScope |
getScope()
Retrieves the scope for this search request. |
int |
getSizeLimit()
Retrieves the maximum number of entries that the server should return for the search. |
int |
getTimeLimit()
Retrieves the maximum length of time in seconds the server should spend processing the search. |
SearchRequest |
toSearchRequest(Control... controls)
Creates a search request from this protocol op. |
java.lang.String |
toString()
Retrieves a string representation of this protocol op. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer. |
boolean |
typesOnly()
Indicates whether the server should return only attribute types or both attribute types and values. |
void |
writeTo(ASN1Buffer buffer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchRequestProtocolOp(java.lang.String baseDN, SearchScope scope, DereferencePolicy derefPolicy, int sizeLimit, int timeLimit, boolean typesOnly, Filter filter, java.util.List<java.lang.String> attributes)
baseDN
- The base DN for this search request.scope
- The scope for this search request.derefPolicy
- The policy to use for aliases encountered during the
search.sizeLimit
- The maximum number of entries to return for the
search, or zero for no limit.timeLimit
- The maximum length of time to spend processing the
search, or zero for no limit.typesOnly
- Indicates whether to return only attribute types or
both types and values.filter
- The filter for this search request.attributes
- The names of attributes to include in matching
entries.public SearchRequestProtocolOp(SearchRequest request)
request
- The search request object to use to create this protocol
op.Method Detail |
---|
public java.lang.String getBaseDN()
public SearchScope getScope()
public DereferencePolicy getDerefPolicy()
public int getSizeLimit()
public int getTimeLimit()
public boolean typesOnly()
true
if the server should return only attribute types, or
false
if both types and values should be returned.public Filter getFilter()
public java.util.List<java.lang.String> getAttributes()
public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
public static SearchRequestProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.
LDAPException
- If the provided ASN.1 element cannot be decoded as
a search request protocol op.public void writeTo(ASN1Buffer buffer)
writeTo
in interface ProtocolOp
buffer
- The ASN.1 buffer to which the encoded representation should
be written.public SearchRequest toSearchRequest(Control... controls)
controls
- The set of controls to include in the search request.
It may be empty or null
if no controls should be
included.
public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |