/* ForwardRequestHelper.java --
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package gnu.CORBA;

import gnu.CORBA.Poa.ForwardRequestHolder;

import org.omg.CORBA.Any;
import org.omg.CORBA.BAD_OPERATION;
import org.omg.CORBA.ORB;
import org.omg.CORBA.ObjectHelper;
import org.omg.CORBA.StructMember;
import org.omg.CORBA.TypeCode;
import org.omg.CORBA.portable.InputStream;
import org.omg.CORBA.portable.OutputStream;
import org.omg.PortableServer.ForwardRequest;

/**
 * The helper operations for the exception {@link ForwardRequest}.
 *
 * @specnote The helper must be here and not in POA subpackage as it must
 * be discovered by the {@link ObjectCreator} when reading this remote
 * exception.
 *
 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
 */
public abstract class ForwardRequestHelper
{
  /**
   * Extract the ForwardRequest from given Any.
   * This method uses the ForwardRequestHolder.
   *
   * @throws BAD_OPERATION if the passed Any does not contain ForwardRequest.
   */
  public static ForwardRequest extract(Any any)
  {
    try
      {
        return ((ForwardRequestHolder) any.extract_Streamable()).value;
      }
    catch (ClassCastException cex)
      {
        BAD_OPERATION bad = new BAD_OPERATION("ForwardRequest expected");
        bad.minor = Minor.Any;
        bad.initCause(cex);
        throw bad;
      }
  }

  /**
   * Get the ForwardRequest repository id.
   *
   * @return "ForwardRequest", always.
   */
  public static String id()
  {
    return "ForwardRequest";
  }

  /**
  * Insert the ForwardRequest into the given Any.
  * This method uses the ForwardRequestHolder.
  *
  * @param any the Any to insert into.
  * @param that the ForwardRequest to insert.
  */
  public static void insert(Any any, ForwardRequest that)
  {
    any.insert_Streamable(new ForwardRequestHolder(that));
  }

  /**
   * Read the exception from the CDR intput stream.
   *
   * @param input a org.omg.CORBA.portable stream to read from.
   */
  public static ForwardRequest read(InputStream input)
  {
    // Read the exception repository id.
    String id = input.read_string();
    ForwardRequest value = new ForwardRequest();

    value.forward_reference = input.read_Object();
    return value;
  }

  /**
   * Create the ForwardRequest typecode (structure,
   * named "ForwardRequest").
   * The typecode states that the structure contains the
   * following fields: forward_reference.
   */
  public static TypeCode type()
  {
    ORB orb = OrbRestricted.Singleton;
    StructMember[] members = new StructMember[ 1 ];
    
    TypeCode field;
    
    field = ObjectHelper.type();
    members [ 0 ] = new StructMember("forward_reference", field, null);
    return orb.create_exception_tc(id(), "ForwardRequest", members);
  }

  /**
   * Write the exception to the CDR output stream.
   *
   * @param output a org.omg.CORBA.portable stream stream to write into.
   * @param value a value to write.
   */
  public static void write(OutputStream output, ForwardRequest value)
  {
    // Write the exception repository id.
    output.write_string(id());
    output.write_Object(value.forward_reference);
  }
}