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
|
package org.omg.PortableInterceptor;
/**
* org/omg/PortableInterceptor/RequestInfoOperations.java .
* Generated by the IDL-to-Java compiler (portable), version "3.2"
* from ../../../../src/share/classes/org/omg/PortableInterceptor/Interceptors.idl
* Friday, May 25, 2007 3:39:56 o'clock PM GMT-05:00
*/
/**
* Request Information, accessible to Interceptors.
* <p>
* Each interception point is given an object through which the
* Interceptor can access request information. Client-side and server-side
* interception points are concerned with different information, so there
* are two information objects: <code>ClientRequestInfo</code> is passed
* to the client-side interception points and <code>ServerRequestInfo</code>
* is passed to the server-side interception points. But there is
* information that is common to both, so they both inherit from a common
* interface: <code>RequestInfo</code>.
*
* @see ClientRequestInfo
* @see ServerRequestInfo
*/
public interface RequestInfoOperations
{
/**
* Returns an id that uniquely identifies an active request/reply
* sequence. Once a request/reply sequence is concluded this ID may be
* reused. Note that this id is not the same as the GIOP
* <code>request_id</code>. If GIOP is the transport mechanism used,
* then these IDs may very well be the same, but this is not guaranteed
* nor required.
*/
int request_id ();
/**
* Returns the name of the operation being invoked.
*/
String operation ();
/**
* Returns an array of <code>Parameter</code> objects, containing the
* arguments on the operation being invoked. If there are no arguments,
* this attribute will be a zero length array.
* <p>
* Not all environments provide access to the arguments. With the Java
* portable bindings, for example, the arguments are not available.
* In these environments, when this attribute is accessed,
* <code>NO_RESOURCES</code> will be thrown with a standard minor code
* of 1.
* <p>
* <i>Note: Arguments are available for DSI/DII calls.</i>
*
* @exception NO_RESOURCES thrown if arguments are not available.
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
org.omg.Dynamic.Parameter[] arguments ();
/**
* Returns an array of <code>TypeCode</code> objects describing the
* <code>TypeCode</code>s of the user exceptions that this operation
* invocation may throw. If there are no user exceptions, this
* will return a zero length array.
* <p>
* Not all environments provide access to the exception list. With
* the Java portable bindings, for example, the exception list is
* not available. In these environments, when this attribute is
* accessed, <code>NO_RESOURCES</code> will be thrown with a
* standard minor code of 1.
* <p>
* <i>Note: Exceptions are available for DSI/DII calls.</i>
*
* @exception NO_RESOURCES thrown if exceptions are not available.
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
org.omg.CORBA.TypeCode[] exceptions ();
/**
* Returns an array of <code>String</code> objects describing the
* contexts that may be passed on this operation invocation. If there
* are no contexts, this will return a zero length array.
* <p>
* Not all environments provide access to the context list. With the
* Java portable bindings, for example, the context list is not
* available. In these environments, when this attribute is accessed,
* <code>NO_RESOURCES</code> will be thrown with a standard minor code
* of 1.
* <p>
* <i>Note: Contexts are available for DSI/DII calls.</i>
*
* @exception NO_RESOURCES thrown if contexts are not available.
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
String[] contexts ();
/**
* Returns an array of <code>String</code> objects containing the
* contexts being sent on the request.
* <p>
* Not all environments provide access to the context. With the Java
* portable bindings, for example, the context is not available. In
* these environments, when this attribute is accessed, NO_RESOURCES will
* be thrown with standard minor code of 1.
* <p>
* <i>Note: <code>operation_context</code> is available for
* DSI/DII calls.</i>
*
* @exception NO_RESOURCES thrown if operation context is not available.
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
String[] operation_context ();
/**
* Returns an any containing the result of the operation invocation.
* If the operation return type is void, this attribute will be an any
* containing a type code with a <code>TCKind</code> value of
* <code>tk_void</code> and no value.
* <p>
* Not all environments provide access to the result. With the Java
* portable bindings, for example, the result is not available. In
* these environments, when this attribute is accessed,
* <code>NO_RESOURCES</code> will be thrown with a standard minor code of
* 1.
* <p>
* <i>Note: Result is available for DSI/DII calls.</i>
*
* @exception NO_RESOURCES thrown if result is not available.
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
org.omg.CORBA.Any result ();
/**
* Indicates whether a response is expected.
* <p>
* On the client, a reply is not returned when
* <code>response_expected</code> is false, so <code>receive_reply</code>
* cannot be called. <code>receive_other</code> is called unless an
* exception occurs, in which case <code>receive_exception</code> is
* called.
* <p>
* On the client, within <code>send_poll</code>, this attribute is true.
*/
boolean response_expected ();
/**
* Defines how far the request shall progress before control is returned
* to the client. This is defined in the Messaging specification, and
* is pertinent only when <code>response_expected</code> is false. If
* <code>response_expected</code> is true, the value of
* <code>sync_scope</code> is undefined. This attribute may have one of
* the following values:
* <ul>
* <li><code>Messaging.SYNC_NONE</code></li>
* <li><code>Messaging.SYNC_WITH_TRANSPORT</code></li>
* <li><code>Messaging.SYNC_WITH_SERVER</code></li>
* <li><code>Messaging.SYNC_WITH_TARGET</code></li>
* </ul>
* On the server, for all scopes, a reply will be created from the
* return of the target operation call, but the reply will not return
* to the client. Although it does not return to the client, it does
* occur, so the normal server-side interception points are
* followed (i.e., <code>receive_request_service_contexts</code>,
* <code>receive_request</code>, <code>send_reply</code> or
* <code>send_exception</code>).
* <p>
* For <code>SYNC_WITH_SERVER</code> and <code>SYNC_WITH_TARGET</code>,
* the server does send an empty reply back to the client before the
* target is invoked. This reply is not intercepted by server-side
* Interceptors.
*
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
short sync_scope ();
/**
* Describes the state of the result of the operation invocation. The
* return value can be one of the following:
* <ul>
* <li><code>PortableInterceptor.SUCCESSFUL</code></li>
* <li><code>PortableInterceptor.SYSTEM_EXCEPTION</code></li>
* <li><code>PortableInterceptor.USER_EXCEPTION</code></li>
* <li><code>PortableInterceptor.LOCATION_FORWARD</code></li>
* <li><code>PortableInterceptor.TRANSPORT_RETRY</code></li>
* </ul>
* On the client:
* <ul>
* <li>Within the <code>receive_reply</code> interception point, this
* will only return <code>SUCCESSFUL</code></li>.
* <li>Within the <code>receive_exception</code> interception point,
* this will be either <code>SYSTEM_EXCEPTION</code> or
* <code>USER_EXCEPTION</code>.</li>
* <li>Within the <code>receive_other</code> interception point, this
* will be any of: <code>SUCCESSFUL</code>,
* <code>LOCATION_FORWARD</code>, or <code>TRANSPORT_RETRY</code>.
* <code>SUCCESSFUL</code> means an asynchronous request returned
* successfully. <code>LOCATION_FORWARD</code> means that a reply
* came back with <code>LOCATION_FORWARD</code> as its status.
* <code>TRANSPORT_RETRY</code> means that the transport
* mechanism indicated a retry - a GIOP reply with a status of
* <code>NEEDS_ADDRESSING_MODE</code>, for instance. </li>
* </ul>
* On the server:
* <ul>
* <li>Within the <code>send_reply</code> interception point, this
* will only be <code>SUCCESSFUL</code>.</li>
* <li>Within the <code>send_exception</code> interception point,
* this will be either <code>SYSTEM_EXCEPTION</code> or
* <code>USER_EXCEPTION</code>.</li>
* <li>Within the <code>send_other</code> interception point, this
* attribute will be any of: <code>SUCCESSFUL</code>, or
* <code>LOCATION_FORWARD</code>. <code>SUCCESSFUL</code> means
* an asynchronous request returned successfully.
* <code>LOCATION_FORWARD</code> means that a reply came back
* with <code>LOCATION_FORWARD</code> as its status.</li>
* </ul>
*
* @see SUCCESSFUL
* @see SYSTEM_EXCEPTION
* @see USER_EXCEPTION
* @see LOCATION_FORWARD
* @see TRANSPORT_RETRY
*/
short reply_status ();
/**
* Contains the object to which the request will be forwarded, if the
* <code>reply_status</code> attribute is <code>LOCATION_FORWARD</code>.
* It is indeterminate whether a forwarded request will actually occur.
*/
org.omg.CORBA.Object forward_reference ();
/**
* Returns the data from the given slot of the
* <code>PortableInterceptor.Current</code> that is in the scope of
* the request.
* <p>
* If the given slot has not been set, then an any containing a
* type code with a <code>TCKind</code> value of <code>tk_null</code> is
* returned.
*
* @param id The <code>SlotId</code> of the slot which is to be
* returned.
* @return The slot data, in the form of an any, obtained with the
* given identifier.
* @exception InvalidSlot thrown if the ID does not define an
* allocated slot.
* @see Current
*/
org.omg.CORBA.Any get_slot (int id) throws org.omg.PortableInterceptor.InvalidSlot;
/**
* Returns a copy of the service context with the given ID that
* is associated with the request.
* <p>
* @param id The <code>IOP.ServiceId</code> of the service context
* which is to be returned.
* @return The <code>IOP.ServiceContext</code> obtained with the
* given identifier.
* @exception BAD_PARAM thrown with a standard minor code of 26, if the
* request's service context does not contain an entry for that ID.
*/
org.omg.IOP.ServiceContext get_request_service_context (int id);
/**
* Returns a copy of the service context with the given ID that
* is associated with the reply.
*
* @param id The <code>IOP.ServiceId</code> of the service context
* which is to be returned.
* @return The <code>IOP.ServiceContext</code> obtained with the given
* identifier.
* @exception BAD_PARAM thrown with a standard minor code of 26 if the
* request's service context does not contain an entry for that ID.
*/
org.omg.IOP.ServiceContext get_reply_service_context (int id);
} // interface RequestInfoOperations
|
