uk.nhs.interoperability.transport

Class ITKInfrastructureAck

java.lang.Object

uk.nhs.interoperability.payload.ITKMessageImpl

uk.nhs.interoperability.transport.ITKInfrastructureAck

All Implemented Interfaces:

ITKAckDetails, ITKMessage

public class ITKInfrastructureAck
extends ITKMessageImpl
implements ITKAckDetails

The Class ITKInfrastructureAck.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACK_PROFILE_ID The Constant ACK_PROFILE_ID.
static String	ACK_SERVICE_ID The Constant ACK_SERVICE_ID.

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

businessPayload, isResponse, messageProperties, preResolvedTransportRoute

Constructor Summary

Constructors

Constructor and Description
ITKInfrastructureAck(ITKMessageProperties requestMessageProperties, String auditIdentity) Instantiates a new iTK infrastructure ack.
ITKInfrastructureAck(ITKMessageProperties requestMessageProperties, String auditIdentity, ITKMessagingException itkMessagingException) Instantiates a new iTK infrastructure ack.

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
ITKAddress	getIntendedRecipient() Provides the ITKAddress for the intended recipient of the message being acknowledged
ITKMessagingException	getNackError() Obtains details about the error for which the Nack is being generated.
String	getReportingIdentity() Get the identity of the node that originated the InfrastructureAck This may be different to the ITKAckDetails.getIntendedRecipient() if a nack was generated by an intermediary node
String	getServiceRef() The service identifier from the message being acknowledged
String	getTrackingRef() The tracking id reference from the message being acknowledged
boolean	isNack() Convenient method to simply establish whether the ITKAckDetails represents an Ack or Nack

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

getMessageProperties, getPreresolvedRoute, isResponse, setBusinessPayload, setIsReponse, setMessageProperties

Methods inherited from class java.lang.Object

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

Field Detail

ACK_PROFILE_ID

public static final String ACK_PROFILE_ID

The Constant ACK_PROFILE_ID.

See Also:

Constant Field Values

ACK_SERVICE_ID

public static final String ACK_SERVICE_ID

The Constant ACK_SERVICE_ID.

See Also:

Constant Field Values

Constructor Detail

ITKInfrastructureAck

public ITKInfrastructureAck(ITKMessageProperties requestMessageProperties,
                    String auditIdentity)

Instantiates a new iTK infrastructure ack.

Parameters:

requestMessageProperties - the request message properties

auditIdentity - the audit identity

ITKInfrastructureAck

public ITKInfrastructureAck(ITKMessageProperties requestMessageProperties,
                    String auditIdentity,
                    ITKMessagingException itkMessagingException)

Instantiates a new iTK infrastructure ack.

Parameters:

requestMessageProperties - the request message properties

auditIdentity - the audit identity

itkMessagingException - the itk messaging exception

Method Detail

getFullPayload

public String getFullPayload()
                      throws ITKMessagingException

Description copied from interface: ITKMessage

Obtains the full ITKMessage including any wrappers

Specified by:

getFullPayload in interface ITKMessage

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

getBusinessPayload

public String getBusinessPayload()

Description copied from interface: ITKMessage

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.

Specified by:

getBusinessPayload in interface ITKMessage

Overrides:

getBusinessPayload in class ITKMessageImpl

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

getIntendedRecipient

public ITKAddress getIntendedRecipient()

Description copied from interface: ITKAckDetails

Provides the ITKAddress for the intended recipient of the message being acknowledged

Specified by:

getIntendedRecipient in interface ITKAckDetails

Returns:

an ITKAddress representing the logical addressee information of the intended recipient of the message being acknowledged

getNackError

public ITKMessagingException getNackError()

Description copied from interface: ITKAckDetails

Obtains details about the error for which the Nack is being generated. If the the ITKAckDetails is an Ack (rather than Nack) then there is no associated error information and null is returned.

Specified by:

getNackError in interface ITKAckDetails

Returns:

An ITKMessagingException encapsulating the error details

getReportingIdentity

public String getReportingIdentity()

Description copied from interface: ITKAckDetails

Get the identity of the node that originated the InfrastructureAck This may be different to the ITKAckDetails.getIntendedRecipient() if a nack was generated by an intermediary node

Specified by:

getReportingIdentity in interface ITKAckDetails

Returns:

A string representation of the reporting identity

getServiceRef

public String getServiceRef()

Description copied from interface: ITKAckDetails

The service identifier from the message being acknowledged

Specified by:

getServiceRef in interface ITKAckDetails

Returns:

A string representation of the service - e.g. urn:nhs-itk:services:201005:SendCDADocument-v2-0

getTrackingRef

public String getTrackingRef()

Description copied from interface: ITKAckDetails

The tracking id reference from the message being acknowledged

Specified by:

getTrackingRef in interface ITKAckDetails

Returns:

A String representation of the id (note this should be a UUID) TODO - should the method actually return a UUID?

isNack

public boolean isNack()

Description copied from interface: ITKAckDetails

Convenient method to simply establish whether the ITKAckDetails represents an Ack or Nack

Specified by:

isNack in interface ITKAckDetails

Returns:

true if it is a Nack (i.e. ITKAckDetails.getNackError() is not null), false otherwise