public class SearchRequestDsml extends AbstractResultResponseRequestDsml<SearchRequest,SearchResultDone> implements SearchRequest
RESPONSE_TYPES
Constructor and Description |
---|
SearchRequestDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of SearchRequestDsml.
|
SearchRequestDsml(LdapApiService codec,
SearchRequest ldapMessage)
Creates a new getDecoratedMessage() of SearchRequestDsml.
|
Modifier and Type | Method and Description |
---|---|
SearchRequest |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
SearchRequest |
addAttributes(String... attributes)
Adds some attributes to the set of entry attributes to return.
|
SearchRequest |
addControl(Control control)
Adds a control to this Message.
|
void |
addCurrentFilter(Filter localFilter)
Add a current filter.
|
void |
endCurrentConnectorFilter()
set the currentFilter to its parent
|
SearchRequest |
followReferrals()
Tells the client to follow referrals instead of throwing exceptions
|
List<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.
|
Filter |
getCodecFilter()
Gets the search filter associated with this search request.
|
AliasDerefMode |
getDerefAliases()
Gets the alias handling parameter.
|
ExprNode |
getFilter()
Gets the search filter associated with this search request.
|
ExprNode |
getFilterNode()
Gets the search filter associated with this search request.
|
MessageTypeEnum[] |
getResponseTypes()
Gets the different response types generated by a search 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.
|
Filter |
getTerminalFilter()
Get the terminal filter
|
int |
getTimeLimit()
Gets the timelimit that restricts the maximum time (in seconds) allowed
for a search.
|
MessageTypeEnum |
getType()
Gets the LDAP message type code associated with this Message.
|
boolean |
getTypesOnly()
An indicator as to whether search results will contain both attribute
types and values, or just attribute types.
|
SearchRequest |
ignoreReferrals()
Tells the client to ignore referrals instead of throwing exceptions.
|
boolean |
isFollowReferrals()
Tells the client if it should follow referrals instead of throwing exceptions
|
boolean |
isIgnoreReferrals()
Tells the client if it should ignore referrals instead of throwing exceptions
|
SearchRequest |
removeAttribute(String attribute)
Removes an attribute to the set of entry attributes to return.
|
SearchRequest |
removeControl(Control control)
Deletes a control removing it from this Message.
|
SearchRequest |
setBase(Dn baseDn)
Sets the search base as a distinguished name.
|
SearchRequest |
setDerefAliases(AliasDerefMode aliasDerefAliases)
Sets the alias handling parameter.
|
SearchRequest |
setFilter(ExprNode filter)
Sets the search filter associated with this search request.
|
SearchRequest |
setFilter(String filter)
Sets the search filter associated with this search request.
|
SearchRequest |
setMessageId(int messageId)
Sets the Message ID for this request
|
SearchRequest |
setScope(SearchScope scope)
Sets the search scope parameter enumeration.
|
SearchRequest |
setSizeLimit(long entriesMax)
Sets sizelimit that restricts the maximum number of entries to be
returned as a result of the search.
|
void |
setTerminalFilter(Filter terminalFilter)
Set the terminal filter
|
SearchRequest |
setTimeLimit(int secondsMax)
Sets the timelimit that restricts the maximum time (in seconds) allowed
for a search.
|
SearchRequest |
setTypesOnly(boolean typesOnly)
An indicator as to whether search results will contain both attribute
types and values, or just attribute types.
|
org.dom4j.Element |
toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.
|
abandon, addAbandonListener, computeLength, encode, getResultResponse, isAbandoned
hasResponse
get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getResultResponse
hasResponse
get, getControl, getControls, getMessageId, hasControl, put
abandon, addAbandonListener, isAbandoned
public SearchRequestDsml(LdapApiService codec)
codec
- The LDAP Service to usepublic SearchRequestDsml(LdapApiService codec, SearchRequest ldapMessage)
codec
- The LDAP Service to useldapMessage
- the message to decoratepublic Filter getCodecFilter()
public ExprNode getFilterNode()
public Filter getTerminalFilter()
public void setTerminalFilter(Filter terminalFilter)
terminalFilter
- the teminalFilter.public void endCurrentConnectorFilter()
public void addCurrentFilter(Filter localFilter) throws DecoderException
localFilter
- The filter to set.DecoderException
- If the added filter is invalidpublic MessageTypeEnum getType()
getType
in interface Message
getType
in class AbstractDsmlMessageDecorator<SearchRequest>
public org.dom4j.Element toDsml(org.dom4j.Element root)
toDsml
in interface DsmlDecorator<SearchRequest>
toDsml
in class AbstractResultResponseRequestDsml<SearchRequest,SearchResultDone>
root
- the root elementpublic MessageTypeEnum[] getResponseTypes()
getResponseTypes
in interface ManyReplyRequest
getResponseTypes
in interface SearchRequest
SearchRequest.RESPONSE_TYPES
public Dn getBase()
getBase
in interface SearchRequest
public SearchRequest setBase(Dn baseDn)
setBase
in interface SearchRequest
baseDn
- the search basepublic SearchScope getScope()
getScope
in interface SearchRequest
public SearchRequest setScope(SearchScope scope)
setScope
in interface SearchRequest
scope
- the scope enumeration parameter.public AliasDerefMode getDerefAliases()
getDerefAliases
in interface SearchRequest
public SearchRequest setDerefAliases(AliasDerefMode aliasDerefAliases)
setDerefAliases
in interface SearchRequest
aliasDerefAliases
- the alias handling parameter enumeration.public long getSizeLimit()
getSizeLimit
in interface SearchRequest
public SearchRequest setSizeLimit(long entriesMax)
setSizeLimit
in interface SearchRequest
entriesMax
- maximum search result entries to return.public int getTimeLimit()
getTimeLimit
in interface SearchRequest
public SearchRequest setTimeLimit(int secondsMax)
setTimeLimit
in interface SearchRequest
secondsMax
- the search time limit in seconds.public boolean getTypesOnly()
getTypesOnly
in interface SearchRequest
public SearchRequest setTypesOnly(boolean typesOnly)
setTypesOnly
in interface SearchRequest
typesOnly
- true for only types, false for types and values.public ExprNode getFilter()
getFilter
in interface SearchRequest
public SearchRequest setFilter(ExprNode filter)
setFilter
in interface SearchRequest
filter
- the expression node for the root of the filter expression tree.public SearchRequest setFilter(String filter) throws LdapException
setFilter
in interface SearchRequest
filter
- the expression node for the root of the filter expression tree.LdapException
- If the filter can't be addedpublic List<String> getAttributes()
getAttributes
in interface SearchRequest
public SearchRequest addAttributes(String... attributes)
addAttributes
in interface SearchRequest
attributes
- the attributes description or identifier.public SearchRequest removeAttribute(String attribute)
removeAttribute
in interface SearchRequest
attribute
- the attribute description or identifier.public SearchRequest setMessageId(int messageId)
setMessageId
in interface Message
setMessageId
in interface SearchRequest
setMessageId
in class AbstractDsmlMessageDecorator<SearchRequest>
messageId
- The message Idpublic SearchRequest addControl(Control control)
addControl
in interface Message
addControl
in interface SearchRequest
addControl
in class AbstractDsmlMessageDecorator<SearchRequest>
control
- the control to add.public SearchRequest addAllControls(Control[] controls)
addAllControls
in interface Message
addAllControls
in interface SearchRequest
addAllControls
in class AbstractDsmlMessageDecorator<SearchRequest>
controls
- the controls to add.public SearchRequest removeControl(Control control)
removeControl
in interface Message
removeControl
in interface SearchRequest
removeControl
in class AbstractDsmlMessageDecorator<SearchRequest>
control
- the control to remove.public boolean isFollowReferrals()
isFollowReferrals
in interface SearchRequest
public SearchRequest followReferrals()
followReferrals
in interface SearchRequest
public boolean isIgnoreReferrals()
isIgnoreReferrals
in interface SearchRequest
public SearchRequest ignoreReferrals()
ignoreReferrals
in interface SearchRequest
Copyright © 2003–2018 The Apache Software Foundation. All rights reserved.