Source for org.omg.PortableServer.ServantLocatorOperations

   1: /* ServantLocatorOperations.java --
   2:    Copyright (C) 2005, 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 org.omg.PortableServer;
  40: 
  41: import org.omg.PortableServer.ServantLocatorPackage.CookieHolder;
  42: 
  43: /**
  44:  * Defines the operations, applicable to the {@link ServantLocator}.
  45:  *
  46:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  47:  */
  48: public interface ServantLocatorOperations
  49:   extends ServantManagerOperations
  50: {
  51:   /**
  52:    * If the POA has the USE_SERVANT_MANAGER and NON_RETAIN policies, it
  53:    * invokes this method whenever the object being requested that is not
  54:    * inactive. This method has access to all details of the received
  55:    * request and can use them to choose between servaral alternative servants.
  56:    * It can also forward the request to another server.
  57:    *
  58:    * @param Object_Id the id of the object, on which the request was called.
  59:    * @param poa the POA in those scope the object is active.
  60:    * @param operation the name of the method or operation being invoked.
  61:    * @param cookie_holder the holder where the servant manager can store
  62:    * an arbitrary java.lang.Object. This object will be later passed as a
  63:    * <code>cookie</code> parameter for {@link #postinvoke}, to create tie
  64:    * between preinvoke and postinvoke. The application should <i>not</i>
  65:    * suppose that each call of preinvoke is followed by the subsequent
  66:    * postinvoke for the same invocation; under multi threaded policy these
  67:    * calls may be intermixed.
  68:    *
  69:    * @return a servant that will serve the incoming request.
  70:    *
  71:    * @throws ForwardRequest if the locator decides to forward the request
  72:    * to another object. The exception contains the object that should
  73:    * handle this request. This object is usually remote, but can also
  74:    * be local. As <code>preinvoke</code> is called on each method
  75:    * invocation, the thrown exception will forward only this current request.
  76:    */
  77:   Servant preinvoke(byte[] Object_Id, POA poa, String operation,
  78:                     CookieHolder cookie_holder
  79:                    )
  80:              throws ForwardRequest;
  81: 
  82:   /**
  83:    * If the POA has the USE_SERVANT_MANAGER and NON_RETAIN policies, it
  84:    * invokes this method whenever a servant completes a request.
  85:    *
  86:    * @param Object_Id the id of the object, on which the request was called.
  87:    * @param poa the POA in those scope the object is active.
  88:    * @param operation the name of the method or operation that was invoked.
  89:    * @param cookie the object that has been previously set by preinvoke in
  90:    * the <code>cookie_holder</code> parameter.
  91:    * @param servant the servant, associated with the object.
  92:    */
  93:   void postinvoke(byte[] Object_Id, POA poa, String operation,
  94:                   java.lang.Object cookie, Servant servant
  95:                  );
  96: }