001/* ObjectFactory.java --
002   Copyright (C) 2001, 2004, 2006  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.naming.spi;
040
041import java.util.Hashtable;
042
043import javax.naming.Context;
044import javax.naming.Name;
045
046/**
047 * Represents a factory for creating the object. ObjectFactory performs the
048 * operation, that is the opposite to the operation, performed by the
049 * {@link StateFactory}. Classes, implementing this interface, must be public
050 * and have public parameterless constructor.
051 */
052public interface ObjectFactory
053{
054  /**
055   * Creates the object, using the specified name and location information. The
056   * call of this method must be thread safe.
057   *
058   * @param refObj may provide the reference and location information. Can be null.
059   * @param name the name of the new object in the scope of the specified naming
060   *          context. Can be null if the name is not specified.
061   * @param nameCtx the context, in which the object name is specified. Can be
062   *          null if the name is specified in the scope of the default initial
063   *          context.
064   * @param environment the properties, providing additional information on how
065   *          to create an object. Can be null if not additional information is
066   *          provided.
067   * @return the newly created object or null if the object cannot be created
068   * @throws Exception if this factory suggest not to try creating of this
069   *           object by other alternative factories
070   *
071   * @see NamingManager#getObjectInstance(Object, Name, Context, Hashtable)
072   */
073  Object getObjectInstance (Object refObj, Name name, Context nameCtx,
074                            Hashtable<?, ?> environment)
075    throws Exception;
076}