Source for org.omg.IOP.IORHelper

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