uk.nhs.interoperability.infrastructure

Interface ITKAckDetails

All Known Implementing Classes:

ITKInfrastructureAck

public interface ITKAckDetails

Interface representing the pertinent information contained within an ITK Infrastructure Ack. Typically this information is used to convey the Ack (or Nack) information back to the originator of the message to which this Ack/Nack pertains.

It is an application responsibility to correlate the Ack/Nack back with the original message based on the tracking reference getTrackingRef() and getIntendedRecipient()*.

* Note In the 0.1 version of the API getIntendedRecipient() is not strictly required to correlating responses, however if the API scope is expanded to support mutli-destination messaging the intended recipient would also need to be used in the correlation

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

Method Summary

Methods

Modifier and Type	Method and Description
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 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

Method Detail

getTrackingRef

String getTrackingRef()

The tracking id reference from the message being acknowledged

Returns:

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

getServiceRef

String getServiceRef()

The service identifier from the message being acknowledged

Returns:

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

getReportingIdentity

String getReportingIdentity()

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

Returns:

A string representation of the reporting identity

getIntendedRecipient

ITKAddress getIntendedRecipient()

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

Returns:

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

getNackError

ITKMessagingException getNackError()

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.

Returns:

An ITKMessagingException encapsulating the error details

isNack

boolean isNack()

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

Returns:

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