libjava/classpath/org/omg/PortableServer/_ServantActivatorStub.java

   1 /* _ServantActivatorStub.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 java.io.Serializable;
  42
  43 import org.omg.CORBA.portable.ObjectImpl;
  44
  45 /**
  46  * <p>This ServantActivator stub is an optional base for the
  47  * servant activators. This stub cannot accept remote invocations, as
  48  * methods in {@link ServantActivatorOperations} take POA as one of parameters.
  49  * Both JDK 1.5 API and OMG specifies that POA is a local object that must not
  50  * be transferred to the remote invocation target.
  51  * </p><p>
  52  * You do not need to derive your servant activator from this stub,
  53  * it is enough to implement the {@link ServantActivator} interface.
  54  * But you may choose to do this if you need the functional
  55  * {@link #_ids()} method or want to keep default behavior during
  56  * the incarnation or etherialization.
  57  * </p>
  58  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  59  */
  60 public class _ServantActivatorStub
  61   extends ObjectImpl
  62   implements ServantActivator, Serializable
  63 {
  64   /**
  65    * Use serialVersionUID (v1.4) for interoperability.
  66    */
  67   private static final long serialVersionUID = -685959979577281419L;
  68
  69   /**
  70    * This the purpose of this field is undocumented up till 1.5 java API
  71    * inclusive.
  72    */
  73   public static final Class _opsClass = ServantActivatorOperations.class;
  74
  75   /**
  76    * Return the array of repository ids for this object.
  77    *
  78    * @return { "IDL:omg.org/PortableServer/ServantActivator:2.3",
  79    *           "IDL:omg.org/PortableServer/ServantManager:1.0" }, always.
  80    */
  81   public String[] _ids()
  82   {
  83     return new String[]
  84            {
  85              "IDL:omg.org/PortableServer/ServantActivator:2.3",
  86              "IDL:omg.org/PortableServer/ServantManager:1.0"
  87            };
  88   }
  89
  90   /**
  91    * It is your responsibility to handle the incarnation event and
  92    * supply the servant. Override this method if using the class.
  93    * The default method instructs POA that the servant cannot be
  94    * provided by activator. The OBJ_ADAPTER exception will be
  95    * thrown by POA, unless the servant is provided as one of the
  96    * parameters in the activation method.
  97    *
  98    * @see ServantActivatorOperations#incarnate
  99    *
 100    * @specnote in GNU Classpath, returning null means that the
 101    * activator does not supply the servant.
 102    *
 103    * @throws ForwardRequest
 104    */
 105   public Servant incarnate(byte[] Object_id, POA poa)
 106                     throws ForwardRequest
 107   {
 108     return null;
 109   }
 110
 111   /**
 112    * It is your responsibility to handle the etherialization event.
 113    * Override this method if using the class. The default method
 114    * does nothing.
 115    *
 116    * @see ServantActivatorOperations#incarnate
 117    */
 118   public void etherealize(byte[] Object_id, POA poa, Servant servant,
 119                           boolean cleanup, boolean remaining
 120                          )
 121   {
 122   }
 123 }