uk.nhs.interoperability.transport

Interface ITKSender

All Known Implementing Classes:

ITKSenderWSImpl

public interface ITKSender

Interface that represents the transport neutral interface 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

Method Summary

Methods

Modifier and Type	Method and Description
void	send(ITKTransportRoute destination, ITKMessage request) Operation that allows a business payload and ITK wrappers (e.g.
void	sendAysnc(ITKTransportRoute destination, ITKMessage request) Operation that allows a business payload and ITK wrappers (e.g.
ITKMessage	sendSync(ITKTransportRoute destination, ITKMessage request) Operation that allows a business payload and ITK wrappers (e.g.

Method Detail

send

void send(ITKTransportRoute destination,
        ITKMessage request)
          throws ITKMessagingException

Operation that allows a business payload and ITK wrappers (e.g. DistributionEnvelope) to be sent to the destination service/system via the transport specific implementation.

Expected to be used in conjunction with ITKMessageSender.send(ITKMessage) for the specific transport associated with the service

Parameters:

destination - The ITKTransportRoute providing the transport invocation path for this operation

request - This is the ITK Wrapped message that is being sent.

Throws:

ITKMessagingException - If the destination is null, the request is null, or if there is transport timeout or error or if there is a technical exception invoking the service provider (for instance if a SOAP fault is returned by the service provider)

sendSync

ITKMessage sendSync(ITKTransportRoute destination,
                  ITKMessage request)
                    throws ITKMessagingException

Operation that allows a business payload and ITK wrappers (e.g. DistributionEnvelope) to be sent synchronously to the destination service/system via the transport specific implementation.

Expected to be used in conjunction with ITKMessageSender.sendSync(ITKMessage) for the specific transport associated with the service.

Parameters:

destination - The ITKTransportRoute providing the transport invocation path for this operation

request - This is the ITK Wrapped message that is being sent.

Throws:

ITKMessagingException - If the destination is null, the request is null, or if there is transport timeout or error or if there is a technical exception invoking the service provider (for instance if a SOAP fault is returned by the service provider)

sendAysnc

void sendAysnc(ITKTransportRoute destination,
             ITKMessage request)
               throws ITKMessagingException

Operation that allows a business payload and ITK wrappers (e.g. DistributionEnvelope) to be sent asynchronously to the destination service/system via the transport specific implementation.

Expected to be used in conjunction with ITKMessageSender.sendAsync(ITKMessage) for the specific transport associated with the service.

Parameters:

destination - The ITKTransportRoute providing the transport invocation path for this operation

request - This is the ITK Wrapped message that is being sent.

Throws:

ITKMessagingException - If the destination is null, the request is null, or if there is transport timeout or error or if there is a technical exception invoking the transport for the first leg of the routed message's path to the service provider (depending on the deployment landscape this could be an exception returned by the service provider if there is only one leg for the routed message)