public class SingleContextSource extends Object implements ContextSource, org.springframework.beans.factory.DisposableBean
ContextSource
to be used as a decorator around a target ContextSource
to make sure the target is never actually closed. Useful when working with e.g. paged results,
as these require the same target to be used.Modifier and Type | Class and Description |
---|---|
static class |
SingleContextSource.NonClosingDirContextInvocationHandler
A proxy for DirContext forwarding all operation to the target DirContext,
but making sure that no
close operations will be performed. |
Constructor and Description |
---|
SingleContextSource(DirContext ctx)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Destroy method that allows the target DirContext to be cleaned up when
the SingleContextSource is not going to be used any more.
|
DirContext |
getContext(String principal,
String credentials)
Gets a
DirContext instance authenticated using the supplied
principal and credentials. |
DirContext |
getReadOnlyContext()
Gets a read-only
DirContext . |
DirContext |
getReadWriteContext()
Gets a read-write
DirContext instance. |
public SingleContextSource(DirContext ctx)
ctx
- the target DirContext.public DirContext getReadOnlyContext() throws NamingException
ContextSource
DirContext
. The returned
DirContext
must be possible to perform read-only operations
on.getReadOnlyContext
in interface ContextSource
NamingException
- if some error occurs creating an DirContext.public DirContext getReadWriteContext() throws NamingException
ContextSource
DirContext
instance.getReadWriteContext
in interface ContextSource
DirContext
instance, never null
.NamingException
- if some error occurs creating an
DirContext
.public DirContext getContext(String principal, String credentials) throws NamingException
ContextSource
DirContext
instance authenticated using the supplied
principal and credentials.getContext
in interface ContextSource
principal
- The principal (typically a distinguished name of a user
in the LDAP tree) to use for authentication.credentials
- The credentials to use for authentication.DirContext
instance, never
null
.NamingException
public void destroy()
destroy
in interface org.springframework.beans.factory.DisposableBean
Copyright © 2005–2015 The Spring LDAP Framework. All rights reserved.