Source for org.omg.PortableInterceptor.ServerRequestInterceptorOperations

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