org.omg.PortableInterceptor

Interface ServerRequestInfoOperations

public interface ServerRequestInfoOperations extends RequestInfoOperations

Provides request information, accessible for the {@link 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. * *
{@link ServerRequestInterceptorOperations#receive_request_service_contexts receive_request_
service_contexts}
{@link ServerRequestInterceptorOperations#receive_request receive_request} {@link ServerRequestInterceptorOperations#send_reply send_reply} {@link ServerRequestInterceptorOperations#send_exception send_exception} {@link ServerRequestInterceptorOperations#send_other send_other}
Inherited from {@link RequestInfoOperations}:
{@linkplain RequestInfoOperations#arguments arguments} no yes1 yes no2 no2
{@linkplain RequestInfoOperations#exceptions exceptions} no yes
{@linkplain RequestInfoOperations#contexts contexts} no yes
{@linkplain RequestInfoOperations#operation_context operation_context} no yes yes no no
{@linkplain RequestInfoOperations#result result} no no yes no no
{@linkplain RequestInfoOperations#reply_status reply_status} no no yes
{@linkplain RequestInfoOperations#forward_reference forward_reference} no yes2
{@linkplain RequestInfoOperations#get_request_service_context get_request_service_context} yes no yes
{@linkplain RequestInfoOperations#get_reply_service_context get_reply_service_context} no no yes
{@linkplain RequestInfoOperations#request_id request_id} yes
{@linkplain RequestInfoOperations#operation operation} yes
{@linkplain RequestInfoOperations#response_expected response_expected} yes
{@linkplain RequestInfoOperations#sync_scope sync_scope} yes
{@linkplain RequestInfoOperations#get_slot get_slot} yes
ServerRequestInfo-specific:
{@linkplain #get_server_policy get_server_policy} yes
{@linkplain #add_reply_service_context add_reply_service_context} yes
{@linkplain #set_slot set_slot} yes
{@linkplain #sending_exception sending_exception} no yes no
{@linkplain #object_id object_id} no yes yes yes3 yes3
{@linkplain #adapter_id adapter_id} no yes yes yes3 yes3
{@linkplain #target_most_derived_interface target_most_derived_interface} no yes no
{@linkplain #target_is_a target_is_a} no yes no
{@link ServerRequestInterceptorOperations#receive_request_service_contexts receive_request_
service_contexts }
{@link ServerRequestInterceptorOperations#receive_request receive_request} {@link ServerRequestInterceptorOperations#send_reply send_reply} {@link ServerRequestInterceptorOperations#send_exception send_exception} {@link ServerRequestInterceptorOperations#send_other 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.
voidadd_reply_service_context(ServiceContext service_context, boolean replace)
Allows the interceptor to add service contexts to the request.
Policyget_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.
Stringorb_id()
Returns the id of the ORB that is handling the current request.
Anysending_exception()
Get the exception to be returned to the client.
Stringserver_id()
Returs the id of the server that is handling the current request.
voidset_slot(int id, Any data)
Allows the interceptor to set a slot in the PortableInterceptor.Current that is in the scope of the request.
booleantarget_is_a(String id)
Checks if the servant is the given repository id.
Stringtarget_most_derived_interface()
Get the most derived (most specific) repository Id of the servant.

Method Detail

adapter_id

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

adapter_name

public 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"}.

add_reply_service_context

public 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 {@link RequestInfoOperations#get_reply_service_context}.

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.

get_server_policy

public Policy get_server_policy(int type)
Return the policy of the given type that applies to this operation. This method should only be used with policies, produced by the registered {@link 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.

object_id

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

orb_id

public 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.

sending_exception

public 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 {@link org.omg.CORBA.UNKNOWN} minor 1 instead.

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

server_id

public 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.

set_slot

public 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.

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 org.omg.PortableInterceptor#Current

target_is_a

public 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

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

Returns: the repository id of the servant.