01 /*
02 * Copyright 1999-2004 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * 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.*;
30
31 /**
32 * This interface represents a factory that creates an initial context.
33 *<p>
34 * The JNDI framework allows for different initial context implementations
35 * to be specified at runtime. The initial context is created using
36 * an <em>initial context factory</em>.
37 * An initial context factory must implement the InitialContextFactory
38 * interface, which provides a method for creating instances of initial
39 * context that implement the Context interface.
40 * In addition, the factory class must be public and must have a public
41 * constructor that accepts no arguments.
42 *
43 * @author Rosanna Lee
44 * @author Scott Seligman
45 * @version 1.17 07/05/05
46 *
47 * @see InitialContextFactoryBuilder
48 * @see NamingManager#getInitialContext
49 * @see javax.naming.InitialContext
50 * @see javax.naming.directory.InitialDirContext
51 * @since 1.3
52 */
53
54 public interface InitialContextFactory {
55 /**
56 * Creates an Initial Context for beginning name resolution.
57 * Special requirements of this context are supplied
58 * using <code>environment</code>.
59 *<p>
60 * The environment parameter is owned by the caller.
61 * The implementation will not modify the object or keep a reference
62 * to it, although it may keep a reference to a clone or copy.
63 *
64 * @param environment The possibly null environment
65 * specifying information to be used in the creation
66 * of the initial context.
67 * @return A non-null initial context object that implements the Context
68 * interface.
69 * @exception NamingException If cannot create an initial context.
70 */
71 public Context getInitialContext(Hashtable<?, ?> environment)
72 throws NamingException;
73 }
|