Class DelegatingLdapContext

java.lang.Object

org.springframework.ldap.pool2.DelegatingContext

org.springframework.ldap.pool2.DelegatingDirContext

org.springframework.ldap.pool2.DelegatingLdapContext

All Implemented Interfaces:

Context, DirContext, LdapContext, DirContextProxy

Direct Known Subclasses:

MutableDelegatingLdapContext

public class DelegatingLdapContext
extends DelegatingDirContext
implements LdapContext

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

Since:

2.0

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

Fields inherited from interface LdapContext

CONTROL_FACTORIES

Constructor Summary

Constructors

Constructor	Description
DelegatingLdapContext(org.apache.commons.pool2.KeyedObjectPool<Object,Object> keyedObjectPool, LdapContext delegateLdapContext, DirContextType dirContextType)	Create a new delegating ldap context for the specified pool, context and context type.

Method Summary

Modifier and Type	Method	Description
protected void	assertOpen()	Assert that the delegate context is still open.
void	close()
boolean	equals(Object obj)
ExtendedResponse	extendedOperation(ExtendedRequest request)
Control[]	getConnectControls()
@Nullable DirContext	getDelegateDirContext()	Get the direct delegate for this dir context proxy.
@Nullable LdapContext	getDelegateLdapContext()	Get the direct delegate for this ldap context proxy.
@Nullable LdapContext	getInnermostDelegateLdapContext()	Recursivley inspect delegates until a non-delegating ldap context is found.
Control[]	getRequestControls()
Control[]	getResponseControls()
int	hashCode()
LdapContext	newInstance(Control[] requestControls)
void	reconnect(Control[] connCtls)
void	setRequestControls(Control[] requestControls)
String	toString()

Methods inherited from class DelegatingDirContext

bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getDelegateContext, getInnermostDelegateDirContext, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, getTargetContext, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

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

Methods inherited from interface DirContext

bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

Constructor Details

DelegatingLdapContext

public DelegatingLdapContext(org.apache.commons.pool2.KeyedObjectPool<Object,Object> keyedObjectPool,
 LdapContext delegateLdapContext,
 DirContextType dirContextType)

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

Parameters:

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

delegateLdapContext - The ldap 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

getDelegateLdapContext

public @Nullable LdapContext getDelegateLdapContext()

Get the direct delegate for this ldap context proxy.

Returns:

The direct delegate for this ldap context proxy

getDelegateDirContext

public @Nullable DirContext getDelegateDirContext()

Description copied from class: DelegatingDirContext

Get the direct delegate for this dir context proxy.

Overrides:

getDelegateDirContext in class DelegatingDirContext

Returns:

The direct delegate for this dir context proxy

getInnermostDelegateLdapContext

public @Nullable LdapContext getInnermostDelegateLdapContext()

Recursivley inspect delegates until a non-delegating ldap 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 the delegate context is still open.

Overrides:

assertOpen in class DelegatingDirContext

Throws:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class DelegatingDirContext

hashCode

public int hashCode()

Overrides:

hashCode in class DelegatingDirContext

toString

public String toString()

Overrides:

toString in class DelegatingDirContext

extendedOperation

public ExtendedResponse extendedOperation(ExtendedRequest request)
                                   throws NamingException

Specified by:

extendedOperation in interface LdapContext

Throws:

NamingException

getConnectControls

public Control[] getConnectControls()
                             throws NamingException

Specified by:

getConnectControls in interface LdapContext

Throws:

NamingException

getRequestControls

public Control[] getRequestControls()
                             throws NamingException

Specified by:

getRequestControls in interface LdapContext

Throws:

NamingException

getResponseControls

public Control[] getResponseControls()
                              throws NamingException

Specified by:

getResponseControls in interface LdapContext

Throws:

NamingException

newInstance

public LdapContext newInstance(Control[] requestControls)
                        throws NamingException

Specified by:

newInstance in interface LdapContext

Throws:

NamingException

reconnect

public void reconnect(Control[] connCtls)
               throws NamingException

Specified by:

reconnect in interface LdapContext

Throws:

NamingException

setRequestControls

public void setRequestControls(Control[] requestControls)
                        throws NamingException

Specified by:

setRequestControls in interface LdapContext

Throws:

NamingException

close

public void close()
           throws NamingException

Specified by:

close in interface Context

Overrides:

close in class DelegatingDirContext

Throws:

NamingException