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