1 /* TaggedComponentHelper.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.MARSHAL;
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 import java.io.IOException;
54 
55 /**
56  * A helper operations for the {@link TaggedComponent}.
57  *
58  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
59  */
60 public abstract class TaggedComponentHelper
61 {
62   /**
63    * The cached typecode value, computed only once.
64    */
65   private static TypeCode typeCode;
66 
67   /**
68    * Create the TaggedComponent typecode (structure, named "TaggedComponent").
69    * The typecode states that the structure contains the following fields: tag,
70    * component_data.
71    */
type()72   public static TypeCode type()
73   {
74     if (typeCode == null)
75       {
76         ORB orb = ORB.init();
77         StructMember[] members = new StructMember[2];
78 
79         TypeCode field;
80 
81         field = orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
82                                     "ComponentId",
83                                     orb.get_primitive_tc(TCKind.tk_ulong));
84         members[0] = new StructMember("tag", field, null);
85 
86         field = orb.create_sequence_tc(0, orb.get_primitive_tc(TCKind.tk_octet));
87         members[1] = new StructMember("component_data", field, null);
88         typeCode = orb.create_struct_tc(id(), "TaggedComponent", members);
89       }
90     return typeCode;
91   }
92 
93   /**
94    * Insert the TaggedComponent into the given Any. This method uses the
95    * TaggedComponentHolder.
96    *
97    * @param any the Any to insert into.
98    * @param that the TaggedComponent to insert.
99    */
insert(Any any, TaggedComponent that)100   public static void insert(Any any, TaggedComponent that)
101   {
102     any.insert_Streamable(new TaggedComponentHolder(that));
103   }
104 
105   /**
106    * Extract the TaggedComponent from given Any. This method uses the
107    * TaggedComponentHolder.
108    *
109    * @throws BAD_OPERATION if the passed Any does not contain TaggedComponent.
110    */
extract(Any any)111   public static TaggedComponent extract(Any any)
112   {
113     try
114       {
115         return ((TaggedComponentHolder) any.extract_Streamable()).value;
116       }
117     catch (ClassCastException cex)
118       {
119         BAD_OPERATION bad = new BAD_OPERATION("TaggedComponent expected");
120         bad.minor = Minor.Any;
121         bad.initCause(cex);
122         throw bad;
123       }
124   }
125 
126   /**
127    * Get the TaggedComponent repository id.
128    *
129    * @return "IDL:omg.org/IOP/TaggedComponent:1.0", always.
130    */
id()131   public static String id()
132   {
133     return "IDL:omg.org/IOP/TaggedComponent:1.0";
134   }
135 
136   /**
137    * Read the structure from the CDR intput stream. Expects the integer
138    * identifier of the tag, then the size of the tag data and then the specified
139    * number of bytes, representing the data of the tag.
140    *
141    * @param input a org.omg.CORBA.portable stream to read from.
142    */
read(InputStream input)143   public static TaggedComponent read(InputStream input)
144   {
145     TaggedComponent value = new TaggedComponent();
146     value.tag = input.read_long();
147     value.component_data = new byte[input.read_long()];
148     try
149       {
150         input.read(value.component_data);
151       }
152     catch (IOException e)
153       {
154         MARSHAL m = new MARSHAL();
155         m.minor = Minor.Encapsulation;
156         m.initCause(e);
157         throw m;
158       }
159     return value;
160   }
161 
162   /**
163    * Write the structure to the CDR output stream. Writes the integer identifier
164    * of the tag, then the size of the tag data and then the specified number of
165    * bytes, representing the data of the tag.
166    *
167    * @param output a org.omg.CORBA.portable stream stream to write into.
168    * @param value a value to write.
169    */
write(OutputStream output, TaggedComponent value)170   public static void write(OutputStream output, TaggedComponent value)
171   {
172     output.write_long(value.tag);
173     output.write_long(value.component_data.length);
174 
175     try
176       {
177         output.write(value.component_data);
178       }
179     catch (IOException e)
180       {
181         MARSHAL m = new MARSHAL();
182         m.minor = Minor.Encapsulation;
183         m.initCause(e);
184         throw m;
185       }
186   }
187 }