|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.ldappc.util.LdapSearchFilter
public class LdapSearchFilter
This holds the elements for performing a Ldap search on a given base with a specified scope and search filter.
| Nested Class Summary | |
|---|---|
static class |
LdapSearchFilter.OnNotFound
When a subject is not found, either fail (throw an LdappcException), warn (log), or ignore (do nothing). |
| Constructor Summary | |
|---|---|
LdapSearchFilter(String base,
int scope,
String filter,
LdapSearchFilter.OnNotFound onNotFound,
boolean multipleResults)
Construct a LdapSearchFilter with the given parameters. |
|
| Method Summary | |
|---|---|
String |
getBase()
Gets the base DN. |
String |
getFilter()
Get the search filter. |
boolean |
getMultipleResults()
Get whether or not multiple provisioned objects for a subject are allowed. |
LdapSearchFilter.OnNotFound |
getOnNotFound()
Get desired behavior when a subject is not found. |
int |
getScope()
Get the search scope. |
void |
setBase(String base)
Set the base DN. |
void |
setFilter(String filter)
Set the search filter. |
void |
setMultipleResults(boolean multipleResults)
|
void |
setOnNotFound(LdapSearchFilter.OnNotFound onNotFound)
|
void |
setScope(int scope)
Set the search scope. |
String |
toString()
Returns a string representation of the object. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public LdapSearchFilter(String base,
int scope,
String filter,
LdapSearchFilter.OnNotFound onNotFound,
boolean multipleResults)
base - DN of the search basescope - Scope of the searchfilter - Ldap search filteronNotFound - action to perform when a subject can not be foundmultipleResults - allow multiple provisioned objects for a subject| Method Detail |
|---|
public void setBase(String base)
throws IllegalArgumentException
base - DN of the base entry
IllegalArgumentException - thrown if base is null.public String getBase()
public void setScope(int scope)
throws IllegalArgumentException
SearchControls.OBJECT_SCOPE,
SearchControls.ONELEVEL_SCOPE, or
SearchControls.SUBTREE_SCOPE.
scope - Search scope
IllegalArgumentException - thrown if an invalid scope is providedpublic int getScope()
public String getFilter()
public void setFilter(String filter)
throws IllegalArgumentException
filter - Search filter
IllegalArgumentException - thrown if filter is null.public LdapSearchFilter.OnNotFound getOnNotFound()
onNotFoundpublic void setOnNotFound(LdapSearchFilter.OnNotFound onNotFound)
public boolean getMultipleResults()
public void setMultipleResults(boolean multipleResults)
public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||