|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.asn1.AbstractAsn1Object
org.apache.directory.shared.ldap.codec.LdapMessage
org.apache.directory.shared.ldap.codec.search.SearchRequest
public class 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.AbstractAsn1Object |
---|
parent |
Constructor Summary | |
---|---|
SearchRequest()
Creates a new SearchRequest object. |
Method Summary | |
---|---|
void |
addAttribute(java.lang.String attribute)
Add an attribute to the attributes list. |
void |
addCurrentFilter(Filter localFilter)
Add a current filter. |
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. |
java.util.List<EntryAttribute> |
getAttributes()
Get the list of attributes |
LdapDN |
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 |
SearchScope |
getScope()
Get the search scope |
int |
getSizeLimit()
Get the size limit |
Filter |
getTerminalFilter()
Get the comparison dilter |
int |
getTimeLimit()
Get the time limit |
boolean |
isTypesOnly()
Get the typesOnly flag |
void |
setBaseObject(LdapDN baseObject)
Set the base object |
void |
setCurrentFilter(Filter filter)
Set the current dilter |
void |
setDerefAliases(int derefAliases)
Set the derefAliases flag |
void |
setFilter(Filter filter)
Set the filter |
void |
setScope(SearchScope scope)
Set the search scope |
void |
setSizeLimit(int sizeLimit)
Set the size limit |
void |
setTerminalFilter(Filter terminalFilter)
Set the terminal filter |
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 |
void |
unstackFilters(IAsn1Container container)
This method is used to clear the filter's stack for terminated elements. |
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, initControls, setMessageId, setProtocolOP |
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object |
---|
addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, 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 java.util.List<EntryAttribute> getAttributes()
public void addAttribute(java.lang.String attribute)
attribute
- The attribute to add to the listpublic LdapDN getBaseObject()
public void setBaseObject(LdapDN 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 SearchScope getScope()
public void setScope(SearchScope 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 Filter getTerminalFilter()
public void setTerminalFilter(Filter terminalFilter)
terminalFilter
- the teminalFilter.public void addCurrentFilter(Filter localFilter) throws DecoderException
localFilter
- The filter to set.
DecoderException
public void setCurrentFilter(Filter filter)
filter
- The filter to set.public void unstackFilters(IAsn1Container container)
container
- The container being decodedpublic int computeLength()
computeLength
in interface Asn1Object
computeLength
in class LdapMessage
public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer) throws EncoderException
encode
in interface Asn1Object
encode
in class LdapMessage
buffer
- The buffer where to put the PDU
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 |