001    /* IORHelper.java --
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.IOP;
040    
041    import gnu.CORBA.Minor;
042    import gnu.CORBA.OrbRestricted;
043    
044    import org.omg.CORBA.Any;
045    import org.omg.CORBA.BAD_OPERATION;
046    import org.omg.CORBA.ORB;
047    import org.omg.CORBA.StructMember;
048    import org.omg.CORBA.TCKind;
049    import org.omg.CORBA.TypeCode;
050    import org.omg.CORBA.portable.InputStream;
051    import org.omg.CORBA.portable.OutputStream;
052    
053    /**
054    * A helper operations for the structure {@link IOR}.
055    *
056    * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057    */
058    public abstract class IORHelper
059    {
060      /**
061       * Create the IOR typecode (structure, named "IOR"). The typecode states that
062       * the structure contains the following fields: type_id, profiles.
063       */
064      public static TypeCode type()
065      {
066        ORB orb = OrbRestricted.Singleton;
067        StructMember[] members = new StructMember[2];
068    
069        TypeCode field;
070    
071        field = orb.get_primitive_tc(TCKind.tk_string);
072        members[0] = new StructMember("type_id", field, null);
073    
074        field = orb.create_sequence_tc(0, TaggedProfileHelper.type());
075        members[1] = new StructMember("profiles", field, null);
076        return orb.create_struct_tc(id(), "IOR", members);
077      }
078    
079      /**
080       * Insert the IOR into the given Any. This method uses the IORHolder.
081       * 
082       * @param any the Any to insert into.
083       * @param that the IOR to insert.
084       */
085      public static void insert(Any any, IOR that)
086      {
087        any.insert_Streamable(new IORHolder(that));
088      }
089    
090      /**
091       * Extract the IOR from given Any.
092       * This method uses the IORHolder.
093       *
094       * @throws BAD_OPERATION if the passed Any does not contain IOR.
095       */
096      public static IOR extract(Any any)
097      {
098        try
099          {
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      }
155    }