|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.protocols.ldap.ProtocolOp
org.opends.server.protocols.ldap.SearchRequestProtocolOp
public class SearchRequestProtocolOp
This class defines the structures and methods for an LDAP search request protocol op, which is used to locate entries based on a set of criteria.
Constructor Summary | |
---|---|
SearchRequestProtocolOp(ASN1OctetString baseDN,
SearchScope scope,
DereferencePolicy dereferencePolicy,
int sizeLimit,
int timeLimit,
boolean typesOnly,
LDAPFilter filter,
java.util.LinkedHashSet<java.lang.String> attributes)
Creates a new search request protocol op with the provided information. |
Method Summary | |
---|---|
static SearchRequestProtocolOp |
decodeSearchRequest(ASN1Element element)
Decodes the provided ASN.1 element as an LDAP search request protocol op. |
ASN1Element |
encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message. |
java.util.LinkedHashSet<java.lang.String> |
getAttributes()
Retrieves the set of requested attributes for this search request. |
ASN1OctetString |
getBaseDN()
Retrieves the base DN for this search request. |
DereferencePolicy |
getDereferencePolicy()
Retrieves the alias dereferencing policy for this search request. |
LDAPFilter |
getFilter()
Retrieves the filter for this search request. |
java.lang.String |
getProtocolOpName()
Retrieves the name for this protocol op type. |
SearchScope |
getScope()
Retrieves the scope for this search request. |
int |
getSizeLimit()
Retrieves the size limit for this search request. |
int |
getTimeLimit()
Retrieves the time limit for this search request. |
byte |
getType()
Retrieves the BER type for this protocol op. |
boolean |
getTypesOnly()
Retrieves the value of the typesOnly flag for this search request. |
void |
setAttributes(java.util.LinkedHashSet<java.lang.String> attributes)
Specifies the set of requested attributes for this search request. |
void |
setBaseDN(ASN1OctetString baseDN)
Specifies the base DN for this search request. |
void |
setDereferencePolicy(DereferencePolicy dereferencePolicy)
Specifies the alias dereferencing policy for this search request. |
void |
setFilter(LDAPFilter filter)
Specifies the filter for this search request. |
void |
setScope(SearchScope scope)
Specifies the scope for this search request. |
void |
setSizeLimit(int sizeLimit)
Specifies the size limit for this search request. |
void |
setTimeLimit(int timeLimit)
Specifies the time limit for this search request. |
void |
setTypesOnly(boolean typesOnly)
Specifies the value of the typesOnly flag for this search request. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer. |
void |
toString(java.lang.StringBuilder buffer,
int indent)
Appends a multi-line string representation of this LDAP protocol op to the provided buffer. |
Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp |
---|
decode, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchRequestProtocolOp(ASN1OctetString baseDN, SearchScope scope, DereferencePolicy dereferencePolicy, int sizeLimit, int timeLimit, boolean typesOnly, LDAPFilter filter, java.util.LinkedHashSet<java.lang.String> attributes)
baseDN
- The base DN for this search request.scope
- The scope for this search request.dereferencePolicy
- The alias dereferencing policy for this search
request.sizeLimit
- The size limit for this search request.timeLimit
- The time limit for this search request.typesOnly
- The typesOnly flag for this search request.filter
- The filter for this search request.attributes
- The set of requested attributes for this search
request.Method Detail |
---|
public ASN1OctetString getBaseDN()
public void setBaseDN(ASN1OctetString baseDN)
baseDN
- The base DN for this search request.public SearchScope getScope()
public void setScope(SearchScope scope)
scope
- The scope for this search request.public DereferencePolicy getDereferencePolicy()
public void setDereferencePolicy(DereferencePolicy dereferencePolicy)
dereferencePolicy
- The alias dereferencing policy for this search
request.public int getSizeLimit()
public void setSizeLimit(int sizeLimit)
sizeLimit
- The size limit for this search request.public int getTimeLimit()
public void setTimeLimit(int timeLimit)
timeLimit
- The time limit for this search request.public boolean getTypesOnly()
public void setTypesOnly(boolean typesOnly)
typesOnly
- The value of the typesOnly flag for this search request.public LDAPFilter getFilter()
public void setFilter(LDAPFilter filter)
filter
- The filter for this search request.public java.util.LinkedHashSet<java.lang.String> getAttributes()
public void setAttributes(java.util.LinkedHashSet<java.lang.String> attributes)
attributes
- The set of requested attributes for this search
request.public byte getType()
getType
in class ProtocolOp
public java.lang.String getProtocolOpName()
getProtocolOpName
in class ProtocolOp
public ASN1Element encode()
encode
in class ProtocolOp
public static SearchRequestProtocolOp decodeSearchRequest(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If a problem occurs while decoding the provided
ASN.1 element as an LDAP search request protocol
op.public void toString(java.lang.StringBuilder buffer)
toString
in class ProtocolOp
buffer
- The buffer to which the string should be appended.public void toString(java.lang.StringBuilder buffer, int indent)
toString
in class ProtocolOp
buffer
- The buffer to which the information should be appended.indent
- The number of spaces from the margin that the lines should
be indented.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |