org.omg.PortableInterceptor

Interface ClientRequestInfoOperations

All Superinterfaces:

RequestInfoOperations

All Known Subinterfaces:

ClientRequestInfo

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

	send_request	send_poll	receive_reply	receive_exception	receive_other
Inherited from RequestInfoOperations:
arguments	yes 1	no	yes	no	no
exceptions	yes	no	yes
contexts	yes	no	yes
operation_context	yes	no	yes
result	no	no	yes	no	no
sync_scope	yes	no	yes
reply_status	no	no	yes
forward_reference	no	no			yes 2
get_request_service_context	yes	no	yes
get_reply_service_context	no	no	yes
request_id	yes
operation	yes
response_expected	yes
get_slot	yes
ClientRequestInfo-specific:
target	yes
effective_target	yes
effective_profile	yes
received_exception	no			yes	no
received_exception_id	no			yes	no
get_effective_component	yes	no	yes
get_effective_components	yes	no	yes
get_request_policy	yes	no	yes
add_request_service_context	yes	no
	send_request	send_poll	receive_reply	receive_exception	receive_other

1. When ClientRequestInfo is passed to send_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 atribute is not LOCATION_FORWARD, accessing this attribute will throw BAD_INV_ORDER with a standard minor code of 14.

Method Summary

Methods

Modifier and Type	Method and Description
void	add_request_service_context(ServiceContext service_context, boolean replace) Allows the interceptor to add the service contexts to the request.
TaggedProfile	effective_profile() Returns the tagged profile (IOR) of the invocation target.
Object	effective_target() Returns the object on that the operation will be invoked after handling the possible forwarding.
TaggedComponent	get_effective_component(int id) Returns the given component of the invocation target profile.
TaggedComponent[]	get_effective_components(int id) Returns the given components of the invocation target profile.
Policy	get_request_policy(int type) This should return the policy of the given type that applies to this operation, but it is not implemented up till JDK 1.5 inclusive.
String	received_exception_id() Returns the repository id of the remote exception that was thrown on the server side.
Any	received_exception() Returns the remote exception that was thrown on the server side.
Object	target() Returns the object on that the client has invoked the the operation.

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

target

Object target()

Returns the object on that the client has invoked the the operation. If the request was forwarded, it will not be the same object that actually processed the request.

Returns:

the initial client invocation target.

See Also:

effective_target()

effective_target

Object effective_target()

Returns the object on that the operation will be invoked after handling the possible forwarding.

Returns:

the final invocation target.

See Also:

target()

effective_profile

TaggedProfile effective_profile()

Returns the tagged profile (IOR) of the invocation target. If the request was forwarded, the method returns the new location, shown by the forwarding message.

Returns:

the invocation IOR.

get_effective_component

TaggedComponent get_effective_component(int id)
                                        throws BAD_PARAM

Returns the given component of the invocation target profile. If the profile contains multiple components with the same Id, it is not defined, which one will be returned.

Parameters:

id - the component id.

Returns:

the profile component with the given Id.

Throws:

BAD_PARAM - minor 28 in there are no any components with the given Id in the profile.

get_effective_components

TaggedComponent[] get_effective_components(int id)
                                           throws BAD_PARAM

Returns the given components of the invocation target profile. This method is uses when the profile may contain multiple components with the same Id.

Parameters:

id - the component id.

Returns:

the array of all profile components with the given Id.

Throws:

BAD_PARAM - minor 28 in there are no any components with the given Id in the profile.

get_request_policy

Policy get_request_policy(int type)
                          throws INV_POLICY

This should return the policy of the given type that applies to this operation, but it is not implemented up till JDK 1.5 inclusive.

Parameters:

type - the type of the policy being requested.

Returns:

should return the policy that applies to this operation.

Throws:

INV_POLICY

received_exception_id

String received_exception_id()

Returns the repository id of the remote exception that was thrown on the server side.

Returns:

the exception repository id.

See Also:

received_exception()

received_exception

Any received_exception()

Returns the remote exception that was thrown on the server side.

Returns:

the Any, holding this exception.

See Also:

received_exception_id()

add_request_service_context

void add_request_service_context(ServiceContext service_context,
                               boolean replace)

Allows the interceptor to add the service contexts to the request. Such added contexts can carry arbitrary data and can be later accessed on the server side by the server request interceptor, using RequestInfoOperations.get_request_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.