public class SearchParams extends Object
Constructor and Description |
---|
SearchParams()
Creates a new instance of SearchContext, with all the values set to
default.
|
Modifier and Type | Method and 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 a
SearchParams from JNDI search controls. |
String |
toString() |
public SearchParams()
public SearchScope getScope()
public void setScope(SearchScope scope)
scope
- the scope to setpublic int getTimeLimit()
public void setTimeLimit(int timeLimit)
timeLimit
- the timeLimit to setpublic long getSizeLimit()
public void setSizeLimit(long sizeLimit)
sizeLimit
- the sizeLimit to setpublic boolean isTypesOnly()
public void setTypesOnly(boolean typesOnly)
typesOnly
- the typesOnly to setpublic AliasDerefMode getAliasDerefMode()
public void setAliasDerefMode(AliasDerefMode aliasDerefMode)
aliasDerefMode
- the aliasDerefMode to setpublic Set<AttributeTypeOptions> getReturningAttributes()
public Set<String> getReturningAttributesStr()
public void normalize(SchemaManager schemaManager)
schemaManager
- The schema managerpublic void setReturningAttributes(String... returningAttributes)
returningAttributes
- the returningAttributes to setpublic void addReturningAttributes(String returningAttribute)
returningAttribute
- the returningAttributes to addpublic Set<Control> getControls()
public void setControls(Set<Control> controls)
controls
- the controls to setpublic void addControl(Control control)
control
- the controls to setpublic static SearchParams toSearchParams(SearchControls searchControls, AliasDerefMode aliasDerefMode)
SearchParams
from JNDI search controls.searchControls
- the search controlsaliasDerefMode
- the alias deref modeCopyright © 2003–2020 The Apache Software Foundation. All rights reserved.