001/* StateFactory.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;
045import javax.naming.NamingException;
046 
047/**
048 * Represents a factory, producing the object states for binding. The operation,
049 * performed by this factory, is the reverse operation with related to the
050 * operation, performed by the {@link ObjectFactory}. Classes, implementing
051 * this interface, must be public and have public parameterless constructor.
052 * 
053 * @see DirStateFactory
054 * @see ObjectFactory
055 * @author Warren Levy (warrenl@redhat.com)
056 */
057public interface StateFactory
058{
059  /**
060   * Get the object state for binding.
061   * 
062   * @param obj the object, for that the binding state must be retrieved. Cannot
063   *          be null.
064   * @param name the name of this object, related to the nameCtx. Can be null if
065   *          not specified.
066   * @param nameCtx the naming context, to that the object name is related. Can
067   *          be null if the name is related to the initial default context.
068   * @param environment the properties for creating the object state. Can be
069   *          null if no properties are provided.
070   * @return the object state for binding, may be null if no changes are
071   *         returned by the factory
072   * @throws NamingException
073   * 
074   * @see NamingManager#getStateToBind
075   * @see DirectoryManager#getStateToBind
076   */
077  Object getStateToBind(Object obj, Name name, Context nameCtx,
078                               Hashtable<?, ?> environment) throws NamingException;
079}