Source for org.omg.PortableServer._ServantLocatorStub

   1: /* _ServantLocatorStub.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.PortableServer;
  40: 
  41: import org.omg.CORBA.portable.ObjectImpl;
  42: import org.omg.PortableServer.ServantLocatorPackage.CookieHolder;
  43: 
  44: import java.io.Serializable;
  45: 
  46: /**
  47:  * <p>The ServantLocator stub is an optional base for the
  48:  * servant locators. This stub cannot accept remote invocations, as
  49:  * methods in {@link ServantLocatorOperations} take POA as one of parameters.
  50:  * Both JDK 1.5 API and OMG specifies that POA is a local object that must not
  51:  * be transferred to the remote invocation target.
  52:  * </p><p>
  53:  * You do not need to derive your servant locator from this stub,
  54:  * it is enough to implement the {@link ServantLocator} interface.
  55:  * But you may choose to do this if you need its functional
  56:  * {@link #_ids()} method or want to keep default behavior during per-
  57:  * or post- invokcations.
  58:  * </p>
  59:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  60:  */
  61: public class _ServantLocatorStub
  62:   extends ObjectImpl
  63:   implements ServantLocator, Serializable
  64: {
  65:   /**
  66:    * Use serialVersionUID (v1.4) for interoperability.
  67:    */
  68:   private static final long serialVersionUID = -2374963516905770111L;
  69: 
  70:   /**
  71:    * This the purpose of this field is undocumented up till 1.5 java API
  72:    * inclusive.
  73:    */
  74:   public static final Class _opsClass = ServantLocatorOperations.class;
  75: 
  76:   /**
  77:    * The package private string, used as a parameter for
  78:    * the throws NullPointerExceptions in both servant locator and activator
  79:    * stubs.
  80:    */
  81:   static final String OVERRIDE = "Override this method to get functionality.";
  82: 
  83:   /**
  84:    * Return the array of repository ids for this object, stating that it is
  85:    * both Servant locator and Servant manager.
  86:    *
  87:    * @return { "IDL:omg.org/PortableServer/ServantLocator:1.0",
  88:    *           "IDL:omg.org/PortableServer/ServantManager:1.0" }, always.
  89:    */
  90:   public String[] _ids()
  91:   {
  92:     return new String[]
  93:            {
  94:              "IDL:omg.org/PortableServer/ServantLocator:1.0",
  95:              "IDL:omg.org/PortableServer/ServantManager:1.0"
  96:            };
  97:   }
  98: 
  99:   /**
 100:    * It is your responsibility to take the preinvoke actions, if any,
 101:    * and also supply an appropriate servant for the current invocation.
 102:    *
 103:    * The default method instructs POA that the servant cannot be
 104:    * provided by locator. The OBJ_ADAPTER exception will be
 105:    * thrown by POA, unless it uses the available default servant for all
 106:    * invocations.
 107:    *
 108:    * @specnote in GNU Classpath, returning null means that the
 109:    * locator does not supply the servant.
 110:    *
 111:    * @see ServantLocatorOperations#preinvoke
 112:    */
 113:   public Servant preinvoke(byte[] Object_id, POA poa, String method,
 114:                            CookieHolder cookie
 115:                           )
 116:                     throws ForwardRequest
 117:   {
 118:     return null;
 119:   }
 120: 
 121:   /**
 122:    * It is your responsibility to take the postinvoke actions, if any,
 123:    * by overriding this method. The default method does nothing.
 124:    *
 125:    * @see ServantLocatorOperations#postinvoke
 126:    */
 127:   public void postinvoke(byte[] Object_id, POA poa, String method,
 128:                          Object cookie, Servant servant
 129:                         )
 130:   {
 131:   }