Source for javax.naming.spi.InitialContextFactory

   1: /* InitialContextFactory.java --
   2:    Copyright (C) 2000, 2004  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.naming.spi;
  40: 
  41: import java.util.Hashtable;
  42: 
  43: import javax.naming.Context;
  44: import javax.naming.NamingException;
  45: 
  46: /**
  47:  * <p>
  48:  * Defines a factory that creates the initial context for the beginning of the
  49:  * name resolution. JNDI allows to specify different implementations of the
  50:  * initial context at runtime.
  51:  * </p>
  52:  * <p>
  53:  * The class, implementing this interface, must be public and have a public
  54:  * parameterless constructor
  55:  * </p>
  56:  */
  57: public interface InitialContextFactory
  58: {
  59:   /**
  60:    * Create a new initial context
  61:    * 
  62:    * @param environment the properties, used when creating the context. The
  63:    *          implementing class will not modify the table nor keep the
  64:    *          reference to it. After the method returns, the caller can safely
  65:    *          reuse the table for other purposes.
  66:    * @return the new initial context
  67:    * @throws NamingException if the naming exception has occured
  68:    */
  69:   Context getInitialContext (Hashtable<?, ?> environment)
  70:     throws NamingException;
  71: }