old-autovect-branch/libjava/classpath/org/omg/IOP/IORHelper.java

   1 /* IORHelper.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.IOP;
  40
  41 import gnu.CORBA.Minor;
  42
  43 import org.omg.CORBA.Any;
  44 import org.omg.CORBA.BAD_OPERATION;
  45 import org.omg.CORBA.ORB;
  46 import org.omg.CORBA.StructMember;
  47 import org.omg.CORBA.TCKind;
  48 import org.omg.CORBA.TypeCode;
  49 import org.omg.CORBA.portable.InputStream;
  50 import org.omg.CORBA.portable.OutputStream;
  51
  52 /**
  53 * A helper operations for the structure {@link IOR}.
  54 *
  55 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  56 */
  57 public abstract class IORHelper
  58 {
  59   /**
  60    * The cached typecode value, computed only once.
  61    */
  62   private static TypeCode typeCode;
  63
  64   /**
  65    * Create the IOR typecode (structure,
  66    * named "IOR").
  67    * The typecode states that the structure contains the
  68    * following fields: type_id, profiles.
  69    */
  70   public static TypeCode type()
  71   {
  72     if (typeCode == null)
  73       {
  74         ORB orb = ORB.init();
  75         StructMember[] members = new StructMember[ 2 ];
  76
  77         TypeCode field;
  78
  79         field = orb.get_primitive_tc(TCKind.tk_string);
  80         members [ 0 ] = new StructMember("type_id", field, null);
  81
  82         field = orb.create_sequence_tc(0, TaggedProfileHelper.type());
  83         members [ 1 ] = new StructMember("profiles", field, null);
  84         typeCode = orb.create_struct_tc(id(), "IOR", members);
  85       }
  86     return typeCode;
  87   }
  88
  89   /**
  90   * Insert the IOR into the given Any.
  91   * This method uses the IORHolder.
  92   *
  93   * @param any the Any to insert into.
  94   * @param that the IOR to insert.
  95   */
  96   public static void insert(Any any, IOR that)
  97   {
  98     any.insert_Streamable(new IORHolder(that));
  99   }
 100
 101   /**
 102    * Extract the IOR from given Any.
 103    * This method uses the IORHolder.
 104    *
 105    * @throws BAD_OPERATION if the passed Any does not contain IOR.
 106    */
 107   public static IOR extract(Any any)
 108   {
 109     try
 110       {
 111         return ((IORHolder) any.extract_Streamable()).value;
 112       }
 113     catch (ClassCastException cex)
 114       {
 115         BAD_OPERATION bad = new BAD_OPERATION("IOR expected");
 116         bad.minor = Minor.Any;
 117         bad.initCause(cex);
 118         throw bad;
 119       }
 120   }
 121
 122   /**
 123    * Get the IOR repository id.
 124    *
 125    * @return "IDL:omg.org/IOP/IOR:1.0", always.
 126    */
 127   public static String id()
 128   {
 129     return "IDL:omg.org/IOP/IOR:1.0";
 130   }
 131
 132   /**
 133    * Read the structure from the CDR intput stream. Expects repository
 134    * it, then number of the tagged profiles and then the tagged profiles.
 135    * Does not expect the endian indicator, present in the beginning of the
 136    * stringified IOR references.
 137    *
 138    * @param input a org.omg.CORBA.portable stream to read from.
 139    */
 140   public static IOR read(InputStream input)
 141   {
 142     IOR value = new IOR();
 143     value.type_id = input.read_string();
 144     value.profiles = new TaggedProfile[ input.read_long() ];
 145     for (int i0 = 0; i0 < value.profiles.length; i0++)
 146       value.profiles [ i0 ] = TaggedProfileHelper.read(input);
 147     return value;
 148   }
 149
 150   /**
 151    * Write the structure to the CDR output stream. Writes
 152    * Expects repository it, then number of the tagged profiles and then
 153    * the tagged profiles. Will not write the endian indicator, present
 154    * in the beginning of the stringified IOR references.
 155    *
 156    * @param output a org.omg.CORBA.portable stream stream to write into.
 157    * @param value a value to write.
 158    */
 159   public static void write(OutputStream output, IOR value)
 160   {
 161     output.write_string(value.type_id);
 162     output.write_long(value.profiles.length);
 163     for (int i0 = 0; i0 < value.profiles.length; i0++)
 164       TaggedProfileHelper.write(output, value.profiles [ i0 ]);
 165   }
 166 }