1 /* ForwardRequestHelper.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 gnu.CORBA;
40 
41 import gnu.CORBA.Poa.ForwardRequestHolder;
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.ObjectHelper;
47 import org.omg.CORBA.StructMember;
48 import org.omg.CORBA.TypeCode;
49 import org.omg.CORBA.portable.InputStream;
50 import org.omg.CORBA.portable.OutputStream;
51 import org.omg.PortableServer.ForwardRequest;
52 
53 /**
54  * The helper operations for the exception {@link ForwardRequest}.
55  *
56  * @specnote The helper must be here and not in POA subpackage as it must
57  * be discovered by the {@link ObjectCreator} when reading this remote
58  * exception.
59  *
60  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
61  */
62 public abstract class ForwardRequestHelper
63 {
64   /**
65    * Extract the ForwardRequest from given Any.
66    * This method uses the ForwardRequestHolder.
67    *
68    * @throws BAD_OPERATION if the passed Any does not contain ForwardRequest.
69    */
extract(Any any)70   public static ForwardRequest extract(Any any)
71   {
72     try
73       {
74         return ((ForwardRequestHolder) any.extract_Streamable()).value;
75       }
76     catch (ClassCastException cex)
77       {
78         BAD_OPERATION bad = new BAD_OPERATION("ForwardRequest expected");
79         bad.minor = Minor.Any;
80         bad.initCause(cex);
81         throw bad;
82       }
83   }
84 
85   /**
86    * Get the ForwardRequest repository id.
87    *
88    * @return "ForwardRequest", always.
89    */
id()90   public static String id()
91   {
92     return "ForwardRequest";
93   }
94 
95   /**
96   * Insert the ForwardRequest into the given Any.
97   * This method uses the ForwardRequestHolder.
98   *
99   * @param any the Any to insert into.
100   * @param that the ForwardRequest to insert.
101   */
insert(Any any, ForwardRequest that)102   public static void insert(Any any, ForwardRequest that)
103   {
104     any.insert_Streamable(new ForwardRequestHolder(that));
105   }
106 
107   /**
108    * Read the exception from the CDR intput stream.
109    *
110    * @param input a org.omg.CORBA.portable stream to read from.
111    */
read(InputStream input)112   public static ForwardRequest read(InputStream input)
113   {
114     // Read the exception repository id.
115     String id = input.read_string();
116     ForwardRequest value = new ForwardRequest();
117 
118     value.forward_reference = input.read_Object();
119     return value;
120   }
121 
122   /**
123    * Create the ForwardRequest typecode (structure,
124    * named "ForwardRequest").
125    * The typecode states that the structure contains the
126    * following fields: forward_reference.
127    */
type()128   public static TypeCode type()
129   {
130     ORB orb = OrbRestricted.Singleton;
131     StructMember[] members = new StructMember[ 1 ];
132 
133     TypeCode field;
134 
135     field = ObjectHelper.type();
136     members [ 0 ] = new StructMember("forward_reference", field, null);
137     return orb.create_exception_tc(id(), "ForwardRequest", members);
138   }
139 
140   /**
141    * Write the exception to the CDR output stream.
142    *
143    * @param output a org.omg.CORBA.portable stream stream to write into.
144    * @param value a value to write.
145    */
write(OutputStream output, ForwardRequest value)146   public static void write(OutputStream output, ForwardRequest value)
147   {
148     // Write the exception repository id.
149     output.write_string(id());
150     output.write_Object(value.forward_reference);
151   }
152 }
153