Source for org.omg.PortableInterceptor.ClientRequestInterceptorOperations

   1: /* ClientRequestInterceptorOperations.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.PortableInterceptor;
  40: 
  41: import org.omg.CORBA.SystemException;
  42: 
  43: 
  44: /**
  45:  * Defines operations, applicable to the client 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 ClientRequestInterceptorOperations
  51:   extends InterceptorOperations
  52: {
  53:   /**
  54:    * ORB calls this method before sending the request to the server.
  55:    *
  56:    * @param info the object for accessing and manipulating the request
  57:    * information.
  58:    *
  59:    * @throws SystemException if it does, the send_request is not called for the
  60:    * subsequent interceptors, calling receive_exception instead. The completion
  61:    * status of this exception must be COMPLETED_NO.
  62:    *
  63:    * @throws ForwardRequest to forward the invocation to another target. The
  64:    * send_request is not called for the subsequent interceptors, calling
  65:    * receive_other instead.
  66:    */
  67:   void send_request(ClientRequestInfo info) throws ForwardRequest;
  68: 
  69:   /**
  70:    * ORB calls this method after the normal reply is received from the server
  71:    * and before the control is returned to the calling client code.
  72:    *
  73:    * @param info the object for accessing and manipulating the request
  74:    * information.
  75:    *
  76:        * @throws SystemException if it does, the receive_reply is not called for the
  77:    * subsequent interceptors, calling receive_exception instead. The completion
  78:    * status of this exception must be COMPLETED_YES.
  79:    */
  80:   void receive_reply(ClientRequestInfo info);
  81: 
  82:   /**
  83:    * ORB calls this method after the receiving the message that a remote
  84:    * exception has been thrown on a server side and before raising this
  85:    * exception in the client side.
  86:    *
  87:    * @param info the object for accessing and manipulating the request
  88:    * information.
  89:    *
  90:    * @throws SystemException has the effect of changing the exception that
  91:    * successive interceptors receive on their calls to receive_other. If the
  92:    * original exception is a system exception, the completion_status of the new
  93:    * exception must match the exception being replaced. If the original
  94:    * exception is a user exception, then the completion_status of the new
  95:    * exception must be COMPLETED_YES.
  96:    *
  97:    * @throws ForwardRequest to forward the invocation to another target. The
  98:    * receive_exception is not called for the subsequent interceptors, calling
  99:    * receive_other instead. If the completion_status of the original exception
 100:    * is not a COMPLETED_NO, the ForwardRequest must not be raised.
 101:    */
 102:   void receive_exception(ClientRequestInfo info) throws ForwardRequest;
 103: 
 104:   /**
 105:    * /** ORB normally calls this method after receiving the forwarding message.
 106:     *
 107:     * @param info the object for accessing and manipulating the request
 108:     * information.
 109:     *
 110:         * @throws SystemException if it does, the receive_other is not called for the
 111:     * subsequent interceptors, calling receive_exception instead.
 112:     *
 113:     * @throws ForwardRequest has the effect of changing the redirection that
 114:     * successive interceptors receive on their calls to receive_other.
 115:     */
 116:   void receive_other(ClientRequestInfo info) throws ForwardRequest;
 117: 
 118:   /**
 119:        * This method is called by if ORB uses the Time- Independent Invocation (TII)
 120:    * polling.
 121:    *
 122:    * @param info the object for accessing and manipulating the request
 123:    * information.
 124:    *
 125:    * @throws SystemException if it does, the send_poll is not called for the
 126:    * subsequent interceptors, calling receive_exception instead. The completion
 127:    * status of this exception must be COMPLETED_NO.
 128:    */
 129:   void send_poll(ClientRequestInfo info);
 130: }