uk.nhs.interoperability.payload

Class DEWrappedMessage

java.lang.Object

uk.nhs.interoperability.payload.ITKMessageImpl

uk.nhs.interoperability.payload.DEWrappedMessage

All Implemented Interfaces:

ITKMessage

public class DEWrappedMessage
extends ITKMessageImpl

The Class DEWrappedMessage.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DE_ADDRESSED Constant to indicate that the on the wire Distribution envelope XML contains logical originating and destination addresses
static boolean	DE_UNADDRESSED Constant to indicate that the on-the-wire Distribution envelope XML omits logical addressing (for instance this is not required in the case of synchronous calls)

Fields inherited from class uk.nhs.interoperability.payload.ITKMessageImpl

businessPayload, isResponse, messageProperties, preResolvedTransportRoute

Constructor Summary

Constructors

Constructor and Description
DEWrappedMessage() Instantiates a new dE wrapped message.
DEWrappedMessage(ITKMessage message) Instantiates a new dE wrapped message.
DEWrappedMessage(ITKService service, ITKMessage message, boolean addressed) Instantiates a new dE wrapped message.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFullPayload() Obtains the full ITKMessage including any wrappers
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.

Methods inherited from class uk.nhs.interoperability.payload.ITKMessageImpl

getBusinessPayload, getMessageProperties, getPreresolvedRoute, isResponse, setIsReponse, setMessageProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DE_ADDRESSED

public static final boolean DE_ADDRESSED

Constant to indicate that the on the wire Distribution envelope XML contains logical originating and destination addresses

See Also:

Constant Field Values

DE_UNADDRESSED

public static final boolean DE_UNADDRESSED

Constant to indicate that the on-the-wire Distribution envelope XML omits logical addressing (for instance this is not required in the case of synchronous calls)

See Also:

Constant Field Values

Constructor Detail

DEWrappedMessage

@Requirement(traceTo="COR-DEH-02",
             status="implemented")
public DEWrappedMessage()

Instantiates a new dE wrapped message.

DEWrappedMessage

public DEWrappedMessage(ITKMessage message)

Instantiates a new dE wrapped message.

Parameters:

message - the message

DEWrappedMessage

public DEWrappedMessage(ITKService service,
                ITKMessage message,
                boolean addressed)

Instantiates a new dE wrapped message.

Parameters:

service - the service

message - the message

addressed - the addressed

Method Detail

getFullPayload

@Requirement(traceTo={"COR-DEH-01","COR-DEH-04"},
             status="implemented")
public String getFullPayload()
                      throws ITKMessagingException

Description copied from interface: ITKMessage

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 ITKMessage.getBusinessPayload()

Throws:

ITKMessagingException - If there is an error serialising the full ITKMessage

setBusinessPayload

public void setBusinessPayload(String businessPayload)

Description copied from interface: ITKMessage

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.

Specified by:

setBusinessPayload in interface ITKMessage

Overrides:

setBusinessPayload in class ITKMessageImpl

Parameters:

businessPayload - A string representation of the business payload message