|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LdapOperations
Interface that specifies a basic set of LDAP operations. Implemented by LdapTemplate, but it might be a useful option to use this interface in order to enhance testability.
Method Summary | |
---|---|
void |
bind(javax.naming.Name dn,
java.lang.Object obj,
javax.naming.directory.Attributes attributes)
Create an entry in the LDAP tree. |
void |
bind(java.lang.String dn,
java.lang.Object obj,
javax.naming.directory.Attributes attributes)
Create an entry in the LDAP tree. |
java.lang.Object |
executeReadOnly(ContextExecutor ce)
Perform an operation (or series of operations) on a read-only context. |
java.lang.Object |
executeReadWrite(ContextExecutor ce)
Perform an operation (or series of operations) on a read-write context. |
java.util.List |
list(javax.naming.Name base)
Perform a non-recursive listing of the contexts bound to the given base . |
void |
list(javax.naming.Name base,
NameClassPairCallbackHandler handler)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
list(javax.naming.Name base,
NameClassPairMapper mapper)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
list(java.lang.String base)
Perform a non-recursive listing of the children of the given base . |
void |
list(java.lang.String base,
NameClassPairCallbackHandler handler)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
list(java.lang.String base,
NameClassPairMapper mapper)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
listBindings(javax.naming.Name base)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
listBindings(javax.naming.Name base,
ContextMapper mapper)
Perform a non-recursive listing of the children of the given base . |
void |
listBindings(javax.naming.Name base,
NameClassPairCallbackHandler handler)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
listBindings(javax.naming.Name base,
NameClassPairMapper mapper)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
listBindings(java.lang.String base)
Perform a non-recursive listing of children of the given base . |
java.util.List |
listBindings(java.lang.String base,
ContextMapper mapper)
Perform a non-recursive listing of the children of the given base . |
void |
listBindings(java.lang.String base,
NameClassPairCallbackHandler handler)
Perform a non-recursive listing of the children of the given base . |
java.util.List |
listBindings(java.lang.String base,
NameClassPairMapper mapper)
Perform a non-recursive listing of the children of the given base . |
java.lang.Object |
lookup(javax.naming.Name dn)
Lookup the supplied DN and return the found object. |
java.lang.Object |
lookup(javax.naming.Name dn,
AttributesMapper mapper)
Convenience method to get the attributes of a specified DN and automatically pass them to an AttributesMapper. |
java.lang.Object |
lookup(javax.naming.Name dn,
ContextMapper mapper)
Convenience method to lookup a specified DN and automatically pass the found object to a ContextMapper. |
java.lang.Object |
lookup(javax.naming.Name dn,
java.lang.String[] attributes,
AttributesMapper mapper)
Convenience method to get the specified attributes of a specified DN and automatically pass them to an AttributesMapper. |
java.lang.Object |
lookup(javax.naming.Name dn,
java.lang.String[] attributes,
ContextMapper mapper)
Convenience method to get the specified attributes of a specified DN and automatically pass them to a ContextMapper. |
java.lang.Object |
lookup(java.lang.String dn)
Lookup the supplied DN and return the found object. |
java.lang.Object |
lookup(java.lang.String dn,
AttributesMapper mapper)
Convenience method to get the attributes of a specified DN and automatically pass them to an AttributesMapper. |
java.lang.Object |
lookup(java.lang.String dn,
ContextMapper mapper)
Convenience method to lookup a specified DN and automatically pass the found object to a ContextMapper. |
java.lang.Object |
lookup(java.lang.String dn,
java.lang.String[] attributes,
AttributesMapper mapper)
Convenience method to get the specified attributes of a specified DN and automatically pass them to an AttributesMapper. |
java.lang.Object |
lookup(java.lang.String dn,
java.lang.String[] attributes,
ContextMapper mapper)
Convenience method to get the specified attributes of a specified DN and automatically pass them to a ContextMapper. |
void |
modifyAttributes(javax.naming.Name dn,
javax.naming.directory.ModificationItem[] mods)
Modify an entry in the LDAP tree using the supplied ModificationItems. |
void |
modifyAttributes(java.lang.String dn,
javax.naming.directory.ModificationItem[] mods)
Modify an entry in the LDAP tree using the supplied ModificationItems. |
void |
rebind(javax.naming.Name dn,
java.lang.Object obj,
javax.naming.directory.Attributes attributes)
Remove an entry and replace it with a new one. |
void |
rebind(java.lang.String dn,
java.lang.Object obj,
javax.naming.directory.Attributes attributes)
Remove an entry and replace it with a new one. |
void |
rename(javax.naming.Name oldDn,
javax.naming.Name newDn)
Move an entry in the LDAP tree to a new location. |
void |
rename(java.lang.String oldDn,
java.lang.String newDn)
Move an entry in the LDAP tree to a new location. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
int searchScope,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
void |
search(javax.naming.Name base,
java.lang.String filter,
int searchScope,
boolean returningObjFlag,
NameClassPairCallbackHandler handler)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
int searchScope,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
int searchScope,
java.lang.String[] attrs,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
int searchScope,
java.lang.String[] attrs,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
void |
search(javax.naming.Name base,
java.lang.String filter,
NameClassPairCallbackHandler handler)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
AttributesMapper mapper,
DirContextProcessor processor)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(javax.naming.Name base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
ContextMapper mapper,
DirContextProcessor processor)
Search for all objects matching the supplied filter. |
void |
search(javax.naming.Name base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
NameClassPairCallbackHandler handler)
Search for all objects matching the supplied filter. |
void |
search(javax.naming.Name base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
NameClassPairCallbackHandler handler,
DirContextProcessor processor)
Search for all objects matching the supplied filter. |
void |
search(SearchExecutor se,
NameClassPairCallbackHandler handler)
Perform a search. |
void |
search(SearchExecutor se,
NameClassPairCallbackHandler handler,
DirContextProcessor processor)
Perform a search using a custom context processor. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
int searchScope,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
void |
search(java.lang.String base,
java.lang.String filter,
int searchScope,
boolean returningObjFlag,
NameClassPairCallbackHandler handler)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
int searchScope,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
int searchScope,
java.lang.String[] attrs,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
int searchScope,
java.lang.String[] attrs,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
void |
search(java.lang.String base,
java.lang.String filter,
NameClassPairCallbackHandler handler)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
AttributesMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
AttributesMapper mapper,
DirContextProcessor processor)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
ContextMapper mapper)
Search for all objects matching the supplied filter. |
java.util.List |
search(java.lang.String base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
ContextMapper mapper,
DirContextProcessor processor)
Search for all objects matching the supplied filter. |
void |
search(java.lang.String base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
NameClassPairCallbackHandler handler)
Search for all objects matching the supplied filter. |
void |
search(java.lang.String base,
java.lang.String filter,
javax.naming.directory.SearchControls controls,
NameClassPairCallbackHandler handler,
DirContextProcessor processor)
Search for all objects matching the supplied filter. |
void |
unbind(javax.naming.Name dn)
Remove an entry from the LDAP tree. |
void |
unbind(javax.naming.Name dn,
boolean recursive)
Remove an entry from the LDAP tree, optionally removing all descendants in the process. |
void |
unbind(java.lang.String dn)
Remove an entry from the LDAP tree. |
void |
unbind(java.lang.String dn,
boolean recursive)
Remove an entry from the LDAP tree, optionally removing all descendants in the process. |
Method Detail |
---|
void search(SearchExecutor se, NameClassPairCallbackHandler handler, DirContextProcessor processor) throws org.springframework.dao.DataAccessException
se
- The SearchExecutor to use for performing the actual search.handler
- The NameClassPairCallbackHandler to which each found entry
will be passed.processor
- DirContextProcessor for custom pre- and post-processing.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted as no entries being
found.void search(SearchExecutor se, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
se
- The SearchExecutor to use for performing the actual search.handler
- The NameClassPairCallbackHandler to which each found entry
will be passed.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted as no entries being
found.java.lang.Object executeReadOnly(ContextExecutor ce) throws org.springframework.dao.DataAccessException
search(SearchExecutor, NameClassPairCallbackHandler)
or any of
the overloaded search methods for this.
ce
- The ContextExecutor to which the actual operation on the
DirContext will be delegated.
org.springframework.dao.DataAccessException
- if the operation resulted in a NamingException.java.lang.Object executeReadWrite(ContextExecutor ce) throws org.springframework.dao.DataAccessException
ce
- The ContextExecutor to which the actual operation on the
DirContext will be delegated.
org.springframework.dao.DataAccessException
- if the operation resulted in a NamingException.void search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler)
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.void search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler)
search(Name, String, SearchControls, NameClassPairCallbackHandler)
for details.
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.void search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor)
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.processor
- The DirContextProcessor to use before and after the search.java.util.List search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, AttributesMapper mapper, DirContextProcessor processor)
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.mapper
- The AttributesMapper to use for translating each entry.processor
- The DirContextProcessor to use before and after the search.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, AttributesMapper mapper, DirContextProcessor processor)
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.mapper
- The AttributesMapper to use for translating each entry.processor
- The DirContextProcessor to use before and after the search.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, ContextMapper mapper, DirContextProcessor processor)
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search. If the returnObjFlag
is not set in the SearchControls, this method will set it
automatically, as this is required for the ContextMapper to
work.mapper
- The ContextMapper to use for translating each entry.processor
- The DirContextProcessor to use before and after the search.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, ContextMapper mapper, DirContextProcessor processor)
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search. If the returnObjFlag
is not set in the SearchControls, this method will set it
automatically, as this is required for the ContextMapper to
work.mapper
- The ContextMapper to use for translating each entry.processor
- The DirContextProcessor to use before and after the search.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor)
search(Name, String, SearchControls, NameClassPairCallbackHandler, DirContextProcessor)
for details.
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.processor
- The DirContextProcessor to use before and after the search.void search(javax.naming.Name base, java.lang.String filter, int searchScope, boolean returningObjFlag, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.returningObjFlag
- Whether the bound object should be returned in search results.
Must be set to true
if a ContextMapper is used.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void search(java.lang.String base, java.lang.String filter, int searchScope, boolean returningObjFlag, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.returningObjFlag
- whether the bound object should be returned in search results.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void search(javax.naming.Name base, java.lang.String filter, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void search(java.lang.String base, java.lang.String filter, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.handler
- The NameClassPairCallbackHandler to supply the SearchResults
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, int searchScope, java.lang.String[] attrs, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.attrs
- The attributes to return, null means returning all attributes.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, int searchScope, java.lang.String[] attrs, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.attrs
- The attributes to return, null means returning all attributes.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, int searchScope, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, int searchScope, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, int searchScope, java.lang.String[] attrs, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.attrs
- The attributes to return, null means all attributes.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, int searchScope, java.lang.String[] attrs, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.attrs
- The attributes to return, null means all attributes.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, int searchScope, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, int searchScope, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.searchScope
- The search scope to set in SearchControls.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search. If the returnObjFlag
is not set in the SearchControls, this method will set it
automatically, as this is required for the ContextMapper to
work.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search. If the returnObjFlag
is not set in the SearchControls, this method will set it
automatically, as this is required for the ContextMapper to
work.mapper
- The ContextMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(java.lang.String base, java.lang.String filter, javax.naming.directory.SearchControls controls, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
base
- The base DN where the search should begin.filter
- The filter to use in the search.controls
- The SearchControls to use in the search.mapper
- The AttributesMapper to use for translating each entry.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void list(java.lang.String base, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
. Each resulting NameClassPair is supplied to the
specified NameClassPairCallbackHandler.
base
- The base DN where the list should be performed.handler
- The NameClassPairCallbackHandler to supply each
NameClassPair
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void list(javax.naming.Name base, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
. Each resulting NameClassPair is supplied to the
specified NameClassPairCallbackHandler.
base
- The base DN where the list should be performed.handler
- The NameClassPairCallbackHandler to supply each
NameClassPair
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List list(java.lang.String base, NameClassPairMapper mapper) throws org.springframework.dao.DataAccessException
base
. Pass all the found NameClassPair objects to the
supplied NameClassPairMapper and return all the returned values as a
List.
base
- The base DN where the list should be performed.mapper
- The NameClassPairMapper to supply each NameClassPair
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List list(javax.naming.Name base, NameClassPairMapper mapper) throws org.springframework.dao.DataAccessException
base
. Pass all the found NameClassPair objects to the
supplied NameClassPairMapper and return all the returned values as a
List.
base
- The base DN where the list should be performed.mapper
- The NameClassPairMapper to supply each NameClassPair
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List list(java.lang.String base) throws org.springframework.dao.DataAccessException
base
.
base
- The base DN where the list should be performed.
base
.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List list(javax.naming.Name base) throws org.springframework.dao.DataAccessException
base
.
base
- The base DN where the list should be performed.
base
.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void listBindings(java.lang.String base, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
. Each resulting Binding is supplied to the specified
NameClassPairCallbackHandler.
base
- The base DN where the list should be performed.handler
- The NameClassPairCallbackHandler to supply each
Binding
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.void listBindings(javax.naming.Name base, NameClassPairCallbackHandler handler) throws org.springframework.dao.DataAccessException
base
. Each resulting Binding is supplied to the specified
NameClassPairCallbackHandler.
base
- The base DN where the list should be performed.handler
- The NameClassPairCallbackHandler to supply each
Binding
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List listBindings(java.lang.String base, NameClassPairMapper mapper) throws org.springframework.dao.DataAccessException
base
. Pass all the found Binding objects to the supplied
NameClassPairMapper and return all the returned values as a List.
base
- The base DN where the list should be performed.mapper
- The NameClassPairMapper to supply each Binding
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List listBindings(javax.naming.Name base, NameClassPairMapper mapper) throws org.springframework.dao.DataAccessException
base
. Pass all the found Binding objects to the supplied
NameClassPairMapper and return all the returned values as a List.
base
- The base DN where the list should be performed.mapper
- The NameClassPairMapper to supply each Binding
to.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List listBindings(java.lang.String base) throws org.springframework.dao.DataAccessException
base
.
base
- The base DN where the list should be performed.
base
.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List listBindings(javax.naming.Name base) throws org.springframework.dao.DataAccessException
base
.
base
- The base DN where the list should be performed.
base
.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List listBindings(java.lang.String base, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
. The Object returned in each Binding
is
supplied to the specified ContextMapper.
base
- The base DN where the list should be performed.mapper
- The ContextMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.util.List listBindings(javax.naming.Name base, ContextMapper mapper) throws org.springframework.dao.DataAccessException
base
. The Object returned in each Binding
is
supplied to the specified ContextMapper.
base
- The base DN where the list should be performed.mapper
- The ContextMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs. Note that a NameNotFoundException will
be ignored. Instead this is interpreted that no entries were
found.java.lang.Object lookup(javax.naming.Name dn) throws org.springframework.dao.DataAccessException
dn
- The distinguished name of the object to find.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(java.lang.String dn) throws org.springframework.dao.DataAccessException
dn
- The distinguished name of the object to find.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.mapper
- The AttributesMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.mapper
- The AttributesMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, ContextMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.mapper
- The ContextMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, ContextMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.mapper
- The ContextMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, java.lang.String[] attributes, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.attributes
- The names of the attributes to pass to the mapper.mapper
- The AttributesMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, java.lang.String[] attributes, AttributesMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.attributes
- The names of the attributes to pass to the mapper.mapper
- The AttributesMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, java.lang.String[] attributes, ContextMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.attributes
- The names of the attributes to pass to the mapper.mapper
- The ContextMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, java.lang.String[] attributes, ContextMapper mapper) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to find.attributes
- The names of the attributes to pass to the mapper.mapper
- The ContextMapper to use for mapping the found object.
org.springframework.dao.DataAccessException
- if any error occurs.void modifyAttributes(javax.naming.Name dn, javax.naming.directory.ModificationItem[] mods) throws org.springframework.dao.DataAccessException
dn
- The distinguished name of the node to modify.mods
- The modifications to perform.
org.springframework.dao.DataAccessException
- if any error occurs.void modifyAttributes(java.lang.String dn, javax.naming.directory.ModificationItem[] mods) throws org.springframework.dao.DataAccessException
dn
- The distinguished name of the node to modify.mods
- The modifications to perform.
org.springframework.dao.DataAccessException
- if any error occurs.void bind(javax.naming.Name dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws org.springframework.dao.DataAccessException
obj
parameter or the
attributes
parameter (or both). One of these parameters
may be null but not both.
dn
- The distinguished name to bind the object and attributes to.obj
- The object to bind, may be null. Typically a DirContext
implementation.attributes
- The attributes to bind, may be null.
org.springframework.dao.DataAccessException
- if any error occurs.void bind(java.lang.String dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws org.springframework.dao.DataAccessException
obj
parameter or the
attributes
parameter (or both). One of these parameters
may be null but not both.
dn
- The distinguished name to bind the object and attributes to.obj
- The object to bind, may be null. Typically a DirContext
implementation.attributes
- The attributes to bind, may be null.
org.springframework.dao.DataAccessException
- if any error occurs.void unbind(javax.naming.Name dn) throws org.springframework.dao.DataAccessException
unbind(Name, boolean)
in stead.
dn
- The distinguished name of the entry to remove.
org.springframework.dao.DataAccessException
- if any error occurs.void unbind(java.lang.String dn) throws org.springframework.dao.DataAccessException
unbind(Name, boolean)
in stead.
dn
- The distinguished name to unbind.
org.springframework.dao.DataAccessException
- if any error occurs.void unbind(javax.naming.Name dn, boolean recursive) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to unbind.recursive
- Whether to unbind all subcontexts as well. If this parameter
is false
and the entry has children, the
operation will fail.
org.springframework.dao.DataAccessException
- if any error occurs.void unbind(java.lang.String dn, boolean recursive) throws org.springframework.dao.DataAccessException
dn
- The distinguished name to unbind.recursive
- Whether to unbind all subcontexts as well. If this parameter
is false
and the entry has children, the
operation will fail.
org.springframework.dao.DataAccessException
- if any error occurs.void rebind(javax.naming.Name dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws org.springframework.dao.DataAccessException
obj
parameter or the attributes
parameter (or both). One of
these parameters may be null but not both. This method assumes that the
specified context already exists - if not it will fail.
dn
- The distinguished name to rebind.obj
- The object to bind to the DN, may be null. Typically a
DirContext implementation.attributes
- The attributes to bind, may be null.
org.springframework.dao.DataAccessException
- if any error occurs.void rebind(java.lang.String dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws org.springframework.dao.DataAccessException
obj
parameter or the attributes
parameter (or both). One of
these parameters may be null but not both. This method assumes that the
specified context already exists - if not it will fail.
dn
- The distinguished name to rebind.obj
- The object to bind to the DN, may be null. Typically a
DirContext implementation.attributes
- The attributes to bind, may be null.
org.springframework.dao.DataAccessException
- if any error occurs.void rename(javax.naming.Name oldDn, javax.naming.Name newDn) throws org.springframework.dao.DataAccessException
oldDn
- The distinguished name of the entry to move; may not be null
or empty.newDn
- The distinguished name where the entry should be moved; may
not be null or empty.
org.springframework.dao.DataIntegrityViolationException
- if newDn is already bound
org.springframework.dao.DataAccessException
- if any other error occurs.void rename(java.lang.String oldDn, java.lang.String newDn) throws org.springframework.dao.DataAccessException
oldDn
- The distinguished name of the entry to move; may not be null
or empty.newDn
- The distinguished name where the entry should be moved; may
not be null or empty.
org.springframework.dao.DataIntegrityViolationException
- if newDn is already bound
org.springframework.dao.DataAccessException
- if any other error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |