uk.nhs.interoperability.payload

Interface ITKMessage

All Known Implementing Classes:

DEWrappedMessage, ITKInfrastructureAck, ITKMessageImpl, ITKSimpleMessageResponse, SimpleMessage, WSSOAPMessageImpl

public interface ITKMessage

Interface representing the characteristics of an ITK message being transmitted via the ITK message transport and distribution layers (i.e. this API).

As well as providing a standard way of setting / obtaining the business payload (i.e. the business message itself) it also provides a standardised set of meta-data for the message too via the ITKMessageProperties.

Note: it is expected that business payload API developers will either provide classes that directly implement this interface or will provide suitable adaptor classes to enable the payload and transport distribution APIs to be seamlessly integrated.

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

Method Summary

Methods

Modifier and Type	Method and Description
String	getBusinessPayload() Obtains the business payload portion of the message to be transmitted via the ITK transport and distribution infrastructure. Note: those (ADT v2 pipe and hat) messages that ITK requires to be base64 encoded when being transmitted will not be encoded - i.e.
String	getFullPayload() Obtains the full ITKMessage including any wrappers
ITKMessageProperties	getMessageProperties() Obtains the ITKMessageProperties associated with this message.
ITKTransportRoute	getPreresolvedRoute() Obtains any pre-resolved ITKTransportRoute associated with this ITKMessage. A pre-resolved transport route might be present if this ITKMessage instance is a response where the return address is already known (e.g.
boolean	isResponse() Indicates whether this ITKMessage instance is in response to a request message such as a query
void	setBusinessPayload(String businessPayload) Sets the business payload portion of the message to be transmitted via the ITK transport and distribution infrastructure. Note: those (ADT v2 pipe and hat) messages that ITK requires to be base64 encoded when being transmitted must not need to be pre-encoded - i.e.
void	setMessageProperties(ITKMessageProperties itkMessageProperties) Sets the ITKMessageProperties associated with this message.

Method Detail

getMessageProperties

ITKMessageProperties getMessageProperties()

Obtains the ITKMessageProperties associated with this message. These properties provide relevant addressing and meta-data about the message.

Returns:

the ITKMessageProperties associated with the message or null if no ITKMessageProprties have been set.

setMessageProperties

void setMessageProperties(ITKMessageProperties itkMessageProperties)

Sets the ITKMessageProperties associated with this message. These properties provide relevant addressing and meta-data about the message.

Parameters:

itkMessageProperties - the ITKMessageProperties associated with the message.

setBusinessPayload

void setBusinessPayload(String businessPayload)

Sets the business payload portion of the message to be transmitted via the ITK transport and distribution infrastructure.

Note: those (ADT v2 pipe and hat) messages that ITK requires to be base64 encoded when being transmitted must not need to be pre-encoded - i.e. they should be supplied in plain text. It is the responsibility of the implementation to ensure that appropriate encoding/decoding is performed behind the scenes.

Note: for version 0.1 the signature of this method has been defined as a String to keep implementation simple. As a consequence implementations should ensure that payloads are provided as UTF-16 encoded strings.

Parameters:

businessPayload - A string representation of the business payload message

getBusinessPayload

String getBusinessPayload()

Obtains the business payload portion of the message to be transmitted via the ITK transport and distribution infrastructure.

Note: those (ADT v2 pipe and hat) messages that ITK requires to be base64 encoded when being transmitted will not be encoded - i.e. they will be supplied in plain text. It is the responsibility of the implementation to ensure that appropriate encoding/decoding is performed behind the scenes.

Returns:

for version 0.1 the return type of this method has been defined as a String to keep implementation simple. As a consequence the business payload will be returned as a UTF-16 encoded string

getFullPayload

String getFullPayload()
                      throws ITKMessagingException

Obtains the full ITKMessage including any wrappers

Returns:

The full ITK message payload including wrappers. For ITKMessage instances that includes wrappers (for instance where the business payload has been wrapped in a distribution envelope or SOAP envelope) this method returns the full message. Otherwise the method returns an identical String to getBusinessPayload()

Throws:

ITKMessagingException - If there is an error serialising the full ITKMessage

getPreresolvedRoute

ITKTransportRoute getPreresolvedRoute()

Obtains any pre-resolved ITKTransportRoute associated with this ITKMessage.

A pre-resolved transport route might be present if this ITKMessage instance is a response where the return address is already known (e.g. via a SOAP <wsa:ReplyTo/> address provided in the request), or because the application layer has already resolved the ITKTransportRoute for the target destination.

Returns:

a pre-resolved ITKTransportRoute if present, or null otherwise. If no pre-resolved transport route is present it is the responsibility of the implementation to determine the ITKTransportRoute via the DirectoryOfServices.resolveDestination(String, uk.nhs.interoperability.infrastructure.ITKAddress) method call

isResponse

boolean isResponse()

Indicates whether this ITKMessage instance is in response to a request message such as a query

Returns:

true if this message is a response, false otherwise.