uk.nhs.interoperability.source

Interface ITKMessageSender

All Known Implementing Classes:

ITKMessageSenderImpl

public interface ITKMessageSender

Interface that represents the application entry point for sending ITK messages to a remote Destination. The interface provides both synchronous and asynchronous operations where synchronous and asynchronous represent the perspective of the the application rather than necessarily the one or more underlying transport hops.

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

See Also:

ITKMessageConsumer, ITKCallbackHandler

Method Summary

Methods

Modifier and Type	Method and Description
void	send(ITKMessage request) Operation that allows a business payload to be sent to the destination service/system with no response expected (a.k.a.
void	sendAsync(ITKMessage businessPayload) Operation that allows a business payload to be sent asynchronously to the destination service/system.
ITKMessage	sendSync(ITKMessage request) Operation that allows a business payload to be sent synchronously to the destination service/system returning the appropriate business response.

Method Detail

send

void send(ITKMessage request)
          throws ITKMessagingException

Operation that allows a business payload to be sent to the destination service/system with no response expected (a.k.a. "fire and forget").

Parameters:

request - This is the business payload being sent which must include an appropriately populated ITKMessageProperties.

Throws:

ITKMessagingException - If the addressing and message meta-data properties are not populated, the ITKMessage.getFullPayload() is null/blank or if there is a technical exception invoking the service provider, first node in the distribution (for instance if a SOAP fault is returned by the service provider)

sendSync

@Requirement(traceTo="WS-PAT-01")
ITKMessage sendSync(ITKMessage request)
                    throws ITKMessagingException

Operation that allows a business payload to be sent synchronously to the destination service/system returning the appropriate business response.

Parameters:

request - This is the business payload being sent which must include an appropriately populated ITKMessageProperties.

Throws:

ITKMessagingException - If the addressing and message meta-data properties are not populated, the ITKMessage.getFullPayload() is null/blank or if there is a technical exception invoking the service provider (for instance if a SOAP fault is returned by the service provider)

sendAsync

@Requirement(traceTo="WS-PAT-02")
void sendAsync(ITKMessage businessPayload)
               throws ITKMessagingException

Operation that allows a business payload to be sent asynchronously to the destination service/system. No object is returned but transport/protocol errors may be thrown The response will be handled by a separate process ITKCallbackHandler.onMessage(ITKMessage)

Parameters:

businessPayload - This is the business payload being sent which must include an appropriately populated ITKMessageProperties.

Throws:

ITKMessagingException - If the addressing and message meta-data properties are not populated, the ITKMessage.getFullPayload() is null/blank or if there is a technical exception invoking the service provider such as underlying transport errors or timeouts (for instance if a SOAP fault is returned synchronously by the service provider)