001/* ServantActivatorOperations.java -- 002 Copyright (C) 2005 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.PortableServer; 040 041 042/** 043 * Defines the operations, applicable to the {@link ServantActivator}. 044 * 045 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 046 */ 047public interface ServantActivatorOperations 048 extends ServantManagerOperations 049{ 050 /** 051 * This method is invoked whenever a servant for an object is deactivated, 052 * assuming the POA has the USE_SERVANT_MANAGER and RETAIN policies. 053 * 054 * @param Object_Id the Id of the object being deactivated. 055 * 056 * @param poa the POA in those scope the object was active. 057 * 058 * @param servant the servant, serving the object being deactivated. 059 * 060 * @param cleanup_in_progress if true, this method was called from due 061 * deactivation or destruction operation. False indicates that the method 062 * was called due other reasons. 063 * 064 * @param remaining_activations if true, at the invocation moment the 065 * passed servant is also associated with other objects in the active 066 * object map of the given POA. 067 */ 068 void etherealize(byte[] Object_Id, POA poa, Servant servant, 069 boolean cleanup_in_progress, boolean remaining_activations 070 ); 071 072 /** 073 * This method is invoked whenever the POA receives a request for an 074 * object that is not currently active, assuming the POA has the 075 * USE_SERVANT_MANAGER and RETAIN policies. The user-supplied servant 076 * manager is responsible for locating or creating an appropriate servant 077 * that corresponds to the ObjectId value. The subsequent requests with 078 * the same ObjectId value will be delivered directly to that servant 079 * without invoking the servant manager. 080 * 081 * @param Object_Id the ObjectId value associated with the incoming request. 082 * @param poa the POA in which the object is being activated. 083 * 084 * @return a servant that will be used to process the incoming request. 085 * 086 * @throws ForwardRequest if the activator decides to forward the request 087 * to another object. The exception contains the object that should 088 * handle this request. This object is usually remote, but can also 089 * be local. The throws exception will forward all subsequent requests 090 * till the new activation. 091 */ 092 Servant incarnate(byte[] Object_Id, POA poa) 093 throws ForwardRequest; 094}