uk.nhs.interoperability.source

Interface ITKCallbackHandler

All Known Implementing Classes:

RoutedMessageCallbackHandler, SimpleMessageCallbackHandler

public interface ITKCallbackHandler

Interface defining the application responsibilities for managing asynchronous invocation responses - including standard business responses (e.g. query responses), business acknowledgements and infrastructure acknowledgements and infrastructure negative acknowledgements

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Method Summary

Methods

Modifier and Type	Method and Description
void	onAck(ITKAckDetails ack) Method invoked by the transport and distribution layer upon receipt of a positive infrastructure acknowledgement (Ack). Application components are not required to provide any functionality that is triggered by this acknowledgement however it is anticipated that this could be used to implement "delivery receipt" functionality.
void	onMessage(ITKMessage response) Allows the transport and distribution infrastructure to pass back an asynchronous response received in response to an asynchronous request. The response message may be a generic ITK Business Acknowledgement (for instance as a result of a sendCDA invocation) or a specific business response associated with the request message. Note: It is the responsibility of the application to maintain state and do the necessary correlation of this message against the original request to complete the transaction.
void	onNack(ITKAckDetails ack) Method invoked by the transport and distribution layer upon receipt of a negative infrastructure acknowledgement (Nack). Application components are not required to provide any functionality that is triggered by this acknowledgement however it is anticipated that this could be used to implement "delivery failure" functionality.

Method Detail

onMessage

@Requirement(traceTo="WS-PAT-02")
void onMessage(ITKMessage response)

Allows the transport and distribution infrastructure to pass back an asynchronous response received in response to an asynchronous request.

The response message may be a generic ITK Business Acknowledgement (for instance as a result of a sendCDA invocation) or a specific business response associated with the request message.

Note: It is the responsibility of the application to maintain state and do the necessary correlation of this message against the original request to complete the transaction.

Parameters:

response - The ITKMessage representing the response

onAck

@Requirement(traceTo="WS-PAT-02")
void onAck(ITKAckDetails ack)

Method invoked by the transport and distribution layer upon receipt of a positive infrastructure acknowledgement (Ack).

Application components are not required to provide any functionality that is triggered by this acknowledgement however it is anticipated that this could be used to implement "delivery receipt" functionality.

Parameters:

ack - The (positive) acknowledgement. This can be correlated back to the request via the ITKAckDetails.getTrackingRef() method. Note correlation is an application layer responsibility.

onNack

@Requirement(traceTo="WS-PAT-02")
void onNack(ITKAckDetails ack)

Method invoked by the transport and distribution layer upon receipt of a negative infrastructure acknowledgement (Nack).

Application components are not required to provide any functionality that is triggered by this acknowledgement however it is anticipated that this could be used to implement "delivery failure" functionality.

Parameters:

ack - The (negative) acknowledgement. This can be correlated back to the request via the ITKAckDetails.getTrackingRef() method. Note correlation is an application layer responsibility. Details of the error associated with the "delivery failure" can be retrieved via the ITKAckDetails.getNackError() method.