org.springframework.ldap.pool
Class DelegatingDirContext
java.lang.Object
org.springframework.ldap.pool.DelegatingContext
org.springframework.ldap.pool.DelegatingDirContext
- All Implemented Interfaces:
- javax.naming.Context, javax.naming.directory.DirContext, DirContextProxy
- Direct Known Subclasses:
- DelegatingLdapContext
public class DelegatingDirContext
- extends DelegatingContext
- implements javax.naming.directory.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()
- Author:
- Eric Dalquist
Fields inherited from interface javax.naming.directory.DirContext |
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE |
Fields inherited from interface javax.naming.Context |
APPLET, 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 |
Constructor Summary |
DelegatingDirContext(org.apache.commons.pool.KeyedObjectPool keyedObjectPool,
javax.naming.directory.DirContext delegateDirContext,
DirContextType dirContextType)
Create a new delegating dir context for the specified pool, context and context type. |
Method Summary |
protected void |
assertOpen()
|
void |
bind(javax.naming.Name name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
|
void |
bind(java.lang.String name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
|
void |
close()
|
javax.naming.directory.DirContext |
createSubcontext(javax.naming.Name name,
javax.naming.directory.Attributes attrs)
|
javax.naming.directory.DirContext |
createSubcontext(java.lang.String name,
javax.naming.directory.Attributes attrs)
|
boolean |
equals(java.lang.Object obj)
|
javax.naming.directory.Attributes |
getAttributes(javax.naming.Name name)
|
javax.naming.directory.Attributes |
getAttributes(javax.naming.Name name,
java.lang.String[] attrIds)
|
javax.naming.directory.Attributes |
getAttributes(java.lang.String name)
|
javax.naming.directory.Attributes |
getAttributes(java.lang.String name,
java.lang.String[] attrIds)
|
javax.naming.Context |
getDelegateContext()
|
javax.naming.directory.DirContext |
getDelegateDirContext()
|
javax.naming.directory.DirContext |
getInnermostDelegateDirContext()
Recursivley inspect delegates until a non-delegating dir context is found. |
javax.naming.directory.DirContext |
getSchema(javax.naming.Name name)
|
javax.naming.directory.DirContext |
getSchema(java.lang.String name)
|
javax.naming.directory.DirContext |
getSchemaClassDefinition(javax.naming.Name name)
|
javax.naming.directory.DirContext |
getSchemaClassDefinition(java.lang.String name)
|
javax.naming.directory.DirContext |
getTargetContext()
Get the target DirContext of the proxy. |
int |
hashCode()
|
void |
modifyAttributes(javax.naming.Name name,
int mod_op,
javax.naming.directory.Attributes attrs)
|
void |
modifyAttributes(javax.naming.Name name,
javax.naming.directory.ModificationItem[] mods)
|
void |
modifyAttributes(java.lang.String name,
int mod_op,
javax.naming.directory.Attributes attrs)
|
void |
modifyAttributes(java.lang.String name,
javax.naming.directory.ModificationItem[] mods)
|
void |
rebind(javax.naming.Name name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
|
void |
rebind(java.lang.String name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
|
javax.naming.NamingEnumeration |
search(javax.naming.Name name,
javax.naming.directory.Attributes matchingAttributes)
|
javax.naming.NamingEnumeration |
search(javax.naming.Name name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
|
javax.naming.NamingEnumeration |
search(javax.naming.Name name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
|
javax.naming.NamingEnumeration |
search(javax.naming.Name name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
|
javax.naming.NamingEnumeration |
search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes)
|
javax.naming.NamingEnumeration |
search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
|
javax.naming.NamingEnumeration |
search(java.lang.String name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
|
javax.naming.NamingEnumeration |
search(java.lang.String name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
|
java.lang.String |
toString()
|
Methods inherited from class org.springframework.ldap.pool.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 java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.naming.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 |
DelegatingDirContext
public DelegatingDirContext(org.apache.commons.pool.KeyedObjectPool keyedObjectPool,
javax.naming.directory.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:
java.lang.IllegalArgumentException
- if any of the arguments are null
getDelegateDirContext
public javax.naming.directory.DirContext getDelegateDirContext()
- Returns:
- The direct delegate for this dir context proxy
getDelegateContext
public javax.naming.Context getDelegateContext()
- Overrides:
getDelegateContext
in class DelegatingContext
- Returns:
- The direct delegate for this context proxy
getInnermostDelegateDirContext
public javax.naming.directory.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 javax.naming.NamingException
- Overrides:
assertOpen
in class DelegatingContext
- Throws:
javax.naming.NamingException
- If the delegate is null, DelegatingContext.close()
has been called.
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in class DelegatingContext
- See Also:
Object.equals(java.lang.Object)
hashCode
public int hashCode()
- Overrides:
hashCode
in class DelegatingContext
- See Also:
Object.hashCode()
toString
public java.lang.String toString()
- Overrides:
toString
in class DelegatingContext
- See Also:
Object.toString()
getTargetContext
public javax.naming.directory.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(javax.naming.Name name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
bind
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.bind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes)
bind
public void bind(java.lang.String name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
bind
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.bind(java.lang.String, java.lang.Object, javax.naming.directory.Attributes)
createSubcontext
public javax.naming.directory.DirContext createSubcontext(javax.naming.Name name,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
createSubcontext
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.createSubcontext(javax.naming.Name, javax.naming.directory.Attributes)
createSubcontext
public javax.naming.directory.DirContext createSubcontext(java.lang.String name,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
createSubcontext
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.createSubcontext(java.lang.String, javax.naming.directory.Attributes)
getAttributes
public javax.naming.directory.Attributes getAttributes(javax.naming.Name name,
java.lang.String[] attrIds)
throws javax.naming.NamingException
- Specified by:
getAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getAttributes(javax.naming.Name, java.lang.String[])
getAttributes
public javax.naming.directory.Attributes getAttributes(javax.naming.Name name)
throws javax.naming.NamingException
- Specified by:
getAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getAttributes(javax.naming.Name)
getAttributes
public javax.naming.directory.Attributes getAttributes(java.lang.String name,
java.lang.String[] attrIds)
throws javax.naming.NamingException
- Specified by:
getAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getAttributes(java.lang.String, java.lang.String[])
getAttributes
public javax.naming.directory.Attributes getAttributes(java.lang.String name)
throws javax.naming.NamingException
- Specified by:
getAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getAttributes(java.lang.String)
getSchema
public javax.naming.directory.DirContext getSchema(javax.naming.Name name)
throws javax.naming.NamingException
- Specified by:
getSchema
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getSchema(javax.naming.Name)
getSchema
public javax.naming.directory.DirContext getSchema(java.lang.String name)
throws javax.naming.NamingException
- Specified by:
getSchema
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getSchema(java.lang.String)
getSchemaClassDefinition
public javax.naming.directory.DirContext getSchemaClassDefinition(javax.naming.Name name)
throws javax.naming.NamingException
- Specified by:
getSchemaClassDefinition
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getSchemaClassDefinition(javax.naming.Name)
getSchemaClassDefinition
public javax.naming.directory.DirContext getSchemaClassDefinition(java.lang.String name)
throws javax.naming.NamingException
- Specified by:
getSchemaClassDefinition
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.getSchemaClassDefinition(java.lang.String)
modifyAttributes
public void modifyAttributes(javax.naming.Name name,
int mod_op,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
modifyAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes)
modifyAttributes
public void modifyAttributes(javax.naming.Name name,
javax.naming.directory.ModificationItem[] mods)
throws javax.naming.NamingException
- Specified by:
modifyAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.modifyAttributes(javax.naming.Name, javax.naming.directory.ModificationItem[])
modifyAttributes
public void modifyAttributes(java.lang.String name,
int mod_op,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
modifyAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.modifyAttributes(java.lang.String, int, javax.naming.directory.Attributes)
modifyAttributes
public void modifyAttributes(java.lang.String name,
javax.naming.directory.ModificationItem[] mods)
throws javax.naming.NamingException
- Specified by:
modifyAttributes
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.modifyAttributes(java.lang.String, javax.naming.directory.ModificationItem[])
rebind
public void rebind(javax.naming.Name name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
rebind
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.rebind(javax.naming.Name, java.lang.Object, javax.naming.directory.Attributes)
rebind
public void rebind(java.lang.String name,
java.lang.Object obj,
javax.naming.directory.Attributes attrs)
throws javax.naming.NamingException
- Specified by:
rebind
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.rebind(java.lang.String, java.lang.Object, javax.naming.directory.Attributes)
search
public javax.naming.NamingEnumeration search(javax.naming.Name name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(javax.naming.Name, javax.naming.directory.Attributes, java.lang.String[])
search
public javax.naming.NamingEnumeration search(javax.naming.Name name,
javax.naming.directory.Attributes matchingAttributes)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(javax.naming.Name, javax.naming.directory.Attributes)
search
public javax.naming.NamingEnumeration search(javax.naming.Name name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(javax.naming.Name, java.lang.String, java.lang.Object[], javax.naming.directory.SearchControls)
search
public javax.naming.NamingEnumeration search(javax.naming.Name name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(javax.naming.Name, java.lang.String, javax.naming.directory.SearchControls)
search
public javax.naming.NamingEnumeration search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(java.lang.String, javax.naming.directory.Attributes, java.lang.String[])
search
public javax.naming.NamingEnumeration search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(java.lang.String, javax.naming.directory.Attributes)
search
public javax.naming.NamingEnumeration search(java.lang.String name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(java.lang.String, java.lang.String, java.lang.Object[], javax.naming.directory.SearchControls)
search
public javax.naming.NamingEnumeration search(java.lang.String name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
throws javax.naming.NamingException
- Specified by:
search
in interface javax.naming.directory.DirContext
- Throws:
javax.naming.NamingException
- See Also:
DirContext.search(java.lang.String, java.lang.String, javax.naming.directory.SearchControls)
close
public void close()
throws javax.naming.NamingException
- Specified by:
close
in interface javax.naming.Context
- Overrides:
close
in class DelegatingContext
- Throws:
javax.naming.NamingException
- See Also:
DelegatingContext.close()
Copyright (c) 2005-2007. All Rights Reserved.