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