1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
package org.omg.PortableServer;
/**
* org/omg/PortableServer/POAOperations.java .
* Generated by the IDL-to-Java compiler (portable), version "3.2"
* from ../../../../src/share/classes/org/omg/PortableServer/poa.idl
* Wednesday, November 7, 2007 1:15:49 PM EST
*/
/**
* A POA object manages the implementation of a
* collection of objects. The POA supports a name space
* for the objects, which are identified by Object Ids.
* A POA also provides a name space for POAs. A POA is
* created as a child of an existing POA, which forms a
* hierarchy starting with the root POA. A POA object
* must not be exported to other processes, or
* externalized with ORB::object_to_string.
*/
public interface POAOperations
{
/**
* This operation creates a new POA as a child of the
* target POA.
* @param adapter_name identifies the new POA with
* respect to other POAs with the same parent POA.
* @param a_POAManager specifies the POA Manager to be
* associated with the new POA.
* @param policies specifies policy objects to be
* associated with the POA to control its behavior.
* @exception AdapterAlreadyExists specifies that the
* target POA already has a child POA with
* the specified name.
* @exception InvalidPolicy is raised if any of the
* policy objects are not valid for the ORB,
* or are in conflict, or require an
* administrative action that has not been
* performed.
*/
org.omg.PortableServer.POA create_POA (String adapter_name, org.omg.PortableServer.POAManager a_POAManager, org.omg.CORBA.Policy[] policies) throws org.omg.PortableServer.POAPackage.AdapterAlreadyExists, org.omg.PortableServer.POAPackage.InvalidPolicy;
/**
* If the target POA is the parent of a child POA with
* the specified name (relative to the target POA), that
* child POA is returned.
* @param adapter_name POA name to be found.
* @param activate_it if a POA with the specified
* name does not exist and the value of
* the activate_it parameter is TRUE, the target
* POA's AdapterActivator, if one exists,
* is invoked.
* @return POA if one exists or is activated by the
* AdapterActivator.
* @return AdapterNonExistent is raised if POA with
* a specified name cannot be found or
* activated using AdapaterActivator.
*/
org.omg.PortableServer.POA find_POA (String adapter_name, boolean activate_it) throws org.omg.PortableServer.POAPackage.AdapterNonExistent;
/**
* This operation destroys the POA and all descendant
* POAs. All descendant POAs are destroyed (recursively)
* before the destruction of the containing POA. The POA
* so destroyed (that is, the POA with its name) may be
* re-created later in the same process.
* @param etherealize_objects flag to indicate whether
* etherealize operation on servant manager needs
* to be called.
* @param wait_for_completion flag to indicate whether
* POA and its children need to wait for active
* requests and the etherealization to complete.
*
*/
void destroy (boolean etherealize_objects, boolean wait_for_completion);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return ThreadPolcy Object
*/
org.omg.PortableServer.ThreadPolicy create_thread_policy (org.omg.PortableServer.ThreadPolicyValue value);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return LifespanPolicy Object.
*/
org.omg.PortableServer.LifespanPolicy create_lifespan_policy (org.omg.PortableServer.LifespanPolicyValue value);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return IdUniquenessPolicy Object.
*/
org.omg.PortableServer.IdUniquenessPolicy create_id_uniqueness_policy (org.omg.PortableServer.IdUniquenessPolicyValue value);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return IdAssignmentPolicy Object.
*/
org.omg.PortableServer.IdAssignmentPolicy create_id_assignment_policy (org.omg.PortableServer.IdAssignmentPolicyValue value);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return ImplicitActivationPolicy Object.
*/
org.omg.PortableServer.ImplicitActivationPolicy create_implicit_activation_policy (org.omg.PortableServer.ImplicitActivationPolicyValue value);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return ServantRetentionPolicy Object.
*/
org.omg.PortableServer.ServantRetentionPolicy create_servant_retention_policy (org.omg.PortableServer.ServantRetentionPolicyValue value);
/**
* These operations each return a reference to a policy
* object with the specified value.
* @param value policy type
* @return RequestProcessingPolicy Object.
*/
org.omg.PortableServer.RequestProcessingPolicy create_request_processing_policy (org.omg.PortableServer.RequestProcessingPolicyValue value);
/**
* This attribute identifies the POA relative to its
* parent. This name is assigned when the POA is created.
*/
String the_name ();
/**
* This attribute identifies the parent of the POA.
* The parent of the root POA is null.
*/
org.omg.PortableServer.POA the_parent ();
/**
* This attribute identifies the current set of all
* child POAs of the POA. The set of child POAs
* includes only the POA's immediate children, and
* not their descendants.
*/
org.omg.PortableServer.POA[] the_children ();
/**
* This attribute identifies the POA manager
* associated with the POA.
*/
org.omg.PortableServer.POAManager the_POAManager ();
/**
* This attribute identifies the adapter activator
* associated with the POA.
*/
org.omg.PortableServer.AdapterActivator the_activator ();
/**
* This attribute identifies the adapter activator
* associated with the POA.
*/
void the_activator (org.omg.PortableServer.AdapterActivator newThe_activator);
/**
*
* If the ServantRetentionPolicy of the POA is RETAIN,
* then the ServantManager argument (imgr) shall support
* the ServantActivator interface. For a NON_RETAIN policy,
* the ServantManager shall support the ServantLocator
* interface. If the argument is nil, or does not support
* the required interface, then the OBJ_ADAPTER
* exception is raised.
* @return ServantManager associated with a POA or null if
* none exists.
* @exception WrongPolicy raised if the
* USE_SERVANT_MANAGER policy is not specified.
*/
org.omg.PortableServer.ServantManager get_servant_manager () throws org.omg.PortableServer.POAPackage.WrongPolicy;
/**
*
* This operation sets the default servant manager
* associated with the POA. This operation may only be
* invoked once after a POA has been created. Attempting
* to set the servant manager after one has already
* been set will result in the BAD_INV_ORDER exception
* being raised.
* @param imgr servant manager to be used as a default.
* @exception WrongPolicy raised if the
* USE_SERVANT_MANAGER policy is not specified.
*/
void set_servant_manager (org.omg.PortableServer.ServantManager imgr) throws org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* This operation returns the default servant associated
* with the POA.
* @return p_servant default servant associated with a POA.
* @exception NoServant raised if no default servant is
* associated with the POA.
* @exception WrongPolicy raised if the
* USE_DEFAULT_SERVANT policy is not specified.
*/
org.omg.PortableServer.Servant get_servant () throws org.omg.PortableServer.POAPackage.NoServant, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
*
* This operation registers the specified servant with
* the POA as the default servant. This servant will
* be used for all requests for which no servant is
* found in the Active Object Map.
* @param p_servant servant to be used as a default.
* @exception WrongPolicy raised if the
* USE_DEFAULT_SERVANT policy is not specified.
*/
void set_servant (org.omg.PortableServer.Servant p_servant) throws org.omg.PortableServer.POAPackage.WrongPolicy;
/**
*
* This operation generates an Object Id and enters
* the Object Id and the specified servant in the
* Active Object Map.
* @param p_servant servant to be associated with an
* object to be activated.
* @return POA generated object id.
* @exception ServantAlreadyActive is raised if the
* POA has UNIQUE_ID policy and servant is
* is already in the Active Object Map.
* @exception WrongPolicy raised if the SYSTEM_ID and
* RETAIN policies are not specified.
*/
byte[] activate_object (org.omg.PortableServer.Servant p_servant) throws org.omg.PortableServer.POAPackage.ServantAlreadyActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* This operation enters an association between the
* specified Object Id and the specified servant in the
* Active Object Map.
* @param id object id for the object to be activated.
* @param p_servant servant to be associated with the
* object.
* @exception ServantAlreadyActive raised if the POA
* has the UNIQUE_ID policy and the servant
* is already in the Active Object Map.
* @exception ObjectAlreadyActive raised if the object is
* already active in the POA.
* @exception WrongPolicy raised if the RETAIN policy is
* is not specified.
*/
void activate_object_with_id (byte[] id, org.omg.PortableServer.Servant p_servant) throws org.omg.PortableServer.POAPackage.ServantAlreadyActive, org.omg.PortableServer.POAPackage.ObjectAlreadyActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
*
* This operation causes the ObjectId specified in the
* oid parameter to be deactivated. An ObjectId which
* has been deactivated continues to process requests
* until there are no active requests for that ObjectId.
* A deactivated ObjectId is removed from the Active
* Object Map when all requests executing for that
* ObjectId have completed.
* @param oid Object Id for the object to be deactivated.
* @exception ObjectNotActive if the object with the
* specified oid is not in the Active Object
* Map.
* @exception WrongPolicy raised if the RETAIN policy is
* is not specified.
*/
void deactivate_object (byte[] oid) throws org.omg.PortableServer.POAPackage.ObjectNotActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* This operation creates an object reference that
* encapsulates a POA-generated Object Id value and
* the specified interface repository id.
*
* @param intf rep id for creating an object reference.
* @return object reference created using intf.
* @exception WrongPolicy if SYSTEM_ID policy is not
* specified.
*/
org.omg.CORBA.Object create_reference (String intf) throws org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* This operation creates an object reference that
* encapsulates the specified Object Id and interface
* repository Id values. It does not cause an activation
* to take place. The resulting reference may be passed
* to clients, so that subsequent requests on those
* references will cause the object to be activated
* if necessary, or the default servant used, depending
* on the applicable policies.
* @param oid object id for creating an objref
* @param intf rep id for creating an objref
* @return object reference created using oid and intf
* @exception BAD_PARAM is raised if the POA has the
* SYSTEM_ID policy and it detects that the
* Object Id value was not generated by the
* system or for this POA.
*/
org.omg.CORBA.Object create_reference_with_id (byte[] oid, String intf);
/**
* This operation has four possible behaviors.
* 1. If the POA has the UNIQUE_ID policy and the
* specified servant is active, the Object Id associated
* with that servant is returned.
* 2. If the POA has the IMPLICIT_ACTIVATION policy and
* either the POA has the MULTIPLE_ID policy or the
* specified servant is not active, the servant is
* activated using a POA-generated Object Id and the
* Interface Id associated with the servant, and that
* Object Id is returned.
* 3. If the POA has the USE_DEFAULT_SERVANT policy,
* the servant specified is the default servant, and the
* operation is being invoked in the context of executing
* a request on the default servant, then the ObjectId
* associated with the current invocation is returned.
* 4. Otherwise, the ServantNotActive exception is raised.
*
* @param p_servant servant for which the object disi returned.
* @return object id associated with the servant.
* @exception ServantNotActive if the above rules and
* policy combination is not met.
* @exception WrongPolicy if the USE_DEFAULT_SERVANT policy
* or a combination of the RETAIN policy and
* either the UNIQUE_ID or IMPLICIT_ACTIVATION
* policies are not present.
*/
byte[] servant_to_id (org.omg.PortableServer.Servant p_servant) throws org.omg.PortableServer.POAPackage.ServantNotActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* This operation requires the RETAIN policy and either
* the UNIQUE_ID or IMPLICIT_ACTIVATION policies if
* invoked outside the context of an operation dispatched
* by this POA. It has four possible behaviors.
* 1. If the POA has both the RETAIN and the
* UNIQUE_ID policy and the specified servant is active,
* an object reference encapsulating the information used
* to activate the servant is returned.
* 2. If the POA has both the RETAIN and the
* IMPLICIT_ACTIVATION policy and either the POA has the
* MULTIPLE_ID policy or the specified servant is not
* active, the servant is activated using a POA-generated
* Object Id and the Interface Id associated with the
* servant, and a corresponding object reference is
* returned.
* 3. If the operation was invoked in the context of
* executing a request on the specified servant, the
* reference associated with the current invocation
* is returned.
* 4. Otherwise, the ServantNotActive exception is raised.
*
* @param p_servant servant for which the object reference
* needs to be obtained.
* @return object reference associated with the servant.
* @exception WrongPolicy if the operation is not invoked
* in the context of executing a request on
* the specified servant and the required
* policies are not present.
* @exception ServantNotActive if the above specified
* policies and rules are not met.
*/
org.omg.CORBA.Object servant_to_reference (org.omg.PortableServer.Servant p_servant) throws org.omg.PortableServer.POAPackage.ServantNotActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* If the POA has the RETAIN policy and the specified
* object is present in the Active Object Map, this
* operation returns the servant associated with that
* object in the Active Object Map. Otherwise, if the
* POA has the USE_DEFAULT_SERVANT policy and a default
* servant has been registered with the POA, this
* operation returns the default servant. If the object
* reference was not created by this POA,
* the WrongAdapter exception is raised. (OMG Issue
* on inconsistency with the POA.IDL.
*
* @param reference object reference for which the
* servant is returned.
* @return servant associated with the reference.
* @exception WrongPolicy if neither the RETAIN policy or
* the USE_DEFAULT_SERVANT policy is present.
* @exception ObjectNotActive if the servant is not
* present in the Active Object Map (for RETAIN)
* or no default servant is registered (for
* USE_DEFAULT_POLICY).
* @exception WrongAdapter if reference was not created by
* this POA instance.
*/
org.omg.PortableServer.Servant reference_to_servant (org.omg.CORBA.Object reference) throws org.omg.PortableServer.POAPackage.ObjectNotActive, org.omg.PortableServer.POAPackage.WrongPolicy, org.omg.PortableServer.POAPackage.WrongAdapter;
/**
* This operation returns the Object Id value
* encapsulated by the specified reference. This
* operation is valid only if the reference was created
* by the POA on which the operation is being performed.
* The object denoted by the reference does not have
* to be active for this operation to succeed.
*
* @param reference the object reference from which the
* object id needs to be returned.
* @return object id encapsulated in the reference.
* @exception WrongAdapter if the reference was not
* created by the POA specified in the
* reference.
* @exception WrongPolicy declared to allow future
* extensions.
*
*/
byte[] reference_to_id (org.omg.CORBA.Object reference) throws org.omg.PortableServer.POAPackage.WrongAdapter, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* If the POA has the RETAIN policy and the specified
* ObjectId is in the Active Object Map, this operation
* returns the servant associated with that object in
* the Active Object Map. Otherwise, if the POA has
* the USE_DEFAULT_SERVANT policy and a default servant
* has been registered with the POA, this operation
* returns the default servant.
*
* @param oid object id for the which the servant is
* returned.
* @return servant associated with oid.
* @exception ObjectNotActive is raised if ObjectId is
* is not in the Active Object Map (for RETAIN
* policy), or no default servant is registered
* (for USE_DEFAULT_SERVANT policy).
*
* @exception WrongPolicy is raised if the RETAIN policy
* or the USE_DEFAULT_SERVANT
* policy is not present.
*/
org.omg.PortableServer.Servant id_to_servant (byte[] oid) throws org.omg.PortableServer.POAPackage.ObjectNotActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* If an object with the specified Object Id value is
* currently active, a reference encapsulating the
* information used to activate the object is returned.
*
* @param oid id of the object for which the
* reference is returned.
* @return the object reference
*
* @exception ObjectNotActive if the Object Id value
* is not active in the POA.
* @exception WrongPolicy if the RETAIN policy is not
* present.
*/
org.omg.CORBA.Object id_to_reference (byte[] oid) throws org.omg.PortableServer.POAPackage.ObjectNotActive, org.omg.PortableServer.POAPackage.WrongPolicy;
/**
* This returns the unique id of the POA in the process in which it
* is created. It is for use by portable interceptors.
* <p>
* This id is guaranteed unique for the life span of the POA in the
* process. For persistent POAs, this means that if a POA is created
* in the same path with the same name as another POA, these POAs
* are identical and, therefore, have the same id. For transient
* POAs, each POA is unique.
*/
byte[] id ();
} // interface POAOperations
|
