framework/src/main/java/org/eclipse/gemini/naming/TraditionalObjectFactoryBuilder.java

/*******************************************************************************
 * Copyright (c) 2010, 2015 Oracle.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution. 
 * The Eclipse Public License is available at
 *     http://www.eclipse.org/legal/epl-v10.html
 * and the Apache License v2.0 is available at 
 *     http://www.opensource.org/licenses/apache2.0.php.
 * You may elect to redistribute this code under either of these licenses.
 *
 * Contributors:
 *     Bob Nettleton (Oracle) - Initial Reference Implementation
 ******************************************************************************/  

package org.eclipse.gemini.naming;

import java.util.Hashtable;

import javax.naming.Context;
import javax.naming.Name;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;
import javax.naming.spi.DirObjectFactory;
import javax.naming.spi.DirectoryManager;
import javax.naming.spi.NamingManager;
import javax.naming.spi.ObjectFactory;
import javax.naming.spi.ObjectFactoryBuilder;

import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;
import org.osgi.service.jndi.JNDIProviderAdmin;

class TraditionalObjectFactoryBuilder implements ObjectFactoryBuilder {

	private static final String JNDI_PROVIDER_ADMIN_INTERFACE = 
		JNDIProviderAdmin.class.getName();
	
	private static final String NAMING_MANAGER_CLASSNAME = 
		NamingManager.class.getName();
	
	private static final String DIRECTORY_MANAGER_CLASSNAME = 
		DirectoryManager.class.getName();
	

	public TraditionalObjectFactoryBuilder() {
	}
	
	@Override
	public ObjectFactory createObjectFactory(Object obj, Hashtable environment) throws NamingException {
		// if the call came from NamingManager
		BundleContext clientBundleContext = 
			BuilderUtils.getBundleContext(environment, NAMING_MANAGER_CLASSNAME);
		
		// if the call came from DirectoryManager
		if(clientBundleContext == null) {
			clientBundleContext = 
				BuilderUtils.getBundleContext(environment, DIRECTORY_MANAGER_CLASSNAME);
		}
		
		return new TraditionalObjectFactory(clientBundleContext);
	}
	
	private static class TraditionalObjectFactory implements DirObjectFactory {

		private final BundleContext m_clientBundleContext;
		
		TraditionalObjectFactory(BundleContext clientBundleContext) {
			m_clientBundleContext = clientBundleContext;
		}
		
		@Override
		public Object getObjectInstance(Object refInfo, Name name, Context context, Hashtable environment) throws Exception {
			ProviderAdminAction providerAdminAction = 
				new NamingManagerAction(refInfo, name, context, environment);
			return resolveObjectWithProviderAdmin(providerAdminAction);
		}
		

		@Override
		public Object getObjectInstance(Object refInfo, Name name, Context context, Hashtable environment, Attributes attributes) throws Exception {
			ProviderAdminAction providerAdminAction = 
				new DirectoryManagerAction(refInfo, name, context, environment, attributes);
			return resolveObjectWithProviderAdmin(providerAdminAction);
		}
		
		
		/**
		 * Utility method used to keep the code for obtaining the JNDIProviderAdmin service in a common place.  This allows
		 * for simpler managing of service references.  
		 * @param providerAdminAction the action to perform on the JNDIProviderAdmin service
		 * @return the result Object of the call to the JNDIProviderAdmin service
		 * @throws Exception 
		 */
		private Object resolveObjectWithProviderAdmin(ProviderAdminAction providerAdminAction) throws Exception {
			if(m_clientBundleContext == null) {
				throw new NamingException("Error in obtaining client's BundleContext");
			} else {
				ServiceReference serviceReference = 
					m_clientBundleContext.getServiceReference(JNDI_PROVIDER_ADMIN_INTERFACE);
				if(serviceReference == null) {
					throw new NamingException("JNDIProviderAdmin service not available, cannot resolve object at this time");
				} else {
					JNDIProviderAdmin providerAdmin = 
						(JNDIProviderAdmin)m_clientBundleContext.getService(serviceReference);
					if(providerAdmin == null) {
						throw new NamingException("JNDIProviderAdmin service not available, cannot resolve object at this time");
					} else {
						final Object resolvedObject = providerAdminAction.runProviderAdminAction(providerAdmin);
						// clean up reference to the provider admin service
						m_clientBundleContext.ungetService(serviceReference);
						// return result
						return resolvedObject;
					}
				}
			}
		}
		
		
	}
	
	/**
	 * Internal interface meant to represent a generic action on the JNDIProviderAdmin service.  
	 *
	 * @version $Revision$
	 */
	private interface ProviderAdminAction {
		Object runProviderAdminAction(JNDIProviderAdmin providerAdmin) throws Exception;
	}
	
	/**
	 * A ProviderAdminAction implementation that follows the behavior of 
	 * NamingManager.getObjectInstance().  
	 *
	 * @version $Revision$
	 */
	private static class NamingManagerAction implements ProviderAdminAction {
		protected final Object m_refInfo;
		protected final Name m_name;
		protected final Context m_context;
		protected final Hashtable m_environment;
		
		NamingManagerAction(Object refInfo, Name name, Context context, Hashtable environment) {
			m_refInfo = refInfo;
			m_name = name;
			m_context = context;
			m_environment = environment;
		}
		
		@Override
		public Object runProviderAdminAction(JNDIProviderAdmin providerAdmin) throws Exception {
			return providerAdmin.getObjectInstance(m_refInfo, m_name, m_context, m_environment);
		}
	}
	
	/**
	 * A ProviderAdminAction implementation that follows the behavior of 
	 * DirectoryManager.getObjectInstance().  
	 *
	 * @version $Revision$
	 */
	private static class DirectoryManagerAction extends NamingManagerAction {
		private final Attributes m_attributes;
		
		DirectoryManagerAction(Object refInfo, Name name, Context context, Hashtable environment, Attributes attributes) {
			super(refInfo, name, context, environment);
			m_attributes = attributes;
		}

		@Override
		public Object runProviderAdminAction(JNDIProviderAdmin providerAdmin) throws Exception {
			return providerAdmin.getObjectInstance(m_refInfo, m_name, m_context, m_environment, m_attributes);
		}
	}
	
}