org.omg.PortableInterceptor
Interface ClientRequestInterceptorOperations

All Superinterfaces:

InterceptorOperations

All Known Subinterfaces:

ClientRequestInterceptor

public interface ClientRequestInterceptorOperations
extends InterceptorOperations

A Client Request interceptor intercepts the flow of an outgoing request from a client and its reply through the ORB at specific points.

Method Summary

void	receive_exception(ClientRequestInfo ri) This receive_exception() interception point is called when an exception occurs.
void	receive_other(ClientRequestInfo ri) This receive_other() interception point allows an interceptor to query the information available when a request results in something other than a normal reply or an exception.
void	receive_reply(ClientRequestInfo ri) This receive_reply() interception point allows an interceptor to query the information on a reply after it is returned from the server and before control is returned to the client.
void	send_poll(ClientRequestInfo ri) This send_poll() interception point allows an interceptor to query information during a Time-Independent Invocation (TII) polling get reply sequence.
void	send_request(ClientRequestInfo ri) This send_request() interception point allows an interceptor to query request information and modify the service context before the request is sent to the server.

Methods inherited from interface org.omg.PortableInterceptor.InterceptorOperations

destroy, name

Method Detail

receive_other

void receive_other(ClientRequestInfo ri)
                   throws ForwardRequest

This receive_other() interception point allows an interceptor to query the information available when a request results in something other than a normal reply or an exception. For example, a request could result in a retry (e.g., a GIOP Reply with a LOCATION_FORWARD status was received); or on asynchronous calls, the reply does not immediately follow the request, but control will return to the client and an ending interception point will be called.

For retries, depending on the policies in effect, a new request may or may not follow when a retry has been indicated. If a new request does follow, while this request is a new request, with respect to interceptors, there is one point of correlation between the original request and the retry: because control has not returned to the client, the request scoped Current for both the original request and the retrying request is the same.

This interception point may raise a system exception. If it does, no other interceptor's receive_other() interception points are called. The remaining interceptors in the flow stack are popped and have their receive_exception() interception point called.

This interception point may also raise a ForwardRequest exception. If an interceptor raises this exception, successive interceptor's receive_other() methods are called with the new information provided by the ForwardRequest exception.

Parameters:

ri - This is the ClientRequestInfo instance to be used by interceptor.

Throws:

ForwardRequest - The ForwardRequest exception is the means by which an Interceptor can indicate to the ORB that a retry of the request should occur with the new object given in the exception.

receive_exception

void receive_exception(ClientRequestInfo ri)
                       throws ForwardRequest

This receive_exception() interception point is called when an exception occurs. It allows an interceptor to query the exception's information before it is raised to the client. This interception point may raise a system exception. This has the effect of changing the exception which successive interceptors popped from the flow stack receive on their calls to receive_exception(). The exception raised to the client will be the last exception raised by an interceptor, or the original exception if no interceptor changes the exception. This interception point may also raise a ForwardRequest exception. If an interceptor raises this exception, no other interceptor's receive_exception() interception points are called. The remaining interceptors in the flow stack are popped and have their receive_other() interception point called.

Parameters:

ri - This is the ClientRequestInfo instance to be used by interceptor.

Throws:

ForwardRequest - The ForwardRequest exception is the means by which an Interceptor can indicate to the ORB that a retry of the request should occur with the new object given in the exception.

receive_reply

void receive_reply(ClientRequestInfo ri)

This receive_reply() interception point allows an interceptor to query the information on a reply after it is returned from the server and before control is returned to the client. This interception point may raise a system exception. If it does, no other interceptor's receive_reply() methods are called. The remaining interceptors in the flow stack will have their receive_exception() interception point called.

Parameters:

ri - This is the ClientRequestInfo instance to be used by interceptor.

send_poll

void send_poll(ClientRequestInfo ri)

This send_poll() interception point allows an interceptor to query information during a Time-Independent Invocation (TII) polling get reply sequence. However, as the VisiBroker ORB does not support TII, this send_poll() interception point will never be called.

Parameters:

ri - This is the ClientRequestInfo instance to be used by interceptor.

send_request

void send_request(ClientRequestInfo ri)
                  throws ForwardRequest

This send_request() interception point allows an interceptor to query request information and modify the service context before the request is sent to the server. This interception point may raise a system exception. If it does, no other interceptor's send_request() interception points are called. Those interceptors on the flow stack are popped and their receive_exception() interception points are called. This interception point may also raise a ForwardRequest exception. If an interceptor raises this exception, no other interceptor's send_request methods are called. The remaining interceptors in the flow stack are popped and have their receive_other() interception point called.

Parameters:

ri - This is the ClientRequestInfo instance to be used by interceptor.

Throws:

ForwardRequest - The ForwardRequest exception is the means by which an Interceptor can indicate to the ORB that a retry of the request should occur with the new object given in the exception.