Source for org.omg.PortableServer.ServantLocatorPOA

   1: /* ServantLocatorPOA.java --
   2:    Copyright (C) 2005 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 gnu.CORBA.Poa.gnuServantObject;
  42: 
  43: import org.omg.CORBA.NO_IMPLEMENT;
  44: import org.omg.CORBA.ORB;
  45: import org.omg.CORBA.SystemException;
  46: import org.omg.CORBA.portable.InputStream;
  47: import org.omg.CORBA.portable.InvokeHandler;
  48: import org.omg.CORBA.portable.OutputStream;
  49: import org.omg.CORBA.portable.ResponseHandler;
  50: import org.omg.PortableServer.ServantLocatorPackage.CookieHolder;
  51: 
  52: /**
  53:  * <p>The ServantLocator stub is an optional base for the
  54:  * servant locators. It cannot serve remote invocations, as
  55:  * methods in {@link ServantLocatorOperations} take POA as one of parameters.
  56:  * Both JDK 1.5 API and OMG specifies that POA is a local object that must not
  57:  * be transferred to the remote invocation target.
  58:  * </p><p>
  59:  * You do not need to derive your servant locator from this stub,
  60:  * it is enough to implement the {@link ServantLocator} interface.
  61:  * But you may choose to do this if you need its functional
  62:  * {@link #_ids()} method or want to keep default behavior during per-
  63:  * or post- invokcations.
  64:  * </p>
  65:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  66:  */
  67: public class ServantLocatorPOA
  68:   extends Servant
  69:   implements ServantLocatorOperations, InvokeHandler
  70: {
  71:   /**
  72:    * Used to access the outer class in the nested classes.
  73:    */
  74:   final ServantLocatorPOA THIS = this;
  75: 
  76:   /**
  77:    * It is your responsibility to take the preinvoke actions, if any,
  78:    * and also supply an appropriate servant for the current invocation.
  79:    *
  80:    * The default method instructs POA that the servant cannot be
  81:    * provided by locator. The OBJ_ADAPTER exception will be
  82:    * thrown by POA, unless it uses the available default servant for all
  83:    * invocations.
  84:    *
  85:    * @specnote in GNU Classpath, returning null means that the
  86:    * locator does not supply the servant.
  87:    *
  88:    * @see ServantLocatorOperations#preinvoke
  89:    */
  90:   public Servant preinvoke(byte[] Object_Id, POA poa, String method,
  91:                            CookieHolder cookie_holder
  92:                           )
  93:                     throws org.omg.PortableServer.ForwardRequest
  94:   {
  95:     return null;
  96:   }
  97: 
  98:   /**
  99:    * It is your responsibility to take the postinvoke actions, if any,
 100:    * by overriding this method. The default method does nothing.
 101:    *
 102:    * @see ServantLocatorOperations#postinvoke
 103:    */
 104:   public void postinvoke(byte[] Object_Id, POA poa, String method,
 105:                          java.lang.Object cookie, Servant servant
 106:                         )
 107:   {
 108:   }
 109: 
 110:   /**
 111:    * Our implementation will not call this method. After setting your
 112:    * manager to POA, it will call incarnate and etherialize directly.
 113:    */
 114:   public OutputStream _invoke(String method, InputStream input,
 115:                               ResponseHandler handler
 116:                              )
 117:                        throws SystemException
 118:   {
 119:     throw new NO_IMPLEMENT();
 120:   }
 121: 
 122:   /**
 123:    * Returns an array of interfaces, supported by the servant locator.
 124:    */
 125:   public String[] _all_interfaces(POA poa, byte[] Object_Id)
 126:   {
 127:     return new _ServantLocatorStub()._ids();
 128:   }
 129: 
 130:   /**
 131:    * Return the complete instance of the servant activator, based on
 132:    * the current class (ServantActivatorPOA or derived).
 133:    */
 134:   public ServantLocator _this()
 135:   {
 136:     return new delegator(this);
 137:   }
 138: 
 139:   /**
 140:    * Return the complete instance of the servant activator, based on
 141:    * the current class (ServantActivatorPOA or derived).
 142:    */
 143:   public ServantLocator _this(ORB orb)
 144:   {
 145:     return new delegator(this);
 146:   }
 147: 
 148:   /**
 149:    * This class is used to support _this.
 150:    */
 151:   class delegator
 152:     extends gnuServantObject
 153:     implements ServantLocator
 154:   {
 155:     delegator(Servant s)
 156:     {
 157:       super(s, new byte[ 0 ], null, null);
 158:     }
 159: 
 160:     public Servant preinvoke(byte[] Object_Id, POA poa, String method,
 161:                              CookieHolder cookie_holder
 162:                             )
 163:                       throws org.omg.PortableServer.ForwardRequest
 164:     {
 165:       return THIS.preinvoke(Object_Id, poa, method, cookie_holder);
 166:     }
 167: 
 168:     public void postinvoke(byte[] Object_Id, POA poa, String method,
 169:                            java.lang.Object cookie, Servant servant
 170:                           )
 171:     {
 172:       THIS.postinvoke(Object_Id, poa, method, cookie, servant);
 173:     }
 174: 
 175:     public String[] _ids()
 176:     {
 177:       return THIS._all_interfaces(null, null);
 178:     }
 179:   }