org.springframework.ldap.pool2.factory.DirContextPooledObjectFactory 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.factory;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import javax.naming.CommunicationException;
import javax.naming.directory.DirContext;

import org.apache.commons.pool2.BaseKeyedPooledObjectFactory;
import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.impl.DefaultPooledObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.ldap.core.ContextSource;
import org.springframework.ldap.core.DirContextProxy;
import org.springframework.ldap.pool2.DirContextType;
import org.springframework.ldap.pool2.FailureAwareContext;
import org.springframework.ldap.pool2.validation.DirContextValidator;
import org.springframework.ldap.support.LdapUtils;
import org.springframework.util.Assert;

/**
 * Factory that creates {@link DirContext} instances for pooling via a configured
 * {@link ContextSource}. The {@link DirContext}s are keyed based on if they are read only
 * or read/write. The expected key type is the
 * {@link org.springframework.ldap.pool2.DirContextType} enum.
 *
 * 

 * 

 * Configuration:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Property Description Required Default
contextSource The {@link ContextSource} to get {@link DirContext}s from for adding
 * to the pool. Yes null
dirContextValidator The {@link DirContextValidator} to use to validate
 * {@link DirContext}s. This is only required if the pool has validation of any kind
 * turned on. No null
 *
 * @author Eric Dalquist
 * [email protected]
 * @author Mattias Hellborg Arthursson
 * @author Anindya Chatterjee
 * @since 2.0
 */
class DirContextPooledObjectFactory extends BaseKeyedPooledObjectFactory {

	/**
	 * Logger for this class and subclasses
	 */
	protected final Logger logger = LoggerFactory.getLogger(this.getClass());

	private static final Set> DEFAULT_NONTRANSIENT_EXCEPTIONS = new HashSet>();

	static {
		DEFAULT_NONTRANSIENT_EXCEPTIONS.add(CommunicationException.class);
	};

	private ContextSource contextSource;

	private DirContextValidator dirContextValidator;

	private Set> nonTransientExceptions = DEFAULT_NONTRANSIENT_EXCEPTIONS;

	void setNonTransientExceptions(Collection> nonTransientExceptions) {
		this.nonTransientExceptions = new HashSet>(nonTransientExceptions);
	}

	/**
	 * @return the contextSource
	 */
	ContextSource getContextSource() {
		return this.contextSource;
	}

	/**
	 * @param contextSource the contextSource to set
	 */
	void setContextSource(ContextSource contextSource) {
		if (contextSource == null) {
			throw new IllegalArgumentException("contextSource may not be null");
		}

		this.contextSource = contextSource;
	}

	/**
	 * @return the dirContextValidator
	 */
	DirContextValidator getDirContextValidator() {
		return this.dirContextValidator;
	}

	/**
	 * @param dirContextValidator the dirContextValidator to set
	 */
	void setDirContextValidator(DirContextValidator dirContextValidator) {
		if (dirContextValidator == null) {
			throw new IllegalArgumentException("dirContextValidator may not be null");
		}

		this.dirContextValidator = dirContextValidator;
	}

	private Object makeFailureAwareProxy(DirContext readOnlyContext) {
		return Proxy.newProxyInstance(DirContextProxy.class.getClassLoader(), new Class[] {
				LdapUtils.getActualTargetClass(readOnlyContext), DirContextProxy.class, FailureAwareContext.class },
				new FailureAwareContextProxy(readOnlyContext));
	}

	/**
	 * @see BaseKeyedPooledObjectFactory#validateObject(Object, PooledObject)
	 *
	 */
	@Override
	public boolean validateObject(Object key, PooledObject
Property	Description	Required	Default
contextSource	The {@link ContextSource} to get {@link DirContext}s from for adding * to the pool.	Yes	null
dirContextValidator	The {@link DirContextValidator} to use to validate * {@link DirContext}s. This is only required if the pool has validation of any kind * turned on.	No	null