001/* ForwardRequestHelper.java -- 002 Copyright (C) 2005, 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package org.omg.PortableServer; 040 041import gnu.CORBA.Minor; 042import gnu.CORBA.ObjectCreator; 043import gnu.CORBA.OrbRestricted; 044import gnu.CORBA.Poa.ForwardRequestHolder; 045 046import org.omg.CORBA.Any; 047import org.omg.CORBA.BAD_OPERATION; 048import org.omg.CORBA.ORB; 049import org.omg.CORBA.ObjectHelper; 050import org.omg.CORBA.StructMember; 051import org.omg.CORBA.TypeCode; 052import org.omg.CORBA.portable.InputStream; 053import org.omg.CORBA.portable.OutputStream; 054 055/** 056 * The helper operations for the exception {@link ForwardRequest}. 057 * 058 * @specnote The helper must be here and not in POA subpackage as it must 059 * be discovered by the {@link ObjectCreator} when reading this remote 060 * exception. 061 * 062 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 063 */ 064public abstract class ForwardRequestHelper 065{ 066 /** 067 * Extract the ForwardRequest from given Any. 068 * This method uses the ForwardRequestHolder. 069 * 070 * @throws BAD_OPERATION if the passed Any does not contain ForwardRequest. 071 */ 072 public static ForwardRequest extract(Any any) 073 { 074 try 075 { 076 return ((ForwardRequestHolder) any.extract_Streamable()).value; 077 } 078 catch (ClassCastException cex) 079 { 080 BAD_OPERATION bad = new BAD_OPERATION("ForwardRequest expected"); 081 bad.minor = Minor.Any; 082 bad.initCause(cex); 083 throw bad; 084 } 085 } 086 087 /** 088 * Get the ForwardRequest repository id. 089 * 090 * @return "ForwardRequest", always. 091 */ 092 public static String id() 093 { 094 return "ForwardRequest"; 095 } 096 097 /** 098 * Insert the ForwardRequest into the given Any. 099 * This method uses the ForwardRequestHolder. 100 * 101 * @param any the Any to insert into. 102 * @param that the ForwardRequest to insert. 103 */ 104 public static void insert(Any any, ForwardRequest that) 105 { 106 any.insert_Streamable(new ForwardRequestHolder(that)); 107 } 108 109 /** 110 * Read the exception from the CDR intput stream. 111 * 112 * @param input a org.omg.CORBA.portable stream to read from. 113 */ 114 public static ForwardRequest read(InputStream input) 115 { 116 // Read the exception repository id. 117 input.read_string(); 118 ForwardRequest value = new ForwardRequest(); 119 120 value.forward_reference = input.read_Object(); 121 return value; 122 } 123 124 /** 125 * Create the ForwardRequest typecode (structure, 126 * named "ForwardRequest"). 127 * The typecode states that the structure contains the 128 * following fields: forward_reference. 129 */ 130 public static TypeCode type() 131 { 132 ORB orb = OrbRestricted.Singleton; 133 StructMember[] members = new StructMember[ 1 ]; 134 135 TypeCode field; 136 137 field = ObjectHelper.type(); 138 members [ 0 ] = new StructMember("forward_reference", field, null); 139 return orb.create_exception_tc(id(), "ForwardRequest", members); 140 } 141 142 /** 143 * Write the exception to the CDR output stream. 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, ForwardRequest value) 149 { 150 // Write the exception repository id. 151 output.write_string(id()); 152 output.write_Object(value.forward_reference); 153 } 154}