1 /*
2 * Copyright 1999-2004 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any 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 initial context factories.
33 *<p>
34 * The JNDI framework allows for different initial context implementations
35 * to be specified at runtime. An initial context is created using
36 * an initial context factory. A program can install its own builder
37 * that creates initial context factories, thereby overriding the
38 * default policies used by the framework, by calling
39 * NamingManager.setInitialContextFactoryBuilder().
40 * The InitialContextFactoryBuilder interface must be implemented by
41 * such a builder.
42 *
43 * @author Rosanna Lee
44 * @author Scott Seligman
45 *
46 * @see InitialContextFactory
47 * @see NamingManager#getInitialContext
48 * @see NamingManager#setInitialContextFactoryBuilder
49 * @see NamingManager#hasInitialContextFactoryBuilder
50 * @see javax.naming.InitialContext
51 * @see javax.naming.directory.InitialDirContext
52 * @since 1.3
53 */
54 public interface InitialContextFactoryBuilder {
55 /**
56 * Creates an initial context factory using the specified
57 * environment.
58 *<p>
59 * The environment parameter is owned by the caller.
60 * The implementation will not modify the object or keep a reference
61 * to it, although it may keep a reference to a clone or copy.
62 *
63 * @param environment Environment used in creating an initial
64 * context implementation. Can be null.
65 * @return A non-null initial context factory.
66 * @exception NamingException If an initial context factory could not be created.
67 */
68 public InitialContextFactory
69 createInitialContextFactory(Hashtable<?,?> environment)
70 throws NamingException;
71 }
Save This Page