Source for org.omg.PortableServer.ForwardRequestHelper

   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 org.omg.PortableServer;
  40: 
  41: import gnu.CORBA.Minor;
  42: import gnu.CORBA.Poa.ForwardRequestHolder;
  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.ObjectHelper;
  48: import org.omg.CORBA.StructMember;
  49: import org.omg.CORBA.TypeCode;
  50: import org.omg.CORBA.portable.InputStream;
  51: import org.omg.CORBA.portable.OutputStream;
  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:    * The cached typecode value, computed only once.
  66:    */
  67:   private static TypeCode typeCode;
  68: 
  69:   /**
  70:    * Extract the ForwardRequest from given Any.
  71:    * This method uses the ForwardRequestHolder.
  72:    *
  73:    * @throws BAD_OPERATION if the passed Any does not contain ForwardRequest.
  74:    */
  75:   public static ForwardRequest extract(Any any)
  76:   {
  77:     try
  78:       {
  79:         return ((ForwardRequestHolder) any.extract_Streamable()).value;
  80:       }
  81:     catch (ClassCastException cex)
  82:       {
  83:         BAD_OPERATION bad = new BAD_OPERATION("ForwardRequest expected");
  84:         bad.minor = Minor.Any;        
  85:         bad.initCause(cex);
  86:         throw bad;
  87:       }
  88:   }
  89: 
  90:   /**
  91:    * Get the ForwardRequest repository id.
  92:    *
  93:    * @return "ForwardRequest", always.
  94:    */
  95:   public static String id()
  96:   {
  97:     return "ForwardRequest";
  98:   }
  99: 
 100:   /**
 101:   * Insert the ForwardRequest into the given Any.
 102:   * This method uses the ForwardRequestHolder.
 103:   *
 104:   * @param any the Any to insert into.
 105:   * @param that the ForwardRequest to insert.
 106:   */
 107:   public static void insert(Any any, ForwardRequest that)
 108:   {
 109:     any.insert_Streamable(new ForwardRequestHolder(that));
 110:   }
 111: 
 112:   /**
 113:    * Read the exception from the CDR intput stream.
 114:    *
 115:    * @param input a org.omg.CORBA.portable stream to read from.
 116:    */
 117:   public static ForwardRequest read(InputStream input)
 118:   {
 119:     // Read the exception repository id.
 120:     String id = input.read_string();
 121:     ForwardRequest value = new ForwardRequest();
 122: 
 123:     value.forward_reference = input.read_Object();
 124:     return value;
 125:   }
 126: 
 127:   /**
 128:    * Create the ForwardRequest typecode (structure,
 129:    * named "ForwardRequest").
 130:    * The typecode states that the structure contains the
 131:    * following fields: forward_reference.
 132:    */
 133:   public static TypeCode type()
 134:   {
 135:     if (typeCode == null)
 136:       {
 137:         ORB orb = ORB.init();
 138:         StructMember[] members = new StructMember[ 1 ];
 139: 
 140:         TypeCode field;
 141: 
 142:         field = ObjectHelper.type();
 143:         members [ 0 ] = new StructMember("forward_reference", field, null);
 144:         typeCode = orb.create_exception_tc(id(), "ForwardRequest", members);
 145:       }
 146:     return typeCode;
 147:   }
 148: 
 149:   /**
 150:    * Write the exception to the CDR output stream.
 151:    *
 152:    * @param output a org.omg.CORBA.portable stream stream to write into.
 153:    * @param value a value to write.
 154:    */
 155:   public static void write(OutputStream output, ForwardRequest value)
 156:   {
 157:     // Write the exception repository id.
 158:     output.write_string(id());
 159:     output.write_Object(value.forward_reference);
 160:   }