Source for java.rmi.activation.Activator

   1: /* --
   2:    Copyright (c) 1996, 1997, 1998, 1999, 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 java.rmi.activation;
  41: import java.rmi.MarshalledObject;
  42: import java.rmi.Remote;
  43: import java.rmi.RemoteException;
  45: /**
  46:  * Activates remote object, providing the live reference to the activable remote
  47:  * object. Usually there is only one activator per host.
  48:  *
  49:  * @see ActivationSystem
  50:  * @see ActivationMonitor
  51:  */
  52: public interface Activator
  53:   extends Remote
  54: {
  55:   /**
  56:    * Activate the object, associated with the given activation identifier. The
  57:    * activator looks for the {@link ActivationDesc}riptor for the passed
  58:    * identifier, determines the object activation group and initiates object
  59:    * recreation either via {@link ActivationInstantiator} or via
  60:    * {@link Class#newInstance()}.
  61:    * 
  62:    * @param id the identifier of the object to activate.
  63:    * @param force if true, the activator always contacts the group to obtain the
  64:    *          reference. If false, it may return the cached value.
  65:    * @return the activated remote object (its stub).
  66:    * @throws UnknownObjectException if the object with this id is unknown
  67:    * @throws ActivationException if the activation has failed due other reason
  68:    * @throws RemoteException if the remote call has failed.
  69:    */
  70:   MarshalledObject activate (ActivationID id, boolean force)
  71:     throws ActivationException, UnknownObjectException, RemoteException;
  72: }