org.omg.PortableInterceptor
Interface ServerRequestInfoOperations

All Superinterfaces:
RequestInfoOperations
All Known Subinterfaces:
ServerRequestInfo

public interface ServerRequestInfoOperations
extends RequestInfoOperations

Provides request information, accessible for the ClientRequestInterceptor. Some methods of this interface are not valid at all interception points. The following table shows the validity of each method. If it is not valid, BAD_INV_ORDER minor 14 will be thrown.

* *
receive_request_
service_contexts
receive_request send_reply send_exception send_other
Inherited from RequestInfoOperations:
arguments no yes1 yes no2 no2
exceptions no yes
contexts no yes
operation_context no yes yes no no
result no no yes no no
reply_status no no yes
forward_reference no yes2
get_request_service_context yes no yes
get_reply_service_context no no yes
request_id yes
operation yes
response_expected yes
sync_scope yes
get_slot yes
ServerRequestInfo-specific:
get_server_policy yes
add_reply_service_context yes
set_slot yes
sending_exception no yes no
object_id no yes yes yes3 yes3
adapter_id no yes yes yes3 yes3
target_most_derived_interface no yes no
target_is_a no yes no
receive_request_
service_contexts
receive_request send_reply send_exception send_other
  1. When ServerRequestInfo is passed to receive_request, there is an entry in the list for every argument. But only the in and inout arguments will be available.
  2. If the reply_status attribute is not LOCATION_FORWARD, accessing this attribute throws BAD_INV_ORDER minor code of 14.
  3. If the servant locator caused a location forward, or thrown an exception, this attribute/operation may not be available (NO_RESOURCES with a standard minor code of 1 will be thrown).


Method Summary
 byte[] adapter_id()
          Get the identifier for the object adapter (POA).
 String[] adapter_name()
          Returns the name of the adapter that is handling the current request.
 void add_reply_service_context(ServiceContext service_context, boolean replace)
          Allows the interceptor to add service contexts to the request.
 Policy get_server_policy(int type)
          Return the policy of the given type that applies to this operation.
 byte[] object_id()
          Get the object_id describing the target of the operation invocation.
 String orb_id()
          Returns the id of the ORB that is handling the current request.
 Any sending_exception()
          Get the exception to be returned to the client.
 String server_id()
          Returs the id of the server that is handling the current request.
 void set_slot(int id, Any data)
          Allows the interceptor to set a slot in the PortableInterceptor.Current that is in the scope of the request.
 boolean target_is_a(String id)
          Checks if the servant is the given repository id.
 String target_most_derived_interface()
          Get the most derived (most specific) repository Id of the servant.
 
Methods inherited from interface org.omg.PortableInterceptor.RequestInfoOperations
arguments, contexts, exceptions, forward_reference, get_reply_service_context, get_request_service_context, get_slot, operation_context, operation, reply_status, request_id, response_expected, result, sync_scope
 

Method Detail

add_reply_service_context

void add_reply_service_context(ServiceContext service_context,
                               boolean replace)
Allows the interceptor to add service contexts to the request. Such added contexts can carry arbitrary data and can be later accessed on the client side by the client request interceptor using RequestInfoOperations.get_reply_service_context(int).

Parameters:
service_context - the context to add.
replace - if true, the existing context with the same Id will be replaced. If false, the BAD_INV_ORDER will be thrown in that case.
Throws:
BAD_INV_ORDER - minor 15 if the context with the same Id already exists and replace=false.

adapter_id

byte[] adapter_id()
Get the identifier for the object adapter (POA).


object_id

byte[] object_id()
Get the object_id describing the target of the operation invocation.


get_server_policy

Policy get_server_policy(int type)
                         throws INV_POLICY
Return the policy of the given type that applies to this operation. This method should only be used with policies, produced by the registered PolicyFactory.

Parameters:
type - the type of the policy being requested.
Returns:
the policy that applies to this operation.
Throws:
INV_POLICY - minor 2 if no factory was registered to produce this type of policy or the policy is otherwise invalid.

sending_exception

Any sending_exception()
Get the exception to be returned to the client. If the returned Any cannot not support holding of that exception, it holds UNKNOWN minor 1 instead.

Returns:
an Any, holding exception that has been thrown and will be returned to client.

set_slot

void set_slot(int id,
              Any data)
              throws InvalidSlot
Allows the interceptor to set a slot in the PortableInterceptor.Current that is in the scope of the request.

Parameters:
id - the Id of the slot.
data - the value of the slot, replacing the previous value.
Throws:
InvalidSlot - if the slot with the given Id does not exist.
See Also:
RequestInfoOperations.get_slot(int), org.omg.PortableInterceptor

target_is_a

boolean target_is_a(String id)
Checks if the servant is the given repository id.

Parameters:
id - the repository id to compare.
Returns:
true if the servant repository id matches the parameter, false otherwise.

target_most_derived_interface

String target_most_derived_interface()
Get the most derived (most specific) repository Id of the servant.

Returns:
the repository id of the servant.

adapter_name

String[] adapter_name()
Returns the name of the adapter that is handling the current request. The name is returned as a string array, representing full path from the root poa till the current poa, for instance {"RootPOA", "childPOA","grandchildPOA"}.


orb_id

String orb_id()
Returns the id of the ORB that is handling the current request. The ORB id can be specified as the property org.omg.CORBA.ORBid when creating the ORB.


server_id

String server_id()
Returs the id of the server that is handling the current request. The server id is the same for all POAs and ORBs in the current virtual machine and can be set as the property org.omg.CORBA.ServerId when creating one of the ORBs.