1 /* RequestProcessingPolicyValue.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 gnu.CORBA.Minor;
42
43 import org.omg.CORBA.BAD_OPERATION;
44 import org.omg.CORBA.portable.IDLEntity;
45
46 import java.io.Serializable;
47
48 /**
49 * Specifies the behaviour in the case when the
50 * requested object is not found in the Active Object Map or that map
51 * is not in use. The map is not in use when the
52 * {@link ServantRetentionPolicyValue#NON_RETAIN} policy is active.
53 * <ul>
54 * <li>USE_ACTIVE_OBJECT_MAP_ONLY Raise an {@link org.omg.CORBA.OBJECT_NOT_EXIST}
55 * with the minor code 2. {@link ServantRetentionPolicyValue#RETAIN} policy is
56 * also required.
57 * </li>
58 * <li>USE_DEFAULT_SERVANT Dispatch request to the default servant. If no such
59 * exists, raise {@link org.omg.CORBA.OBJ_ADAPTER} with minor code 3.
60 * {@link IdUniquenessPolicyValue#MULTIPLE_ID} is also required.
61 * </li>
62 * <li>USE_SERVANT_MANAGER Dispatch request to the servant manager. If no such
63 * exists, raise {@link org.omg.CORBA.OBJ_ADAPTER} with the minor code 4.</li>
64 * </ul>
65 *
66 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
67 */
68 public class RequestProcessingPolicyValue
69 implements Serializable, IDLEntity
70 {
71 /**
72 * Use serialVersionUID (V1.4) for interoperability.
73 */
74 private static final long serialVersionUID = 7646563512329907695L;
75
76 /**
77 * The value field for the current instance.
78 */
79 private final int _value;
80
81 /**
82 * The possible value of this enumeration (USE_ACTIVE_OBJECT_MAP_ONLY).
83 */
84 public static final int _USE_ACTIVE_OBJECT_MAP_ONLY = 0;
85
86 /**
87 * An instance of RequestProcessingPolicyValue, initialized to USE_ACTIVE_OBJECT_MAP_ONLY.
88 */
89 public static final RequestProcessingPolicyValue USE_ACTIVE_OBJECT_MAP_ONLY =
90 new RequestProcessingPolicyValue(_USE_ACTIVE_OBJECT_MAP_ONLY);
91
92 /**
93 * The possible value of this enumeration (USE_DEFAULT_SERVANT).
94 */
95 public static final int _USE_DEFAULT_SERVANT = 1;
96
97 /**
98 * An instance of RequestProcessingPolicyValue, initialized to USE_DEFAULT_SERVANT.
99 */
100 public static final RequestProcessingPolicyValue USE_DEFAULT_SERVANT =
101 new RequestProcessingPolicyValue(_USE_DEFAULT_SERVANT);
102
103 /**
104 * The possible value of this enumeration (USE_SERVANT_MANAGER).
105 */
106 public static final int _USE_SERVANT_MANAGER = 2;
107
108 /**
109 * An instance of RequestProcessingPolicyValue, initialized to USE_SERVANT_MANAGER.
110 */
111 public static final RequestProcessingPolicyValue USE_SERVANT_MANAGER =
112 new RequestProcessingPolicyValue(_USE_SERVANT_MANAGER);
113
114 /**
115 * The private array that maps integer codes to the enumeration
116 * values.
117 */
118 private static final RequestProcessingPolicyValue[] enume =
119 new RequestProcessingPolicyValue[]
120 {
121 USE_ACTIVE_OBJECT_MAP_ONLY, USE_DEFAULT_SERVANT, USE_SERVANT_MANAGER
122 };
123
124 /**
125 * The private array of state names.
126 */
127 private static final String[] state_names =
128 new String[]
129 {
130 "USE_ACTIVE_OBJECT_MAP_ONLY", "USE_DEFAULT_SERVANT", "USE_SERVANT_MANAGER"
131 };
132
133 /**
134 * Normally, no new instances are required, so the constructor is protected.
135 */
136 protected RequestProcessingPolicyValue(int a_value)
137 {
138 _value = a_value;
139 }
140
141 /**
142 * Returns the RequestProcessingPolicyValue, matching the given integer constant.
143 *
144 * @param code one of _USE_ACTIVE_OBJECT_MAP_ONLY, _USE_DEFAULT_SERVANT, _USE_SERVANT_MANAGER.
145 * @return one of USE_ACTIVE_OBJECT_MAP_ONLY, USE_DEFAULT_SERVANT, USE_SERVANT_MANAGER.
146 * @throws BAD_PARAM if the parameter is not one of the valid values.
147 */
148 public static RequestProcessingPolicyValue from_int(int code)
149 {
150 try
151 {
152 return enume [ code ];
153 }
154 catch (ArrayIndexOutOfBoundsException ex)
155 {
156 BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
157 bad.minor = Minor.PolicyType;
158 throw bad;
159 }
160 }
161
162 /**
163 * Returns a short string representation.
164 * @return the name of the current enumeration value.
165 */
166 public String toString()
167 {
168 return state_names [ _value ];
169 }
170
171 /**
172 * Returns the integer code of the policy value.
173 * @return one of _USE_ACTIVE_OBJECT_MAP_ONLY,
174 * _USE_DEFAULT_SERVANT, _USE_SERVANT_MANAGER.
175 */
176 public int value()
177 {
178 return _value;
179 }
180 }
Save This Page