Source for org.omg.PortableServer.ServantActivatorPOA

   1: /* ServantActivatorPOA.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: 
  51: /**
  52:  * <p>This ServantActivator stub is an optional base for the
  53:  * servant activators. This stub cannot serve remote invocations, as
  54:  * methods in {@link ServantActivatorOperations} take POA as one of parameters.
  55:  * Both JDK 1.5 API and OMG specifies that POA is a local object that must not
  56:  * be transferred to the remote invocation target.
  57:  * </p><p>
  58:  * You do not need to derive your servant activator from this stub,
  59:  * it is enough to implement the {@link ServantActivator} interface.
  60:  * But you may choose to do this if you need the functional
  61:  * {@link #_all_interfaces()} method or want to keep default behavior during
  62:  * the incarnation or etherialization.
  63:  * </p>
  64:  */
  65: public class ServantActivatorPOA
  66:   extends Servant
  67:   implements InvokeHandler, ServantActivatorOperations
  68: {
  69:   /**
  70:    * Used to access the outer class in the nested delegator class.
  71:    */
  72:   final ServantActivatorPOA THIS = this;
  73: 
  74:   /**
  75:    * This class is used to support _this.
  76:    */
  77:   class delegator
  78:     extends gnuServantObject
  79:     implements ServantActivator
  80:   {
  81:     delegator(Servant s)
  82:     {
  83:       super(s, new byte[ 0 ], null, null);
  84:     }
  85: 
  86:     public Servant incarnate(byte[] key, POA poa)
  87:                       throws org.omg.PortableServer.ForwardRequest
  88:     {
  89:       return THIS.incarnate(key, poa);
  90:     }
  91: 
  92:     public void etherealize(byte[] key, POA poa, Servant servant,
  93:                             boolean cleanup, boolean remains
  94:                            )
  95:     {
  96:       THIS.etherealize(key, poa, servant, cleanup, remains);
  97:     }
  98:   }
  99: 
 100:   /**
 101:    * It is your responsibility to handle the incarnation event and
 102:    * supply the servant.
 103:    * The default method instructs POA that the servant cannot be
 104:    * provided by activator. The OBJ_ADAPTER exception will be
 105:    * thrown by POA, unless the servant is provided as one of the
 106:    * parameters in the activation method, or the default servant is set.
 107:    *
 108:    * @see ServantActivatorOperations#incarnate
 109:    *
 110:    * @specnote in GNU Classpath, returning null means that the
 111:    * activator does not supply the servant. The servant can still be supplied
 112:    * as one of parameters in some POA activation methods or as a default
 113:    * servant.
 114:    *
 115:    * @throws ForwardRequest
 116:    */
 117:   public Servant incarnate(byte[] Object_Id, POA poa)
 118:                     throws ForwardRequest
 119:   {
 120:     return null;
 121:   }
 122: 
 123:   /**
 124:    * It is your responsibility to handle the etherialization event.
 125:    * Override this method if using the class. The default method
 126:    * does nothing.
 127:    *
 128:    * @see ServantActivatorOperations#incarnate
 129:    */
 130:   public void etherealize(byte[] Object_Id, POA poa, Servant servant,
 131:                           boolean cleanup, boolean remains
 132:                          )
 133:   {
 134:   }
 135: 
 136:   /**
 137:    * Our implementation will not call this method. After setting your
 138:    * manager to POA, it will call incarnate and etherialize directly.
 139:    */
 140:   public OutputStream _invoke(String method, InputStream input,
 141:                               ResponseHandler handler
 142:                              )
 143:                        throws SystemException
 144:   {
 145:     throw new NO_IMPLEMENT();
 146:   }
 147: 
 148:   /**
 149:    * Returns an array of interfaces, supported by the servant activator.
 150:    */
 151:   public String[] _all_interfaces(POA poa, byte[] Object_Id)
 152:   {
 153:     return new _ServantActivatorStub()._ids();
 154:   }
 155: 
 156:   /**
 157:    * Return the complete instance of the servant activator, based on
 158:    * the current class (ServantActivatorPOA or derived).
 159:    */
 160:   public ServantActivator _this()
 161:   {
 162:     return new delegator(this);
 163:   }
 164: 
 165:   /**
 166:    * Return the complete instance of the servant activator, based on
 167:    * the current class (ServantActivatorPOA or derived).
 168:    */
 169:   public ServantActivator _this(ORB orb)
 170:   {
 171:     return new delegator(this);
 172:   }