001 /* _ServantLocatorStub.java -- 002 Copyright (C) 2005, 2006 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.PortableServer; 040 041 import org.omg.CORBA.portable.ObjectImpl; 042 import org.omg.PortableServer.ServantLocatorPackage.CookieHolder; 043 044 import java.io.Serializable; 045 046 /** 047 * <p>The ServantLocator stub is an optional base for the 048 * servant locators. This stub cannot accept remote invocations, as 049 * methods in {@link ServantLocatorOperations} take POA as one of parameters. 050 * Both JDK 1.5 API and OMG specifies that POA is a local object that must not 051 * be transferred to the remote invocation target. 052 * </p><p> 053 * You do not need to derive your servant locator from this stub, 054 * it is enough to implement the {@link ServantLocator} interface. 055 * But you may choose to do this if you need its functional 056 * {@link #_ids()} method or want to keep default behavior during per- 057 * or post- invokcations. 058 * </p> 059 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 060 */ 061 public class _ServantLocatorStub 062 extends ObjectImpl 063 implements ServantLocator, Serializable 064 { 065 /** 066 * Use serialVersionUID (v1.4) for interoperability. 067 */ 068 private static final long serialVersionUID = -2374963516905770111L; 069 070 /** 071 * This the purpose of this field is undocumented up till 1.5 java API 072 * inclusive. 073 */ 074 @SuppressWarnings("unchecked") // Needed for API compatibility 075 public static final Class _opsClass = ServantLocatorOperations.class; 076 077 /** 078 * The package private string, used as a parameter for 079 * the throws NullPointerExceptions in both servant locator and activator 080 * stubs. 081 */ 082 static final String OVERRIDE = "Override this method to get functionality."; 083 084 /** 085 * Return the array of repository ids for this object, stating that it is 086 * both Servant locator and Servant manager. 087 * 088 * @return { "IDL:omg.org/PortableServer/ServantLocator:1.0", 089 * "IDL:omg.org/PortableServer/ServantManager:1.0" }, always. 090 */ 091 public String[] _ids() 092 { 093 return new String[] 094 { 095 "IDL:omg.org/PortableServer/ServantLocator:1.0", 096 "IDL:omg.org/PortableServer/ServantManager:1.0" 097 }; 098 } 099 100 /** 101 * It is your responsibility to take the preinvoke actions, if any, 102 * and also supply an appropriate servant for the current invocation. 103 * 104 * The default method instructs POA that the servant cannot be 105 * provided by locator. The OBJ_ADAPTER exception will be 106 * thrown by POA, unless it uses the available default servant for all 107 * invocations. 108 * 109 * @specnote in GNU Classpath, returning null means that the 110 * locator does not supply the servant. 111 * 112 * @see ServantLocatorOperations#preinvoke 113 */ 114 public Servant preinvoke(byte[] Object_id, POA poa, String method, 115 CookieHolder cookie 116 ) 117 throws ForwardRequest 118 { 119 return null; 120 } 121 122 /** 123 * It is your responsibility to take the postinvoke actions, if any, 124 * by overriding this method. The default method does nothing. 125 * 126 * @see ServantLocatorOperations#postinvoke 127 */ 128 public void postinvoke(byte[] Object_id, POA poa, String method, 129 Object cookie, Servant servant 130 ) 131 { 132 } 133 }