gomp-20050608-branch/libjava/classpath/gnu/CORBA/Poa/gnuForwardRequest.java

   1 /* gnuForwardRequest.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 gnu.CORBA.Poa;
  40
  41 import gnu.CORBA.GIOP.ReplyHeader;
  42
  43 import org.omg.CORBA.BAD_PARAM;
  44 import org.omg.CORBA.portable.ObjectImpl;
  45
  46 /**
  47  * The class, indicating that the request should be forwarded to another
  48  * target. We cannot use ForwardRequest because the exception is throws
  49  * from methods that does not declare throwing it. Hence must be
  50  * RuntimeException.
  51  *
  52  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  53  */
  54 public class gnuForwardRequest
  55   extends RuntimeException
  56 {
  57   /**
  58    * Use serialVersionUID (v1.4) for interoperability.
  59    */
  60   private static final long serialVersionUID = -1L;
  61
  62   /**
  63    * The object reference, indicating the new location of the invocation target.
  64    */
  65   public ObjectImpl forward_reference;
  66
  67   /**
  68    * This information shows if we use LOCATION_FORWARD or
  69    * LOCATION_FORWARD_PERM in request. By defalult, LOCATION_FORWARD
  70    * is always used. To use LOCATION_FORWARD_PERM, this exception should
  71    * be thrown from the servant manager instead of ForwardRequest,
  72    * with this field set to  ReplyHeader.LOCATION_FORWARD_PERM.
  73    */
  74   public byte forwarding_code = ReplyHeader.LOCATION_FORWARD;
  75
  76   /**
  77    * Create the ForwardRequest with explaining message and
  78    * initialising the object reference to the given value.
  79    *
  80    * @param why a string, explaining, why this exception has been thrown.
  81    * @param a_forward_reference a value for forward_reference.
  82    */
  83   public gnuForwardRequest(org.omg.CORBA.Object a_forward_reference)
  84   {
  85     if (a_forward_reference instanceof ObjectImpl)
  86       this.forward_reference = (ObjectImpl) a_forward_reference;
  87     else
  88       throw new BAD_PARAM("ObjectImpl expected");
  89   }
  90 }