Source for org.omg.PortableServer.POAHelper

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