Source for javax.naming.spi.StateFactory

   1: /* StateFactory.java --
   2:    Copyright (C) 2001, 2004, 2006  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.Name;
  45: import javax.naming.NamingException;
  46:  
  47: /**
  48:  * Represents a factory, producing the object states for binding. The operation,
  49:  * performed by this factory, is the reverse operation with related to the
  50:  * operation, performed by the {@link ObjectFactory}. Classes, implementing
  51:  * this interface, must be public and have public parameterless constructor.
  52:  * 
  53:  * @see DirStateFactory
  54:  * @see ObjectFactory
  55:  * @author Warren Levy (warrenl@redhat.com)
  56:  */
  57: public interface StateFactory
  58: {
  59:   /**
  60:    * Get the object state for binding.
  61:    * 
  62:    * @param obj the object, for that the binding state must be retrieved. Cannot
  63:    *          be null.
  64:    * @param name the name of this object, related to the nameCtx. Can be null if
  65:    *          not specified.
  66:    * @param nameCtx the naming context, to that the object name is related. Can
  67:    *          be null if the name is related to the initial default context.
  68:    * @param environment the properties for creating the object state. Can be
  69:    *          null if no properties are provided.
  70:    * @return the object state for binding, may be null if no changes are
  71:    *         returned by the factory
  72:    * @throws NamingException
  73:    * 
  74:    * @see NamingManager#getStateToBind
  75:    * @see DirectoryManager#getStateToBind
  76:    */
  77:   Object getStateToBind(Object obj, Name name, Context nameCtx,
  78:                      Hashtable<?, ?> environment) throws NamingException;
  79: }