org.omg.PortableInterceptor
Interface RequestInfoOperations

All Known Subinterfaces:
ClientRequestInfo, ClientRequestInfoOperations, RequestInfo, ServerRequestInfo, ServerRequestInfoOperations

public interface RequestInfoOperations

Defines operations that are applicable for both server and client request. The additional operations, specific to the server and client request are defined in the derived interfaces ServerRequestInfoOperations and ClientRequestInfoOperations.


Method Summary
 Parameter[] arguments()
          Return the parameters of the operation being invoked.
 String[] contexts()
          Returns the names of all contexts of the operation being invoked.
 TypeCode[] exceptions()
          Returns the typecodes, defining all exceptions that the operation may throw.
 Object forward_reference()
          If the request contains forwarding information (the reply_status attribute being LOCATION_FORWARD), return the forwarding target.
 ServiceContext get_reply_service_context(int ctx_name)
          Get the service context with the given ctx_name that is associated with the reply.
 ServiceContext get_request_service_context(int ctx_name)
          Get the service context with the given ctx_name that is associated with the request.
 Any get_slot(int id)
          Get the data from the given slot of the PortableInterceptor.Current that is in the scope of the request.
 String[] operation_context()
          Get the names of the service contexts being sent on the request.
 String operation()
          Get the name of the operation being invoked.
 short reply_status()
          Get the reoly state as result of the operation invocation.
 int request_id()
          Get the request id.
 boolean response_expected()
          Indicates whether request sender expected any response.
 Any result()
          Get the result of the operation invocation.
 short sync_scope()
          Determines how far the request shall progress before control is returned to the client.
 

Method Detail

arguments

Parameter[] arguments()
Return the parameters of the operation being invoked.

Returns:
the array, containing parameters of the operations or an empty array for the operations with no parameters.
Throws:
NO_RESOURCES - if the parameters are not available. The parameters are only available for DII (via Request or DSI calls. They are not available for calls via IDL - generated stubs.

contexts

String[] contexts()
Returns the names of all contexts of the operation being invoked.

Returns:
the array of strings, defining contexts.
Throws:
NO_RESOURCES - if the contexts are not available. The contexts are only available for DII (via Request or DSI calls. They are not available for calls via IDL - generated stubs.

exceptions

TypeCode[] exceptions()
Returns the typecodes, defining all exceptions that the operation may throw.

Returns:
the array of exception typecodes, empty array if the operation should not throw any exceptions.
Throws:
NO_RESOURCES - if the exception list is not available. This list is only available for DII (via Request or DSI calls and only on the client side. It is not available for calls via IDL - generated stubs or on the server side.

forward_reference

Object forward_reference()
If the request contains forwarding information (the reply_status attribute being LOCATION_FORWARD), return the forwarding target.

Returns:
the object where the request should be forwarded.

get_reply_service_context

ServiceContext get_reply_service_context(int ctx_name)
                                         throws BAD_PARAM
Get the service context with the given ctx_name that is associated with the reply.

Parameters:
ctx_name - the name of the service context
Returns:
the copy of the corresponding context.
Throws:
BAD_PARAM - minor 26, if the context with the give ctx_name does not exist.

get_request_service_context

ServiceContext get_request_service_context(int ctx_name)
                                           throws BAD_PARAM
Get the service context with the given ctx_name that is associated with the request.

Parameters:
ctx_name - the name of the service context
Returns:
the copy of the corresponding context.
Throws:
BAD_PARAM - minor 26, if the context with the give ctx_name does not exist.

get_slot

Any get_slot(int id)
             throws InvalidSlot
Get the data from the given slot of the PortableInterceptor.Current that is in the scope of the request.

Throws:
InvalidSlot

operation_context

String[] operation_context()
Get the names of the service contexts being sent on the request.

Returns:
array of strings, naming the contexts.

operation

String operation()
Get the name of the operation being invoked.

Returns:
the name of the operation, usually the name of method being called.

reply_status

short reply_status()
Get the reoly state as result of the operation invocation.

Returns:
the value field of one of the following: SUCCESSFUL, SYSTEM_EXCEPTION, USER_EXCEPTION, LOCATION_FORWARD or TRANSPORT_RETRY.

request_id

int request_id()
Get the request id.

Returns:
an id that uniquely identifies the current request/reply sequence.

response_expected

boolean response_expected()
Indicates whether request sender expected any response.

Returns:
true if the response was expected, false otherwise.

result

Any result()
Get the result of the operation invocation.

Returns:
an Any, containing the value, returned by the performed operation.

sync_scope

short sync_scope()
Determines how far the request shall progress before control is returned to the client. However up till JDK 1.5 inclusive this method always returns SYNC_WITH_TRANSPORT.

Returns:
SYNC_WITH_TRANSPORT.value (1), always.