001/* ClientRequestInterceptorOperations.java -- 002 Copyright (C) 2005, 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package org.omg.PortableInterceptor; 040 041import org.omg.CORBA.SystemException; 042 043 044/** 045 * Defines operations, applicable to the client side request interceptor. The 046 * operations are called by ORB at the appropriate interception points. 047 * 048 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 049 */ 050public interface ClientRequestInterceptorOperations 051 extends InterceptorOperations 052{ 053 /** 054 * ORB calls this method before sending the request to the server. 055 * 056 * @param info the object for accessing and manipulating the request 057 * information. 058 * 059 * @throws SystemException if it does, the send_request is not called for the 060 * subsequent interceptors, calling receive_exception instead. The completion 061 * status of this exception must be COMPLETED_NO. 062 * 063 * @throws ForwardRequest to forward the invocation to another target. The 064 * send_request is not called for the subsequent interceptors, calling 065 * receive_other instead. 066 */ 067 void send_request(ClientRequestInfo info) throws ForwardRequest; 068 069 /** 070 * ORB calls this method after the normal reply is received from the server 071 * and before the control is returned to the calling client code. 072 * 073 * @param info the object for accessing and manipulating the request 074 * information. 075 * 076 * @throws SystemException if it does, the receive_reply is not called for the 077 * subsequent interceptors, calling receive_exception instead. The completion 078 * status of this exception must be COMPLETED_YES. 079 */ 080 void receive_reply(ClientRequestInfo info); 081 082 /** 083 * ORB calls this method after the receiving the message that a remote 084 * exception has been thrown on a server side and before raising this 085 * exception in the client side. 086 * 087 * @param info the object for accessing and manipulating the request 088 * information. 089 * 090 * @throws SystemException has the effect of changing the exception that 091 * successive interceptors receive on their calls to receive_other. If the 092 * original exception is a system exception, the completion_status of the new 093 * exception must match the exception being replaced. If the original 094 * exception is a user exception, then the completion_status of the new 095 * exception must be COMPLETED_YES. 096 * 097 * @throws ForwardRequest to forward the invocation to another target. The 098 * receive_exception is not called for the subsequent interceptors, calling 099 * 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}