Source for org.omg.PortableServer.ServantActivatorOperations

   1: /* ServantActivatorOperations.java --
   2:    Copyright (C) 2005 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 org.omg.PortableServer;
  40: 
  41: 
  42: /**
  43:  * Defines the operations, applicable to the {@link ServantActivator}.
  44:  *
  45:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  46:  */
  47: public interface ServantActivatorOperations
  48:   extends ServantManagerOperations
  49: {
  50:   /**
  51:    * This method is invoked whenever a servant for an object is deactivated,
  52:    * assuming the POA has the USE_SERVANT_MANAGER and RETAIN policies.
  53:    *
  54:    * @param Object_Id the Id of the object being deactivated.
  55:    *
  56:    * @param poa the POA in those scope the object was active.
  57:    *
  58:    * @param servant the servant, serving the object being deactivated.
  59:    *
  60:    * @param cleanup_in_progress if true, this method was called from due
  61:    * deactivation or destruction operation. False indicates that the method
  62:    * was called due other reasons.
  63:    *
  64:    * @param remaining_activations if true, at the invocation moment the
  65:    * passed servant is also associated with other objects in the active
  66:    * object map of the given POA.
  67:    */
  68:   void etherealize(byte[] Object_Id, POA poa, Servant servant,
  69:                    boolean cleanup_in_progress, boolean remaining_activations
  70:                   );
  71: 
  72:   /**
  73:    * This method is invoked whenever the POA receives a request for an
  74:    * object that is not currently active, assuming the POA has the
  75:    * USE_SERVANT_MANAGER and RETAIN policies. The user-supplied servant
  76:    * manager is responsible for locating or creating an appropriate servant
  77:    * that corresponds to the ObjectId value. The subsequent requests with
  78:    * the same ObjectId value will be delivered directly to that servant
  79:    * without invoking the servant manager.
  80:    *
  81:    * @param Object_Id the ObjectId value associated with the incoming request.
  82:    * @param poa the POA in which the object is being activated.
  83:    *
  84:    * @return a servant that will be used to process the incoming request.
  85:    *
  86:    * @throws ForwardRequest if the activator decides to forward the request
  87:    * to another object. The exception contains the object that should
  88:    * handle this request. This object is usually remote, but can also
  89:    * be local. The throws exception will forward all subsequent requests
  90:    * till the new activation.
  91:    */
  92:   Servant incarnate(byte[] Object_Id, POA poa)
  93:              throws ForwardRequest;
  94: }