Source for org.omg.PortableServer.ThreadPolicyValue

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