Source for org.omg.PortableServer.ForwardRequestHelper

   1: /* ForwardRequestHelper.java --
   2:    Copyright (C) 2005, 2006 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.ObjectCreator;
  43: import gnu.CORBA.OrbRestricted;
  44: import gnu.CORBA.Poa.ForwardRequestHolder;
  45: 
  46: import org.omg.CORBA.Any;
  47: import org.omg.CORBA.BAD_OPERATION;
  48: import org.omg.CORBA.ORB;
  49: import org.omg.CORBA.ObjectHelper;
  50: import org.omg.CORBA.StructMember;
  51: import org.omg.CORBA.TypeCode;
  52: import org.omg.CORBA.portable.InputStream;
  53: import org.omg.CORBA.portable.OutputStream;
  54: 
  55: /**
  56:  * The helper operations for the exception {@link ForwardRequest}.
  57:  *
  58:  * @specnote The helper must be here and not in POA subpackage as it must
  59:  * be discovered by the {@link ObjectCreator} when reading this remote
  60:  * exception.
  61:  *
  62:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  63:  */
  64: public abstract class ForwardRequestHelper
  65: {
  66:   /**
  67:    * Extract the ForwardRequest from given Any.
  68:    * This method uses the ForwardRequestHolder.
  69:    *
  70:    * @throws BAD_OPERATION if the passed Any does not contain ForwardRequest.
  71:    */
  72:   public static ForwardRequest extract(Any any)
  73:   {
  74:     try
  75:       {
  76:         return ((ForwardRequestHolder) any.extract_Streamable()).value;
  77:       }
  78:     catch (ClassCastException cex)
  79:       {
  80:         BAD_OPERATION bad = new BAD_OPERATION("ForwardRequest expected");
  81:         bad.minor = Minor.Any;        
  82:         bad.initCause(cex);
  83:         throw bad;
  84:       }
  85:   }
  86: 
  87:   /**
  88:    * Get the ForwardRequest repository id.
  89:    *
  90:    * @return "ForwardRequest", always.
  91:    */
  92:   public static String id()
  93:   {
  94:     return "ForwardRequest";
  95:   }
  96: 
  97:   /**
  98:   * Insert the ForwardRequest into the given Any.
  99:   * 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:     String id = 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:   }