1 /* 2 * Copyright (c) 1999, 2004, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javax.naming.spi; 27 28 import java.util.Hashtable; 29 import javax.naming.NamingException; 30 31 /** 32 * This interface represents a builder that creates object factories. 33 *<p> 34 * The JNDI framework allows for object implementations to 35 * be loaded in dynamically via <em>object factories</em>. 36 * For example, when looking up a printer bound in the name space, 37 * if the print service binds printer names to References, the printer 38 * Reference could be used to create a printer object, so that 39 * the caller of lookup can directly operate on the printer object 40 * after the lookup. An ObjectFactory is responsible for creating 41 * objects of a specific type. JNDI uses a default policy for using 42 * and loading object factories. You can override this default policy 43 * by calling <tt>NamingManager.setObjectFactoryBuilder()</tt> with an ObjectFactoryBuilder, 44 * which contains the program-defined way of creating/loading 45 * object factories. 46 * Any <tt>ObjectFactoryBuilder</tt> implementation must implement this 47 * interface that for creating object factories. 48 * 49 * @author Rosanna Lee 50 * @author Scott Seligman 51 * 52 * @see ObjectFactory 53 * @see NamingManager#getObjectInstance 54 * @see NamingManager#setObjectFactoryBuilder 55 * @since 1.3 56 */ 57 public interface ObjectFactoryBuilder { 58 /** 59 * Creates a new object factory using the environment supplied. 60 *<p> 61 * The environment parameter is owned by the caller. 62 * The implementation will not modify the object or keep a reference 63 * to it, although it may keep a reference to a clone or copy. 64 * 65 * @param obj The possibly null object for which to create a factory. 66 * @param environment Environment to use when creating the factory. 67 * Can be null. 68 * @return A non-null new instance of an ObjectFactory. 69 * @exception NamingException If an object factory cannot be created. 70 * 71 */ 72 public ObjectFactory createObjectFactory(Object obj, 73 Hashtable<?,?> environment) 74 throws NamingException; 75 }