org.springframework.ldap.pool2.DelegatingLdapContext Maven / Gradle / Ivy
/*
* Copyright 2005-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.ldap.pool2;
import javax.naming.NamingException;
import javax.naming.directory.DirContext;
import javax.naming.ldap.Control;
import javax.naming.ldap.ExtendedRequest;
import javax.naming.ldap.ExtendedResponse;
import javax.naming.ldap.LdapContext;
import org.apache.commons.pool2.KeyedObjectPool;
import org.springframework.ldap.pool2.factory.PooledContextSource;
import org.springframework.util.Assert;
/**
* Used by {@link PooledContextSource} to wrap a {@link LdapContext}, delegating most
* methods to the underlying context. This class extends {@link DelegatingDirContext}
* which handles returning the context to the pool on a call to {@link #close()}
*
* @author Eric Dalquist
* @author Anindya Chatterjee
* @since 2.0
*/
public class DelegatingLdapContext extends DelegatingDirContext implements LdapContext {
private LdapContext delegateLdapContext;
/**
* Create a new delegating ldap context for the specified pool, context and context
* type.
* @param keyedObjectPool The pool the delegate context was checked out from.
* @param delegateLdapContext The ldap context to delegate operations to.
* @param dirContextType The type of context, used as a key for the pool.
* @throws IllegalArgumentException if any of the arguments are null
*/
public DelegatingLdapContext(KeyedObjectPool