Source for org.omg.PortableInterceptor.InterceptorOperations

   1: /* --
   2:    Copyright (C) 2005 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 org.omg.PortableInterceptor;
  42: /**
  43:  * Defines operations, applicable for all types of {@link Interceptor}.
  44:  * The the derived interfaces define additional operations for they
  45:  * specific functionality.
  46:  *
  47:  * Portable Interceptors are hooks into the ORB through which ORB services can
  48:  * intercept the normal flow of execution in creation of IOR, sending request,
  49:  * receiving request and returning the reply.
  50:  *
  51:  * See {@link org.omg.PortableInterceptor} for more details about the possible
  52:  * interceptors and how to register them within the ORB.
  53:  *
  54:  * @author Audrius Meskauskas, Lithuania (
  55:  */
  56: public interface InterceptorOperations
  57: {
  58:   /**
  59:    * This method is called when orb is being destroyed and destroys
  60:    * the interceptor. The ORB calls this method after completing all
  61:    * incoming requests. The method body should not invoke methods on other
  62:    * object, belonging to ORB being destoryed, as in this stage it is no
  63:    * longer capable to act as server. It is still, however, capable
  64:    * to act as a client, permitting remote invocations on other objects.
  65:    */
  66:   void destroy();
  68:   /**
  69:    * All interceptors of the same type, registered on the single ORB, must
  70:    * either have different names or be anonymous. The name of the anonymous
  71:    * interceptor is an empty string. The ORB supports multiple anonymous
  72:    * interceptors of the same type.
  73:    *
  74:    * @return the name of the interceptor.
  75:    */
  76:   String name();