Source for org.omg.PortableServer.POAHelper

   1: /* POAHelper.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.BAD_OPERATION;
  45: import org.omg.CORBA.BAD_PARAM;
  46: import org.omg.CORBA.TypeCode;
  47: import org.omg.CORBA.Any;
  48: import org.omg.CORBA.portable.InputStream;
  49: import org.omg.CORBA.MARSHAL;
  50: import org.omg.CORBA.portable.OutputStream;
  51: 
  52: /**
  53:  * The helper operations for the CORBA object {@link POA}.
  54:  *
  55:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  56:  */
  57: public abstract class POAHelper
  58: {
  59:   /**
  60:    * Cast the passed object into the POA. As POA is a local object, the method
  61:    * just uses java type cast.
  62:    *
  63:    * @param obj the object to narrow.
  64:    * @return narrowed instance.
  65:    * @throws BAD_PARAM if the passed object is not a POA.
  66:    */
  67:   public static POA narrow(org.omg.CORBA.Object obj)
  68:   {
  69:     try
  70:       {
  71:         return (POA) obj;
  72:       }
  73:     catch (ClassCastException cex)
  74:       {
  75:         throw new BAD_PARAM(obj.getClass().getName() + " is not a POA");
  76:       }
  77:   }
  78: 
  79:   /**
  80:    * Get the type code of the {@link POA}.
  81:    */
  82:   public static TypeCode type()
  83:   {
  84:     return OrbRestricted.Singleton.create_interface_tc(id(), "POA");
  85:   }
  86: 
  87:   /**
  88:    * Insert the POA into the given Any.
  89:    *
  90:    * @param any the Any to insert into.
  91:    *
  92:    * @param that the POA to insert.
  93:    */
  94:   public static void insert(Any any, POA that)
  95:   {
  96:     any.insert_Object(that);
  97:   }
  98: 
  99:   /**
 100:    * Extract the POA from given Any.
 101:    *
 102:    * @throws BAD_OPERATION if the passed Any does not contain POA.
 103:    */
 104:   public static POA extract(Any any)
 105:   {
 106:     return narrow(any.extract_Object());
 107:   }
 108: 
 109:   /**
 110:    * Get the POA repository id.
 111:    *
 112:    * @return "IDL:omg.org/PortableServer/POA:2.3", always.
 113:    */
 114:   public static String id()
 115:   {
 116:     return "IDL:omg.org/PortableServer/POA:2.3";
 117:   }
 118: 
 119:   /**
 120:    * This should read POA from the CDR input stream, but, following the specs,
 121:    * it doesnot. The jdk 1.5 API specification defines that POA cannot be
 122:    * exported.
 123:    *
 124:    * @param input a org.omg.CORBA.portable stream to read from.
 125:    *
 126:    * @specenote Sun throws the same exception.
 127:    *
 128:    * @throws MARSHAL, always.
 129:    */
 130:   public static POA read(InputStream input)
 131:   {
 132:     MARSHAL m = new MARSHAL("Inappropriate");
 133:     m.minor = Minor.Inappropriate;
 134:     throw m;
 135:   }
 136: 
 137:   /**
 138:    * This should read POA from the CDR input stream, but, following the specs,
 139:    * it doesnot. The jdk 1.5 API specification defines that POA cannot be
 140:    * exported.
 141:    *
 142:    * @param output a org.omg.CORBA.portable stream to write into.
 143:    *
 144:    * @specenote Sun throws the same exception.
 145:    *
 146:    * @throws MARSHAL, always.
 147:    */
 148:   public static void write(OutputStream output, POA value)
 149:   {
 150:     MARSHAL m = new MARSHAL("Inappropriate");
 151:     m.minor = Minor.Inappropriate;
 152:     throw m;
 153:   }