Class SearchParams
- java.lang.Object
-
- org.apache.directory.api.ldap.model.message.SearchParams
-
public class SearchParams extends Object
A container for Search parameters. It replaces the SearchControls.- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description SearchParams()
Creates a new instance of SearchContext, with all the values set to default.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addControl(Control control)
void
addReturningAttributes(String returningAttribute)
AliasDerefMode
getAliasDerefMode()
Set<Control>
getControls()
Set<AttributeTypeOptions>
getReturningAttributes()
Set<String>
getReturningAttributesStr()
SearchScope
getScope()
long
getSizeLimit()
int
getTimeLimit()
boolean
isTypesOnly()
void
normalize(SchemaManager schemaManager)
Normalize the ReturningAttributes.void
setAliasDerefMode(AliasDerefMode aliasDerefMode)
void
setControls(Set<Control> controls)
void
setReturningAttributes(String... returningAttributes)
void
setScope(SearchScope scope)
void
setSizeLimit(long sizeLimit)
void
setTimeLimit(int timeLimit)
void
setTypesOnly(boolean typesOnly)
static SearchParams
toSearchParams(SearchControls searchControls, AliasDerefMode aliasDerefMode)
Creates aSearchParams
from JNDI search controls.String
toString()
-
-
-
Constructor Detail
-
SearchParams
public SearchParams()
Creates a new instance of SearchContext, with all the values set to default.
-
-
Method Detail
-
getScope
public SearchScope getScope()
- Returns:
- the scope
-
setScope
public void setScope(SearchScope scope)
- Parameters:
scope
- the scope to set
-
getTimeLimit
public int getTimeLimit()
- Returns:
- the timeLimit
-
setTimeLimit
public void setTimeLimit(int timeLimit)
- Parameters:
timeLimit
- the timeLimit to set
-
getSizeLimit
public long getSizeLimit()
- Returns:
- the sizeLimit
-
setSizeLimit
public void setSizeLimit(long sizeLimit)
- Parameters:
sizeLimit
- the sizeLimit to set
-
isTypesOnly
public boolean isTypesOnly()
- Returns:
- the typesOnly
-
setTypesOnly
public void setTypesOnly(boolean typesOnly)
- Parameters:
typesOnly
- the typesOnly to set
-
getAliasDerefMode
public AliasDerefMode getAliasDerefMode()
- Returns:
- the aliasDerefMode
-
setAliasDerefMode
public void setAliasDerefMode(AliasDerefMode aliasDerefMode)
- Parameters:
aliasDerefMode
- the aliasDerefMode to set
-
getReturningAttributes
public Set<AttributeTypeOptions> getReturningAttributes()
- Returns:
- the returningAttributes
-
getReturningAttributesStr
public Set<String> getReturningAttributesStr()
- Returns:
- the returningAttributes
-
normalize
public void normalize(SchemaManager schemaManager)
Normalize the ReturningAttributes. It reads all the String from the returningAttributesString, and grab the associated AttributeType from the schema to store it into the returningAttributes Set.- Parameters:
schemaManager
- The schema manager
-
setReturningAttributes
public void setReturningAttributes(String... returningAttributes)
- Parameters:
returningAttributes
- the returningAttributes to set
-
addReturningAttributes
public void addReturningAttributes(String returningAttribute)
- Parameters:
returningAttribute
- the returningAttributes to add
-
getControls
public Set<Control> getControls()
- Returns:
- the controls
-
setControls
public void setControls(Set<Control> controls)
- Parameters:
controls
- the controls to set
-
addControl
public void addControl(Control control)
- Parameters:
control
- the controls to set
-
toSearchParams
public static SearchParams toSearchParams(SearchControls searchControls, AliasDerefMode aliasDerefMode)
Creates aSearchParams
from JNDI search controls.- Parameters:
searchControls
- the search controlsaliasDerefMode
- the alias deref mode- Returns:
- the search params
-
-