Class DelegatingDirContext

java.lang.Object

org.springframework.ldap.pool.DelegatingContext

org.springframework.ldap.pool.DelegatingDirContext

All Implemented Interfaces:

Context, DirContext, DirContextProxy

Direct Known Subclasses:

DelegatingLdapContext

public class DelegatingDirContext
extends DelegatingContext
implements DirContext, DirContextProxy

Used by PoolingContextSource to wrap a DirContext, delegating most methods to the underlying context. This class extends DelegatingContext which handles returning the context to the pool on a call to close()

Field Summary

Fields inherited from interface Context

AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES

Fields inherited from interface DirContext

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
DelegatingDirContext(org.apache.commons.pool.KeyedObjectPool keyedObjectPool, DirContext delegateDirContext, DirContextType dirContextType)	Create a new delegating dir context for the specified pool, context and context type.

Method Summary

Modifier and Type	Method	Description
protected void	assertOpen()	Assert that this context is still open.
void	bind(String name, Object obj, Attributes attrs)
void	bind(Name name, Object obj, Attributes attrs)
void	close()
DirContext	createSubcontext(String name, Attributes attrs)
DirContext	createSubcontext(Name name, Attributes attrs)
boolean	equals(Object obj)
Attributes	getAttributes(String name)
Attributes	getAttributes(String name, String[] attrIds)
Attributes	getAttributes(Name name)
Attributes	getAttributes(Name name, String[] attrIds)
@Nullable Context	getDelegateContext()	Get the direct delegate for this context proxy.
@Nullable DirContext	getDelegateDirContext()	Get the direct delegate for this dir context proxy.
@Nullable DirContext	getInnermostDelegateDirContext()	Recursivley inspect delegates until a non-delegating dir context is found.
DirContext	getSchema(String name)
DirContext	getSchema(Name name)
DirContext	getSchemaClassDefinition(String name)
DirContext	getSchemaClassDefinition(Name name)
DirContext	getTargetContext()	Get the target DirContext of the proxy.
int	hashCode()
void	modifyAttributes(String name, int modOp, Attributes attrs)
void	modifyAttributes(String name, ModificationItem[] mods)
void	modifyAttributes(Name name, int modOp, Attributes attrs)
void	modifyAttributes(Name name, ModificationItem[] mods)
void	rebind(String name, Object obj, Attributes attrs)
void	rebind(Name name, Object obj, Attributes attrs)
NamingEnumeration<SearchResult>	search(String name, String filterExpr, Object[] filterArgs, SearchControls cons)
NamingEnumeration<SearchResult>	search(String name, String filter, SearchControls cons)
NamingEnumeration<SearchResult>	search(String name, Attributes matchingAttributes)
NamingEnumeration<SearchResult>	search(String name, Attributes matchingAttributes, String[] attributesToReturn)
NamingEnumeration<SearchResult>	search(Name name, String filterExpr, Object[] filterArgs, SearchControls cons)
NamingEnumeration<SearchResult>	search(Name name, String filter, SearchControls cons)
NamingEnumeration<SearchResult>	search(Name name, Attributes matchingAttributes)
NamingEnumeration<SearchResult>	search(Name name, Attributes matchingAttributes, String[] attributesToReturn)
String	toString()

Methods inherited from class DelegatingContext

addToEnvironment, bind, bind, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getInnermostDelegateContext, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Context

addToEnvironment, bind, bind, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

Constructor Details

DelegatingDirContext

public DelegatingDirContext(org.apache.commons.pool.KeyedObjectPool keyedObjectPool,
 DirContext delegateDirContext,
 DirContextType dirContextType)

Create a new delegating dir context for the specified pool, context and context type.

Parameters:

keyedObjectPool - The pool the delegate context was checked out from.

delegateDirContext - The dir context to delegate operations to.

dirContextType - The type of context, used as a key for the pool.

Throws:

IllegalArgumentException - if any of the arguments are null

Method Details

getDelegateDirContext

public @Nullable DirContext getDelegateDirContext()

Get the direct delegate for this dir context proxy.

Returns:

The direct delegate for this dir context proxy

getDelegateContext

public @Nullable Context getDelegateContext()

Description copied from class: DelegatingContext

Get the direct delegate for this context proxy.

Overrides:

getDelegateContext in class DelegatingContext

Returns:

The direct delegate for this context proxy

getInnermostDelegateDirContext

public @Nullable DirContext getInnermostDelegateDirContext()

Recursivley inspect delegates until a non-delegating dir context is found.

Returns:

The innermost (real) DirContext that is being delegated to.

assertOpen

protected void assertOpen()
                   throws NamingException

Description copied from class: DelegatingContext

Assert that this context is still open.

Overrides:

assertOpen in class DelegatingContext

Throws:

NamingException - If the delegate is null, DelegatingContext.close() has been called.

equals

public boolean equals(Object obj)

Overrides:

equals in class DelegatingContext

hashCode

public int hashCode()

Overrides:

hashCode in class DelegatingContext

toString

public String toString()

Overrides:

toString in class DelegatingContext

getTargetContext

public DirContext getTargetContext()

Description copied from interface: DirContextProxy

Get the target DirContext of the proxy.

Specified by:

getTargetContext in interface DirContextProxy

Returns:

the target DirContext.

bind

public void bind(Name name,
 Object obj,
 Attributes attrs)
          throws NamingException

Specified by:

bind in interface DirContext

Throws:

NamingException

bind

public void bind(String name,
 Object obj,
 Attributes attrs)
          throws NamingException

Specified by:

bind in interface DirContext

Throws:

NamingException

createSubcontext

public DirContext createSubcontext(Name name,
 Attributes attrs)
                            throws NamingException

Specified by:

createSubcontext in interface DirContext

Throws:

NamingException

createSubcontext

public DirContext createSubcontext(String name,
 Attributes attrs)
                            throws NamingException

Specified by:

createSubcontext in interface DirContext

Throws:

NamingException

getAttributes

public Attributes getAttributes(Name name,
 String[] attrIds)
                         throws NamingException

Specified by:

getAttributes in interface DirContext

Throws:

NamingException

getAttributes

public Attributes getAttributes(Name name)
                         throws NamingException

Specified by:

getAttributes in interface DirContext

Throws:

NamingException

getAttributes

public Attributes getAttributes(String name,
 String[] attrIds)
                         throws NamingException

Specified by:

getAttributes in interface DirContext

Throws:

NamingException

getAttributes

public Attributes getAttributes(String name)
                         throws NamingException

Specified by:

getAttributes in interface DirContext

Throws:

NamingException

getSchema

public DirContext getSchema(Name name)
                     throws NamingException

Specified by:

getSchema in interface DirContext

Throws:

NamingException

getSchema

public DirContext getSchema(String name)
                     throws NamingException

Specified by:

getSchema in interface DirContext

Throws:

NamingException

getSchemaClassDefinition

public DirContext getSchemaClassDefinition(Name name)
                                    throws NamingException

Specified by:

getSchemaClassDefinition in interface DirContext

Throws:

NamingException

getSchemaClassDefinition

public DirContext getSchemaClassDefinition(String name)
                                    throws NamingException

Specified by:

getSchemaClassDefinition in interface DirContext

Throws:

NamingException

modifyAttributes

public void modifyAttributes(Name name,
 int modOp,
 Attributes attrs)
                      throws NamingException

Specified by:

modifyAttributes in interface DirContext

Throws:

NamingException

modifyAttributes

public void modifyAttributes(Name name,
 ModificationItem[] mods)
                      throws NamingException

Specified by:

modifyAttributes in interface DirContext

Throws:

NamingException

modifyAttributes

public void modifyAttributes(String name,
 int modOp,
 Attributes attrs)
                      throws NamingException

Specified by:

modifyAttributes in interface DirContext

Throws:

NamingException

modifyAttributes

public void modifyAttributes(String name,
 ModificationItem[] mods)
                      throws NamingException

Specified by:

modifyAttributes in interface DirContext

Throws:

NamingException

rebind

public void rebind(Name name,
 Object obj,
 Attributes attrs)
            throws NamingException

Specified by:

rebind in interface DirContext

Throws:

NamingException

rebind

public void rebind(String name,
 Object obj,
 Attributes attrs)
            throws NamingException

Specified by:

rebind in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(Name name,
 Attributes matchingAttributes,
 String[] attributesToReturn)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(Name name,
 Attributes matchingAttributes)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(Name name,
 String filterExpr,
 Object[] filterArgs,
 SearchControls cons)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(Name name,
 String filter,
 SearchControls cons)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(String name,
 Attributes matchingAttributes,
 String[] attributesToReturn)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(String name,
 Attributes matchingAttributes)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(String name,
 String filterExpr,
 Object[] filterArgs,
 SearchControls cons)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

search

public NamingEnumeration<SearchResult> search(String name,
 String filter,
 SearchControls cons)
                                       throws NamingException

Specified by:

search in interface DirContext

Throws:

NamingException

close

public void close()
           throws NamingException

Specified by:

close in interface Context

Overrides:

close in class DelegatingContext

Throws:

NamingException