trunk/libjava/classpath/org/omg/PortableServer/ThreadPolicyValue.java

   1 /* ThreadPolicyValue.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
  43 import org.omg.CORBA.BAD_OPERATION;
  44 import org.omg.CORBA.BAD_PARAM;
  45 import org.omg.CORBA.portable.IDLEntity;
  46
  47 import java.io.Serializable;
  48
  49 /**
  50  * Defines the possible values for the POA thread policy.
  51  *
  52  * This enumeration can obtain the following values:
  53  * <ul>
  54  * <li>ORB_CTRL_MODEL Each object in POA has a separate serving thread
  55  * and a separate server socket, listening on the objects individual
  56  * port. Additionally, when the request is accepted, it is also
  57  * served in a separate thread, so several requests to the same
  58  * object can be processed in parallel. The servant can always get
  59  * the Id and POA of the object it is currently serving by
  60  * invoking {@link Servant#_object_id()} and {@link Servant#_poa}.
  61  * These two methods use thread to data map and must work correctly
  62  * even then the servant code is executed in several parallel threads.
  63  * </li>
  64  * <li>SINGLE_THREAD_MODEL All objects in POA share the same server
  65  * socket and are served in the same thread. This model is applicable
  66  * when the number of objects is greater than the number of threads
  67  * and (or) ports, supported by the system.</li>
  68  * </ul>
  69  * OMG also defines a MAIN_THREAD_MODEL, currently not supported by
  70  * the java API.
  71  *
  72  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  73  */
  74 public class ThreadPolicyValue
  75   implements Serializable, IDLEntity
  76 {
  77   /**
  78    * Use serialVersionUID (v1.4) for interoperability.
  79    */
  80   private static final long serialVersionUID = -8874988828297141512L;
  81
  82   /**
  83    * The value field for the current instance.
  84    */
  85   private final int _value;
  86
  87   /**
  88   * The possible value of this enumeration (ORB_CTRL_MODEL).
  89   */
  90   public static final int _ORB_CTRL_MODEL = 0;
  91
  92   /**
  93    * An instance of ThreadPolicyValue, initialized to ORB_CTRL_MODEL.
  94    */
  95   public static final ThreadPolicyValue ORB_CTRL_MODEL =
  96     new ThreadPolicyValue(_ORB_CTRL_MODEL);
  97
  98   /**
  99   * The possible value of this enumeration (SINGLE_THREAD_MODEL).
 100   */
 101   public static final int _SINGLE_THREAD_MODEL = 1;
 102
 103   /**
 104    * An instance of ThreadPolicyValue, initialized to SINGLE_THREAD_MODEL.
 105    */
 106   public static final ThreadPolicyValue SINGLE_THREAD_MODEL =
 107     new ThreadPolicyValue(_SINGLE_THREAD_MODEL);
 108
 109   /**
 110    * The private array that maps integer codes to the enumeration
 111    * values.
 112    */
 113   private static final ThreadPolicyValue[] enume =
 114     new ThreadPolicyValue[] { ORB_CTRL_MODEL, SINGLE_THREAD_MODEL };
 115
 116   /**
 117    * The private array of state names.
 118    */
 119   private static final String[] state_names =
 120     new String[] { "ORB_CTRL_MODEL", "SINGLE_THREAD_MODEL" };
 121
 122   /**
 123    * Normally, no new instances are required, so the constructor is protected.
 124    */
 125   protected ThreadPolicyValue(int a_value)
 126   {
 127     _value = a_value;
 128   }
 129
 130   /**
 131    * Returns the ThreadPolicyValue, matching the given integer constant.
 132    *
 133    * @param code one of _ORB_CTRL_MODEL, _SINGLE_THREAD_MODEL.
 134    * @return one of ORB_CTRL_MODEL, SINGLE_THREAD_MODEL.
 135    * @throws BAD_PARAM if the parameter is not one of the valid values.
 136    */
 137   public static ThreadPolicyValue from_int(int code)
 138   {
 139     try
 140       {
 141         return enume [ code ];
 142       }
 143     catch (ArrayIndexOutOfBoundsException ex)
 144       {
 145         BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
 146         bad.minor = Minor.PolicyType;
 147         throw bad;
 148       }
 149   }
 150
 151   /**
 152    * Returns a short string representation.
 153    * @return the name of the current enumeration value.
 154    */
 155   public String toString()
 156   {
 157     return state_names [ _value ];
 158   }
 159
 160   /**
 161    * Returns the integer code of the enumeration value.
 162    * @return one of ORB_CTRL_MODEL, SINGLE_THREAD_MODEL.
 163    */
 164   public int value()
 165   {
 166     return _value;
 167   }
 168 }