Source for javax.naming.spi.InitialContextFactoryBuilder

   1: /* --
   2:    Copyright (C) 2000, 2004  Free Software Foundation, Inc.
   4: This file is part of GNU Classpath.
   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.
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  14: General Public License for more details.
  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.
  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.
  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. */
  39: package javax.naming.spi;
  41: import java.util.Hashtable;
  43: import javax.naming.NamingException;
  45: /**
  46:  * Represents the builder that creates instances of the factories that produce
  47:  * initial naming contexts. JNDI allows to specifiy different initial contexts
  48:  * at runtime. The user program can install its own initial context factory
  49:  * builder.
  50:  *
  51:  * @see NamingManager#setInitialContextFactoryBuilder
  52:  */
  53: public interface InitialContextFactoryBuilder
  54: {
  55:   /**
  56:    * Create the new initial context factory
  57:    *
  58:    * @param environment the properties, used for creation of the initial
  59:    * context factory. The parameter is owned by the caller: it is safe to reuse
  60:    * the table for other purposes after the method returns.
  61:    * @return the created initial context factory, never null.
  62:    * @throws NamingException on failure
  63:    */
  64:   InitialContextFactory createInitialContextFactory (Hashtable<?, ?> environment)
  65:     throws NamingException;
  66: }