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