libjava/classpath/org/omg/PortableInterceptor/ServerRequestInterceptorOperations.java

   1 /* ServerRequestInterceptorOperations.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.PortableInterceptor;
  40
  41 import org.omg.CORBA.SystemException;
  42
  43
  44 /**
  45  * Defines operations, applicable to the server side request interceptor. The
  46  * operations are called by ORB at the appropriate interception points.
  47  *
  48  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  49  */
  50 public interface ServerRequestInterceptorOperations
  51   extends InterceptorOperations
  52 {
  53   /**
  54    * ORB calls this method before invoking the servant manager. Operation
  55    * parameters are not available at this point. The interceptor has possibility
  56    * to forward the request by throwing {@link ForwardRequest}.
  57    *
  58    * @throws SystemException if it does, the receive_request_service_contexts is
  59    *           not called for the subsequent interceptors, calling
  60    *           send_exception instead. The completion status of such exception
  61    *           must be COMPLETED_NO.
  62    * @throws ForwardRequest to forward the invocation to another target. The
  63    *           receive_request_service_contexts is not called for the subsequent
  64    *           interceptors, calling send_other instead.
  65    */
  66   void receive_request_service_contexts(ServerRequestInfo info)
  67     throws ForwardRequest;
  68
  69   /**
  70    * ORB calls this method after all the information, including operation
  71    * parameters, are available. The interceptor has possibility to forward the
  72    * request by throwing {@link ForwardRequest}.
  73    *
  74    * @param info the object for accessing and manipulating the request
  75    * information.
  76    *
  77    * @throws SystemException if it does, the receive_request is not called for
  78        * the subsequent interceptors, calling send_exception instead. The completion
  79    * status of such exception must be COMPLETED_NO.
  80    *
  81    * @throws ForwardRequest to forward the invocation to another target. The
  82    * receive_request is not called for the subsequent interceptors, calling
  83    * send_other instead.
  84    */
  85   void receive_request(ServerRequestInfo info) throws ForwardRequest;
  86
  87   /**
  88    * ORB calls this method after the target operation has been invoked and
  89    * before the reply is returned to the client. This interception point shall
  90    * execute in the same thread as the target invocation.
  91    *
  92    * @param info the object for accessing and manipulating the request
  93    * information.
  94    *
  95    * @throws SystemException if it does, the send_reply is not called for the
  96    * subsequent interceptors, calling send_exception instead. The completion
  97    * status of such exception must be COMPLETED_YES.
  98    */
  99   void send_reply(ServerRequestInfo info);
 100
 101   /**
 102    * ORB calls this method if the exception has been throw during the request
 103    * processing. The interceptor has possibility to forward the request by
 104    * throwing {@link ForwardRequest}.
 105    *
 106    * @param info the object for accessing and manipulating the request
 107    * information.
 108    *
 109    * @throws SystemException has the effect of changing the exception that
 110    * successive interceptors receive on their calls to send_exception. If the
 111    * original exception is a system exception, the completion_status of the new
 112    * exception must match the exception being replaced. If the original
 113    * exception is a user exception, then the completion_status of the new
 114    * exception must be COMPLETED_YES.
 115    *
 116    * @throws ForwardRequest to forward the invocation to another target. The
 117    * send_exception is not called for the subsequent interceptors, calling
 118    * send_other instead. If the completion_status of the original exception is
 119    * not a COMPLETED_NO, the ForwardRequest must not be raised.
 120    */
 121   void send_exception(ServerRequestInfo info) throws ForwardRequest;
 122
 123   /**
 124    * ORB normally calls this method if the request has been forwarded.
 125    *
 126    * @param info the object for accessing and manipulating the request
 127    * information.
 128    *
 129    * @throws SystemException if it does, the send_other is not called for the
 130    * subsequent interceptors, calling send_exception instead.
 131    *
 132    * @throws ForwardRequest has the effect of changing the redirection that
 133    * successive interceptors receive on their calls to send_other.
 134    */
 135   void send_other(ServerRequestInfo info) throws ForwardRequest;
 136 }