|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest
org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
org.apache.directory.shared.ldap.message.SearchRequestImpl
public class SearchRequestImpl
Lockable SearchRequest implementation.
Field Summary |
---|
Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalSearchRequest |
---|
RESPONSE_TYPES |
Constructor Summary | |
---|---|
SearchRequestImpl(int id)
Creates a Lockable SearcRequest implementing object used to search the DIT. |
Method Summary | |
---|---|
void |
addAttribute(java.lang.String attribute)
Adds an attribute to the set of entry attributes to return. |
boolean |
equals(java.lang.Object obj)
Checks to see if two search requests are equal. |
java.util.List<java.lang.String> |
getAttributes()
Gets a list of the attributes to be returned from each entry which matches the search filter. |
DN |
getBase()
Gets the search base as a distinguished name. |
AliasDerefMode |
getDerefAliases()
Gets the alias handling parameter. |
ExprNode |
getFilter()
Gets the search filter associated with this search request. |
MessageTypeEnum[] |
getResponseTypes()
Gets the different response types generated by a search request. |
InternalResultResponse |
getResultResponse()
The result containing response for this request. |
SearchScope |
getScope()
Gets the search scope parameter enumeration. |
long |
getSizeLimit()
A sizelimit that restricts the maximum number of entries to be returned as a result of the search. |
int |
getTimeLimit()
Gets the timelimit that restricts the maximum time (in seconds) allowed for a search. |
boolean |
getTypesOnly()
An indicator as to whether search results will contain both attribute types and values, or just attribute types. |
void |
removeAttribute(java.lang.String attribute)
Removes an attribute to the set of entry attributes to return. |
void |
setBase(DN base)
Sets the search base as a distinguished name. |
void |
setDerefAliases(AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter. |
void |
setFilter(ExprNode filter)
Sets the search filter associated with this search request. |
void |
setScope(SearchScope scope)
Sets the search scope parameter enumeration. |
void |
setSizeLimit(long entriesMax)
Sets sizelimit that restricts the maximum number of entries to be returned as a result of the search. |
void |
setTimeLimit(int secondsMax)
Sets the timelimit that restricts the maximum time (in seconds) allowed for a search. |
void |
setTypesOnly(boolean typesOnly)
An indicator as to whether search results will contain both attribute types and values, or just attribute types. |
java.lang.String |
toString()
Return a string the represent a SearchRequest |
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractAbandonableRequest |
---|
abandon, addAbandonListener, isAbandoned |
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest |
---|
hashCode, hasResponse |
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage |
---|
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest |
---|
hasResponse |
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage |
---|
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove |
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalAbandonableRequest |
---|
abandon, addAbandonListener, isAbandoned |
Constructor Detail |
---|
public SearchRequestImpl(int id)
id
- the sequential message identifierMethod Detail |
---|
public java.util.List<java.lang.String> getAttributes()
getAttributes
in interface InternalSearchRequest
public DN getBase()
getBase
in interface InternalSearchRequest
public void setBase(DN base)
setBase
in interface InternalSearchRequest
base
- the search basepublic AliasDerefMode getDerefAliases()
getDerefAliases
in interface InternalSearchRequest
public void setDerefAliases(AliasDerefMode aliasDerefAliases)
setDerefAliases
in interface InternalSearchRequest
aliasDerefAliases
- the alias handling parameter enumeration.public ExprNode getFilter()
getFilter
in interface InternalSearchRequest
public void setFilter(ExprNode filter)
setFilter
in interface InternalSearchRequest
filter
- the expression node for the root of the filter expression
tree.public MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface InternalSearchRequest
getResponseTypes
in interface ManyReplyRequest
InternalSearchRequest.RESPONSE_TYPES
public SearchScope getScope()
getScope
in interface InternalSearchRequest
public void setScope(SearchScope scope)
setScope
in interface InternalSearchRequest
scope
- the scope enumeration parameter.public long getSizeLimit()
getSizeLimit
in interface InternalSearchRequest
public void setSizeLimit(long entriesMax)
setSizeLimit
in interface InternalSearchRequest
entriesMax
- maximum search result entries to return.public int getTimeLimit()
getTimeLimit
in interface InternalSearchRequest
public void setTimeLimit(int secondsMax)
setTimeLimit
in interface InternalSearchRequest
secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
getTypesOnly
in interface InternalSearchRequest
public void setTypesOnly(boolean typesOnly)
setTypesOnly
in interface InternalSearchRequest
typesOnly
- true for only types, false for types and values.public void addAttribute(java.lang.String attribute)
addAttribute
in interface InternalSearchRequest
attribute
- the attribute description or identifier.public void removeAttribute(java.lang.String attribute)
removeAttribute
in interface InternalSearchRequest
attribute
- the attribute description or identifier.public InternalResultResponse getResultResponse()
getResultResponse
in interface InternalResultResponseRequest
public boolean equals(java.lang.Object obj)
equals
in class InternalAbstractMessage
obj
- the object to check for equality to this SearchRequest
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |