|
|||||||||
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 children of 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 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 . |
DirContextOperations |
lookupContext(javax.naming.Name dn)
Convenience method to lookup the supplied DN and automatically cast it to DirContextOperations . |
DirContextOperations |
lookupContext(java.lang.String dn)
Convenience method to lookup the supplied DN and automatically cast it to DirContextOperations . |
void |
modifyAttributes(DirContextOperations ctx)
Modify the attributes of the entry referenced by the supplied DirContextOperations instance. |
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 using a particular SearchExecutor . |
void |
search(SearchExecutor se,
NameClassPairCallbackHandler handler,
DirContextProcessor processor)
Perform a search using a particular SearchExecutor and 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 NamingException
SearchExecutor
and context
processor. Use this method only if especially needed - for the most cases
there is an overloaded convenience method which calls this one with
suitable argments. This method handles all the plumbing; getting a
readonly context; looping through the NamingEnumeration
and closing the context and enumeration. The actual search is delegated
to the SearchExecutor and each found NameClassPair
is
passed to the CallbackHandler
. Any encountered
NamingException
will be translated using
LdapUtils.convertLdapException(javax.naming.NamingException)
.
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.
NamingException
- 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 NamingException
SearchExecutor
. Use this
method only if especially needed - for the most cases there is an
overloaded convenience method which calls this one with suitable
argments. This method handles all the plumbing; getting a readonly
context; looping through the NamingEnumeration
and closing
the context and enumeration. The actual search is delegated to the
SearchExecutor
and each found NameClassPair
is passed to the CallbackHandler
. Any encountered
NamingException
will be translated using the
LdapUtils.convertLdapException(javax.naming.NamingException)
.
se
- The SearchExecutor
to use for performing the
actual search.handler
- The NameClassPairCallbackHandler
to which each
found entry will be passed.
NamingException
- if any error occurs. Note that a
NameNotFoundException
will be ignored. Instead
this is interpreted as no entries being found.search(Name, String, AttributesMapper)
,
search(Name, String, ContextMapper)
java.lang.Object executeReadOnly(ContextExecutor ce) throws NamingException
DirContext
,
translating any Exceptions and closing the context afterwards. This
method is not intended for searches; use
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.
NamingException
- if the operation resulted in a NamingException
.search(SearchExecutor, NameClassPairCallbackHandler)
,
search(Name, String, AttributesMapper)
,
search(Name, String, ContextMapper)
java.lang.Object executeReadWrite(ContextExecutor ce) throws NamingException
DirContext
,
translating any exceptions and closing the context afterwards. This
method is intended only for very particular cases, where there is no
suitable method in this interface to use.
ce
- The ContextExecutor
to which the actual
operation on the DirContext
will be delegated.
NamingException
- if the operation resulted in a NamingException
.bind(Name, Object, Attributes)
,
unbind(Name)
,
rebind(Name, Object, Attributes)
,
rename(Name, Name)
,
#modifyAttributes(Name, ModificationItem[]))
void search(javax.naming.Name base, java.lang.String filter, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler) throws NamingException
SearchResult
is supplied to the specified
NameClassPairCallbackHandler
. The
SearchScope
specified in the supplied
SearchControls
will be used in the search. Note that if
you are using a ContextMapper
, the returningObjFlag needs
to be set to true in the SearchControls
.
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
SearchResult
to.
NamingException
- 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) throws NamingException
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
SearchResult
to.
NamingException
- 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, javax.naming.directory.SearchControls controls, NameClassPairCallbackHandler handler, DirContextProcessor processor) throws NamingException
SearchResult
is supplied to the specified
NameClassPairCallbackHandler
. The
SearchScope
specified in the supplied
SearchControls
will be used in the search. Note that if
you are using a ContextMapper
, the returningObjFlag needs
to be set to true in the SearchControls
. The given
DirContextProcessor
will be called before and after the
search.
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
SearchResult
to.processor
- The DirContextProcessor
to use before and after
the search.
NamingException
- 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, DirContextProcessor processor) throws NamingException
SearchResult
is supplied to the specified
AttributesMapper
. The SearchScope
specified in the supplied SearchControls
will be used in
the search. The given DirContextProcessor
will be called
before and after the search.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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) throws NamingException
SearchResult
is supplied to the specified
AttributesMapper
. The SearchScope
specified in the supplied SearchControls
will be used in
the search. The given DirContextProcessor
will be called
before and after the search.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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) throws NamingException
SearchResult
is supplied to the specified
ContextMapper
. The SearchScope
specified
in the supplied SearchControls
will be used in the search.
The given DirContextProcessor
will be called before and
after the search.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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) throws NamingException
SearchResult
is supplied to the specified
ContextMapper
. The SearchScope
specified
in the supplied SearchControls
will be used in the search.
The given DirContextProcessor
will be called before and
after the search.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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) throws NamingException
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.
NamingException
- 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, int searchScope, boolean returningObjFlag, NameClassPairCallbackHandler handler) throws NamingException
SearchResult
is supplied to the specified
NameClassPairCallbackHandler
. Use the specified values
for search scope and return objects flag.
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.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
NameClassPairCallbackHandler
. Use the specified values
for search scope and return objects flag.
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.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
NameClassPairCallbackHandler
. The default Search scope (SearchControls.SUBTREE_SCOPE
)
will be used and the returnObjects flag will be set to false
.
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.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
NameClassPairCallbackHandler
. The default Search scope (SearchControls.SUBTREE_SCOPE
)
will be used and the returnObjects flag will be set to false
.
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.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
. The default search scope will be used.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
. The default search scope will be used.
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.
List
containing all entries received from the
AttributesMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
. Only return the
supplied attributes.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
. Only return the
supplied attributes.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
. The default
search scope (SearchControls.SUBTREE_SCOPE
) will be
used.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
. The default
search scope (SearchControls.SUBTREE_SCOPE
) will be
used.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
Object
returned in each SearchResult
is
supplied to the specified ContextMapper
. The default
search scope (SearchControls.SUBTREE_SCOPE
) will be
used.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
ContextMapper
.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
SearchResult
is supplied to the specified
AttributesMapper
.
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
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.
NamingException
- 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 NamingException
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.
NamingException
- 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 NamingException
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.
List
containing the Objects returned from the
Mapper.
NamingException
- 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 NamingException
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.
List
containing the Objects returned from the
Mapper.
NamingException
- 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 NamingException
base
.
base
- The base DN where the list should be performed.
base
.
NamingException
- 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 NamingException
base
.
base
- The base DN where the list should be performed.
base
.
NamingException
- 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 NamingException
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.
NamingException
- 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 NamingException
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.
NamingException
- 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 NamingException
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.
List
containing the Objects returned from the
Mapper.
NamingException
- 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 NamingException
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.
List
containing the Objects returned from the
Mapper.
NamingException
- 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 NamingException
base
.
base
- The base DN where the list should be performed.
List
containing the names of all the contexts
bound to base
.
NamingException
- 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 NamingException
base
.
base
- The base DN where the list should be performed.
List
containing the names of all the contexts
bound to base
.
NamingException
- 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 NamingException
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
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.
List
containing all entries received from the
ContextMapper
.
NamingException
- 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 NamingException
DirContextAdapter
, unless the DirObjectFactory
has been modified in the ContextSource
.
dn
- The distinguished name of the object to find.
DirContextAdapter
instance.
NamingException
- if any error occurs.lookupContext(Name)
,
AbstractContextSource.setDirObjectFactory(Class)
java.lang.Object lookup(java.lang.String dn) throws NamingException
DirContextAdapter
, unless the DirObjectFactory
has been modified in the ContextSource
.
dn
- The distinguished name of the object to find.
DirContextAdapter
instance.
NamingException
- if any error occurs.lookupContext(String)
,
AbstractContextSource.setDirObjectFactory(Class)
java.lang.Object lookup(javax.naming.Name dn, AttributesMapper mapper) throws NamingException
AttributesMapper
.
dn
- The distinguished name to find.mapper
- The AttributesMapper
to use for mapping the
found object.
NamingException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, AttributesMapper mapper) throws NamingException
AttributesMapper
.
dn
- The distinguished name to find.mapper
- The AttributesMapper
to use for mapping the
found object.
NamingException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, ContextMapper mapper) throws NamingException
ContextMapper
.
dn
- The distinguished name to find.mapper
- The ContextMapper
to use for mapping the found
object.
NamingException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, ContextMapper mapper) throws NamingException
ContextMapper
.
dn
- The distinguished name to find.mapper
- The ContextMapper
to use for mapping the found
object.
NamingException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, java.lang.String[] attributes, AttributesMapper mapper) throws NamingException
AttributesMapper
.
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.
NamingException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, java.lang.String[] attributes, AttributesMapper mapper) throws NamingException
AttributesMapper
.
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.
NamingException
- if any error occurs.java.lang.Object lookup(javax.naming.Name dn, java.lang.String[] attributes, ContextMapper mapper) throws NamingException
ContextMapper
.
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.
NamingException
- if any error occurs.java.lang.Object lookup(java.lang.String dn, java.lang.String[] attributes, ContextMapper mapper) throws NamingException
ContextMapper
.
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.
NamingException
- if any error occurs.void modifyAttributes(javax.naming.Name dn, javax.naming.directory.ModificationItem[] mods) throws NamingException
ModificationItems
.
dn
- The distinguished name of the node to modify.mods
- The modifications to perform.
NamingException
- if any error occurs.modifyAttributes(DirContextOperations)
void modifyAttributes(java.lang.String dn, javax.naming.directory.ModificationItem[] mods) throws NamingException
ModificationItems
.
dn
- The distinguished name of the node to modify.mods
- The modifications to perform.
NamingException
- if any error occurs.modifyAttributes(DirContextOperations)
void bind(javax.naming.Name dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws NamingException
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
.
NamingException
- if any error occurs.DirContextAdapter
void bind(java.lang.String dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws NamingException
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
.
NamingException
- if any error occurs.DirContextAdapter
void unbind(javax.naming.Name dn) throws NamingException
unbind(Name, boolean)
in stead.
dn
- The distinguished name of the entry to remove.
NamingException
- if any error occurs.void unbind(java.lang.String dn) throws NamingException
unbind(Name, boolean)
in stead.
dn
- The distinguished name to unbind.
NamingException
- if any error occurs.void unbind(javax.naming.Name dn, boolean recursive) throws NamingException
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.
NamingException
- if any error occurs.void unbind(java.lang.String dn, boolean recursive) throws NamingException
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.
NamingException
- if any error occurs.void rebind(javax.naming.Name dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws NamingException
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
.
NamingException
- if any error occurs.DirContextAdapter
void rebind(java.lang.String dn, java.lang.Object obj, javax.naming.directory.Attributes attributes) throws NamingException
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
.
NamingException
- if any error occurs.DirContextAdapter
void rename(javax.naming.Name oldDn, javax.naming.Name newDn) throws NamingException
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.
ContextNotEmptyException
- if newDn is already bound
NamingException
- if any other error occurs.void rename(java.lang.String oldDn, java.lang.String newDn) throws NamingException
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.
ContextNotEmptyException
- if newDn is already bound
NamingException
- if any other error occurs.DirContextOperations lookupContext(javax.naming.Name dn) throws NamingException, java.lang.ClassCastException
DirContextOperations
.
dn
- The distinguished name of the object to find.
DirContextOperations
.
java.lang.ClassCastException
- if an alternative DirObjectFactory
has been
registered with the ContextSource
, causing
the actual class of the returned object to be something else
than DirContextOperations
.
NamingException
- if any other error occurs.lookup(Name)
,
modifyAttributes(DirContextOperations)
DirContextOperations lookupContext(java.lang.String dn) throws NamingException, java.lang.ClassCastException
DirContextOperations
.
dn
- The distinguished name of the object to find.
DirContextOperations
.
java.lang.ClassCastException
- if an alternative DirObjectFactory
has been
registered with the ContextSource
, causing
the actual class of the returned object to be something else
than DirContextOperations
.
NamingException
- if any other error occurs.lookup(String)
,
modifyAttributes(DirContextOperations)
void modifyAttributes(DirContextOperations ctx) throws java.lang.IllegalStateException, NamingException
DirContextOperations
instance. The DN to update will be the DN of
the DirContextOperations
instance, and the
ModificationItem
array is retrieved from the
DirContextOperations
instance using a call to
AttributeModificationsAware.getModificationItems()
. NB:
The supplied instance needs to have been properly initialized; this means
that if it hasn't been received from a lookup
operation,
its DN needs to be initialized and it must have been put in update mode (DirContextAdapter.setUpdateMode(boolean)
).
Typical use of this method would be as follows:
public void update(Person person) { DirContextOperations ctx = ldapOperations.lookupContext(person.getDn()); ctx.setAttributeValue("description", person.getDescription()); ctx.setAttributeValue("telephoneNumber", person.getPhone()); // More modifications here ldapOperations.modifyAttributes(ctx); }
ctx
- the DirContextOperations instance to use in the update.
java.lang.IllegalStateException
- if the supplied instance is not in update mode or has not
been properly initialized.
NamingException
- if any other error occurs.lookupContext(Name)
,
DirContextAdapter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |