org.apache.directory.shared.ldap.message
Interface SearchRequest

All Superinterfaces:

AbandonableRequest, ManyReplyRequest, Message, Request, ResultResponseRequest

All Known Implementing Classes:

SearchRequestImpl

public interface SearchRequest
extends ManyReplyRequest, AbandonableRequest

Search request protocol message interface.

Version:

$Rev: 469970 $

Author:

Apache Directory Project

Field Summary

static MessageTypeEnum[]	RESPONSE_TYPES Different response types that a search request may return.
static MessageTypeEnum	TYPE Search request protocol message type

Method Summary

void	addAttribute(java.lang.String attribute) Adds an attribute to the set of entry attributes to return.
java.util.Collection	getAttributes() Gets a list of the attributes to be returned from each entry which matches the search filter.
LdapDN	getBase() Gets the search base as a distinguished name.
DerefAliasesEnum	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.
ScopeEnum	getScope() Gets the search scope parameter enumeration.
int	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(LdapDN baseDn) Sets the search base as a distinguished name.
void	setDerefAliases(DerefAliasesEnum derefAliases) Sets the alias handling parameter.
void	setFilter(ExprNode filter) Sets the search filter associated with this search request.
void	setScope(ScopeEnum scope) Sets the search scope parameter enumeration.
void	setSizeLimit(int 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.

Methods inherited from interface org.apache.directory.shared.ldap.message.ResultResponseRequest

getResultResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.Request

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.Message

add, get, getControls, getMessageId, getType, put, remove

Methods inherited from interface org.apache.directory.shared.ldap.message.AbandonableRequest

abandon, addAbandonListener, isAbandoned

Field Detail

TYPE

static final MessageTypeEnum TYPE

Search request protocol message type

RESPONSE_TYPES

static final MessageTypeEnum[] RESPONSE_TYPES

Different response types that a search request may return. A search request unlike any other request type can generate four different kinds of responses. It is at most required to return a done response when it is complete however before then it can return search entry, search reference, and extended responses to the client.

See Also:

getResponseTypes()

Method Detail

getResponseTypes

MessageTypeEnum[] getResponseTypes()

Gets the different response types generated by a search request.

Specified by:

getResponseTypes in interface ManyReplyRequest

Returns:

the RESPONSE_TYPES array

See Also:

RESPONSE_TYPES

getBase

LdapDN getBase()

Gets the search base as a distinguished name.

Returns:

the search base

setBase

void setBase(LdapDN baseDn)

Sets the search base as a distinguished name.

Parameters:

baseDn - the search base

getScope

ScopeEnum getScope()

Gets the search scope parameter enumeration.

Returns:

the scope enumeration parameter.

setScope

void setScope(ScopeEnum scope)

Sets the search scope parameter enumeration.

Parameters:

scope - the scope enumeration parameter.

getDerefAliases

DerefAliasesEnum getDerefAliases()

Gets the alias handling parameter.

Returns:

the alias handling parameter enumeration.

setDerefAliases

void setDerefAliases(DerefAliasesEnum derefAliases)

Sets the alias handling parameter.

Parameters:

derefAliases - the alias handling parameter enumeration.

getSizeLimit

int getSizeLimit()

A sizelimit that restricts the maximum number of entries to be returned as a result of the search. A value of 0 in this field indicates that no client-requested sizelimit restrictions are in effect for the search. Servers may enforce a maximum number of entries to return.

Returns:

search size limit.

setSizeLimit

void setSizeLimit(int entriesMax)

Sets sizelimit that restricts the maximum number of entries to be returned as a result of the search. A value of 0 in this field indicates that no client-requested sizelimit restrictions are in effect for the search. Servers may enforce a maximum number of entries to return.

Parameters:

entriesMax - maximum search result entries to return.

getTimeLimit

int getTimeLimit()

Gets the timelimit that restricts the maximum time (in seconds) allowed for a search. A value of 0 in this field indicates that no client- requested timelimit restrictions are in effect for the search.

Returns:

the search time limit in seconds.

setTimeLimit

void setTimeLimit(int secondsMax)

Sets the timelimit that restricts the maximum time (in seconds) allowed for a search. A value of 0 in this field indicates that no client- requested timelimit restrictions are in effect for the search.

Parameters:

secondsMax - the search time limit in seconds.

getTypesOnly

boolean getTypesOnly()

An indicator as to whether search results will contain both attribute types and values, or just attribute types. Setting this field to TRUE causes only attribute types (no values) to be returned. Setting this field to FALSE causes both attribute types and values to be returned.

Returns:

true for only types, false for types and values.

setTypesOnly

void setTypesOnly(boolean typesOnly)

An indicator as to whether search results will contain both attribute types and values, or just attribute types. Setting this field to TRUE causes only attribute types (no values) to be returned. Setting this field to FALSE causes both attribute types and values to be returned.

Parameters:

typesOnly - true for only types, false for types and values.

getFilter

ExprNode getFilter()

Gets the search filter associated with this search request.

Returns:

the expression node for the root of the filter expression tree.

setFilter

void setFilter(ExprNode filter)

Sets the search filter associated with this search request.

Parameters:

filter - the expression node for the root of the filter expression tree.

getAttributes

java.util.Collection getAttributes()

Gets a list of the attributes to be returned from each entry which matches the search filter. There are two special values which may be used: an empty list with no attributes, and the attribute description string "*". Both of these signify that all user attributes are to be returned. (The "*" allows the client to request all user attributes in addition to specific operational attributes). Attributes MUST be named at most once in the list, and are returned at most once in an entry. If there are attribute descriptions in the list which are not recognized, they are ignored by the server. If the client does not want any attributes returned, it can specify a list containing only the attribute with OID "1.1". This OID was chosen arbitrarily and does not correspond to any attribute in use. Client implementors should note that even if all user attributes are requested, some attributes of the entry may not be included in search results due to access control or other restrictions. Furthermore, servers will not return operational attributes, such as objectClasses or attributeTypes, unless they are listed by name, since there may be extremely large number of values for certain operational attributes.

Returns:

the attributes to return for this request

addAttribute

void addAttribute(java.lang.String attribute)

Adds an attribute to the set of entry attributes to return.

Parameters:

attribute - the attribute description or identifier.

removeAttribute

void removeAttribute(java.lang.String attribute)

Removes an attribute to the set of entry attributes to return.

Parameters:

attribute - the attribute description or identifier.