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

   1 /* ServantLocatorHelper.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 gnu.CORBA.Minor;
  42 import gnu.CORBA.OrbRestricted;
  43
  44 import org.omg.CORBA.Any;
  45 import org.omg.CORBA.BAD_OPERATION;
  46 import org.omg.CORBA.BAD_PARAM;
  47 import org.omg.CORBA.MARSHAL;
  48 import org.omg.CORBA.TypeCode;
  49 import org.omg.CORBA.portable.InputStream;
  50 import org.omg.CORBA.portable.OutputStream;
  51
  52 /**
  53 * The helper operations for the CORBA object {@link ServantLocator}.
  54 *
  55 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  56 */
  57 public abstract class ServantLocatorHelper
  58 {
  59   /**
  60    * Get the type code of the {@link ServantLocator}.
  61    */
  62   public static TypeCode type()
  63   {
  64     return OrbRestricted.Singleton.create_interface_tc(id(), "ServantLocator");
  65   }
  66
  67   /**
  68    * Insert the ServantLocator into the given Any.
  69    *
  70    * @param any the Any to insert into.
  71    * @param that the ServantLocator to insert.
  72    */
  73   public static void insert(Any any, ServantLocator that)
  74   {
  75     any.insert_Object(that);
  76   }
  77
  78   /**
  79    * Extract the ServantLocator from given Any.
  80    *
  81    * @throws BAD_OPERATION if the passed Any does not contain ServantLocator.
  82    */
  83   public static ServantLocator extract(Any any)
  84   {
  85     return narrow(any.extract_Object());
  86   }
  87
  88   /**
  89    * Get the ServantLocator repository id.
  90    *
  91    * @return "org.omg.PortableServer.ServantLocatorOperations", always.
  92    */
  93   public static String id()
  94   {
  95     return "org.omg.PortableServer.ServantLocatorOperations";
  96   }
  97
  98   /**
  99    * Cast the passed object into the ServantLocator.
 100    *
 101    * @param obj the object to narrow.
 102    * @return narrowed instance.
 103    * @throws BAD_PARAM if the passed object is not a ServantLocator.
 104    */
 105   public static ServantLocator narrow(org.omg.CORBA.Object obj)
 106   {
 107     try
 108       {
 109         return (ServantLocator) obj;
 110       }
 111     catch (ClassCastException ex)
 112       {
 113         BAD_OPERATION bad = new BAD_OPERATION();
 114         bad.minor = Minor.ClassCast;
 115         bad.initCause(ex);
 116         throw bad;
 117       }
 118   }
 119
 120   /**
 121    * Narrow the given object to the ServantLocator. For the objects that are
 122    * always local, this operation does not differ from the ordinary
 123    * {@link #narrow} (ClassCastException will be thrown if narrowing something
 124    * different). See OMG issue 4158.
 125    *
 126    * @param obj the object to cast.
 127    *
 128    * @return the casted ServantLocator.
 129    *
 130    * @since 1.5
 131    */
 132   public static ServantLocator unchecked_narrow(org.omg.CORBA.Object obj)
 133   {
 134     return narrow(obj);
 135   }
 136
 137   /**
 138    * This should read the servant locator, but it cannot be transferred
 139    * this way as its operations cannot be remote. The operations cannot
 140    * be remote because one of the method parameters, POA, is required to be
 141    * always a local object (both by 1.5 API and 3.0.3 OMG).
 142    *
 143    * @throws MARSHAL, always.
 144    *
 145    * @specnote Same as Sun.
 146    */
 147   public static ServantLocator read(InputStream input)
 148   {
 149     MARSHAL m = new MARSHAL("Inappropriate");
 150     m.minor = Minor.Inappropriate;
 151     throw m;
 152   }
 153
 154   /**
 155    * This should write the servant activator, but it cannot be transferred
 156    * this way as its operations cannot be remote. The operations cannot
 157    * be remote because one of the method parameters, POA, is required to be
 158    * always a local object (both by 1.5 API and 3.0.3 OMG).
 159    *
 160    * @throws MARSHAL, always.
 161    *
 162    * @specnote Same as Sun.
 163    */
 164   public static void write(OutputStream output, ServantLocator value)
 165   {
 166     MARSHAL m = new MARSHAL("Inappropriate");
 167     m.minor = Minor.Inappropriate;
 168     throw m;
 169   }
 170 }