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