|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.asn1.Asn1Object
org.apache.directory.shared.ldap.codec.LdapMessage
org.apache.directory.shared.ldap.codec.search.SearchRequest
A SearchRequest ldapObject. It's a sub-class of Asn1Object, and it implements the ldapObject class to be seen as a member of the LdapMessage CHOICE.
Field Summary |
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object |
parent |
Constructor Summary | |
SearchRequest()
Creates a new SearchRequest object. |
Method Summary | |
void |
addAttribute(LdapString attribute)
Add an attribute to the attributes list. |
int |
computeLength()
Compute the SearchRequest length SearchRequest : 0x63 L1 | +--> 0x04 L2 baseObject +--> 0x0A 0x01 scope +--> 0x0A 0x01 derefAliases +--> 0x02 0x0(1..4) sizeLimit +--> 0x02 0x0(1..4) timeLimit +--> 0x01 0x01 typesOnly +--> filter.computeLength() +--> 0x30 L3 (Attribute description list) | +--> 0x04 L4-1 Attribute description +--> 0x04 L4-2 Attribute description +--> ... |
java.nio.ByteBuffer |
encode(java.nio.ByteBuffer buffer)
Encode the SearchRequest message to a PDU. |
javax.naming.directory.Attributes |
getAttributes()
Get the list of attributes |
java.lang.String |
getBaseObject()
Get the base object |
Filter |
getCurrentFilter()
Get the current dilter |
int |
getDerefAliases()
Get the derefAliases flag |
Filter |
getFilter()
Get the filter |
int |
getMessageType()
Get the message type |
int |
getScope()
Get the search scope |
int |
getSizeLimit()
Get the size limit |
int |
getTimeLimit()
Get the time limit |
boolean |
isTypesOnly()
Get the typesOnly flag |
void |
setBaseObject(javax.naming.Name baseObject)
Set the base object |
void |
setCurrentFilter(Filter currentFilter)
Set the current dilter |
void |
setDerefAliases(int derefAliases)
Set the derefAliases flag |
void |
setFilter(Filter filter)
Set the filter |
void |
setScope(int scope)
Set the search scope |
void |
setSizeLimit(int sizeLimit)
Set the size limit |
void |
setTimeLimit(int timeLimit)
Set the time limit |
void |
setTypesOnly(boolean typesOnly)
Set the typesOnly flag |
java.lang.String |
toString()
Return a string the represent a SearchRequest |
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessage |
addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControl, setMessageId, setProtocolOP |
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object |
addLength, getCurrentLength, getExpectedLength, getParent, setCurrentLength, setExpectedLength, setParent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public SearchRequest()
Method Detail |
public int getMessageType()
getMessageType
in class LdapMessage
public javax.naming.directory.Attributes getAttributes()
public void addAttribute(LdapString attribute)
attribute
- The attribute to add to the listpublic java.lang.String getBaseObject()
public void setBaseObject(javax.naming.Name baseObject)
baseObject
- The baseObject to set.public int getDerefAliases()
public void setDerefAliases(int derefAliases)
derefAliases
- The derefAliases to set.public Filter getFilter()
public void setFilter(Filter filter)
filter
- The filter to set.public int getScope()
public void setScope(int scope)
scope
- The scope to set.public int getSizeLimit()
public void setSizeLimit(int sizeLimit)
sizeLimit
- The sizeLimit to set.public int getTimeLimit()
public void setTimeLimit(int timeLimit)
timeLimit
- The timeLimit to set.public boolean isTypesOnly()
public void setTypesOnly(boolean typesOnly)
typesOnly
- The typesOnly to set.public Filter getCurrentFilter()
public void setCurrentFilter(Filter currentFilter)
currentFilter
- The currentFilter to set.public int computeLength()
computeLength
in class LdapMessage
public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer) throws org.apache.directory.shared.asn1.codec.EncoderException
encode
in class LdapMessage
buffer
- The buffer where to put the PDU
org.apache.directory.shared.asn1.codec.EncoderException
- If anything goes wrong.public java.lang.String toString()
toString
in class LdapMessage
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |