ITKMessagePropertiesImpl (ITK API and Reference Implementation mini-site 0.1-SNAPSHOT API)

java.lang.Object
- uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl

All Implemented Interfaces:

ITKMessageProperties
```
public class ITKMessagePropertiesImpl
extends Object
implements ITKMessageProperties
```
The Class ITKMessagePropertiesImpl.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jone

Field Summary
- Fields inherited from interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
  BUSINESS_ACK_HANDLING_SPECIFICATION_KEY, INTERACTION_HANDLING_SPECIFICATION_KEY

Constructor Summary

Constructors
Constructor and Description

ITKMessagePropertiesImpl()

Constructors
Constructor and Description
`ITKMessagePropertiesImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHandlingSpecification(String key, String value)` Allows the message originator to add a handling specification to the associated `ITKMessage`. Handling specifications provide an extensible mechanism for the message originator to attach special processing instructions with the message.
`static ITKMessageProperties`	`build(Document distributionEnvelope)` Builds the.
`static Document`	`extractDistributionEnvelopeFromSoap(Document doc)` Extract distribution envelope from soap.
`ITKIdentity`	`getAuditIdentity()` Returns the audit identity of the ITK message originator
`String`	`getBusinessPayloadId()` Obtains the business payloadId associated with this message.
`ITKAddress`	`getFromAddress()` Obtains the originators ITK address
`String`	`getHandlingSpecification(String key)` Convenience method that allows the value of the handling specification to be obtained directly.
`Map<String,String>`	`getHandlingSpecifications()` Obtains the Map of the handling specifications associated with the `ITKMessage`. Handling specifications provide an extensible mechanism for the message originator to attach special processing instructions with the message.
`ITKTransportProperties`	`getInboundTransportProperties()` Obtains the `ITKTransportProperties` that are associated with the ITKMessage that was received by the service provider on the inbound leg in an asynchronous request/response invocation. The `inboundITKTransportProperties` are not expected to be processed by the application layer, however where present the application layer is responsible for attaching the `inboundITKTransportProperties` to any responses generated such that these transport properties are available to the transport layers transmitting the response. A typical use of this mechanism is for the propagation of the `<wsa:replyTo/>` address such that it is available to the to the transport layers managing the "reply". Note although this pattern adds some additional burden on the application layer it offers significant advantages over the alternative where the transport layer has to maintain state and correlate messages - potentially over several distributed nodes
`String`	`getProfileId()` Obtains the profileId associated with the ITKMessage.
`String`	`getServiceId()` ITK message service associated with the message
`ITKAddress`	`getToAddress()` Obtains the destination address for the associated ITK Message. Note Whilst the ITK Specifications allow for multiple recipients to be specified this version of the ITK API only supports a single recipient to be defined as this satisfies the majority of anticipated use-cases.
`String`	`getTrackingId()` Obtains the tracking id associated with the ITKMessage when sending the message between two or more endpoints.
`void`	`setAuditIdentity(ITKIdentity auditIdentity)` Sets the audit identity of the message originator
`void`	`setBusinessPayloadId(String businessPayloadId)` Sets the business payloadId associated with this message.
`void`	`setFromAddress(ITKAddress fromAddress)` Sets the originators address for this message.
`void`	`setInboundTransportProperties(ITKTransportProperties inboundTransportProperties)` Sets the `ITKTransportProperties` that are associated with the ITKMessage that was received by the service provider on the inbound leg in an asynchronous request/response invocation. The `inboundITKTransportProperties` are not expected to be processed by the application layer, however where present the application layer is responsible for attaching the `inboundITKTransportProperties` to any responses generated such that these transport properties are available to the transport layers transmitting the response. A typical use of this mechanism is for the propagation of the `<wsa:replyTo/>` URL such that it is available to the to the transport layers managing the "reply". Note although this pattern adds some additional burden on the application layer it offers significant advantages over the alternative where the transport layer has to maintain state and correlate messages - potentially over several distributed nodes
`void`	`setProfileId(String profileId)` Sets the profileId associated with the ITKMessage.
`void`	`setServiceId(String serviceId)` Sets the ITK message serviceId associated with this message
`void`	`setToAddress(ITKAddress toAddress)` Sets the destination address for the associated ITK Message. Note Whilst the ITK Specifications allow for multiple recipients to be specified this version of the ITK API only supports a single recipient to be defined as this satisfies the majority of anticipated use-cases.
`void`	`setTrackingId(String trackingId)` Sets the tracking id associated with the ITKMessage prior to sending the message between two or more endpoints.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ITKMessagePropertiesImpl
```
public ITKMessagePropertiesImpl()
```
- Method Detail
  - getTrackingId
```
public String getTrackingId()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the tracking id associated with the ITKMessage when sending the message between two or more endpoints. The tracking id should not have meaning beyond the original ITK transmission and associated acknowledgements. In particular the trackingId is not expected to be an id directly represented in the business payload such as a CDA document instance id. Ids associated with the business payload are obtained via ITKMessageProperties.getBusinessPayloadId().
    
    The primary purpose of the tracking Id is for operational reasons (i.e. allows entries in log file across different servers and nodes to be tied together) and for correlation of asynchronous acknowledgements such as ITK Infrastructure acknowledgements (see ITKAckDetails.getTrackingRef()) and ITK Business Acknowledgements.
    
    Specified by:
    
    getTrackingId in interface ITKMessageProperties
    
    Returns:
    a String with the UUID represent the tracking Id
  - setTrackingId
```
public void setTrackingId(String trackingId)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the tracking id associated with the ITKMessage prior to sending the message between two or more endpoints. The tracking id should not have meaning beyond the original ITK transmission and associated acknowledgements. In particular the trackingId is not expected to be an id directly represented in the business payload such as a CDA document instance id. Ids associated with the business payload are set via ITKMessageProperties.setBusinessPayloadId(String).
    
    The primary purpose of the tracking Id is for operational reasons (i.e. allows entries in log file across different servers and nodes to be tied together) and for correlation of asynchronous acknowledgements such as ITK Infrastructure acknowledgements (see ITKAckDetails.getTrackingRef()) and ITK Business Acknowledgements.
    
    Specified by:
    
    setTrackingId in interface ITKMessageProperties
    
    Parameters:
    trackingId - a String UUID representing the tracking Id for this transmission. Note if the message is resent a new tracking Id should be created
  - getFromAddress
```
public ITKAddress getFromAddress()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the originators ITK address
    
    Specified by:
    
    getFromAddress in interface ITKMessageProperties
    
    Returns:
    and ITKAddress object with the address details of the message originator
  - setFromAddress
```
public void setFromAddress(ITKAddress fromAddress)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the originators address for this message.
    
    Specified by:
    
    setFromAddress in interface ITKMessageProperties
    
    Parameters:
    fromAddress - the ITKAddress object with the address details of the message originator
  - getToAddress
```
public ITKAddress getToAddress()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the destination address for the associated ITK Message.
    
    Note Whilst the ITK Specifications allow for multiple recipients to be specified this version of the ITK API only supports a single recipient to be defined as this satisfies the majority of anticipated use-cases.
    
    Specified by:
    
    getToAddress in interface ITKMessageProperties
    
    Returns:
    The ITKAddress object containing the address details of the intended recipient
  - setToAddress
```
public void setToAddress(ITKAddress toAddress)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the destination address for the associated ITK Message.
    
    Note Whilst the ITK Specifications allow for multiple recipients to be specified this version of the ITK API only supports a single recipient to be defined as this satisfies the majority of anticipated use-cases.
    
    Specified by:
    
    setToAddress in interface ITKMessageProperties
    
    Parameters:
    toAddress - the ITKAddress object containing the address details of the intended recipient
  - getAuditIdentity
```
public ITKIdentity getAuditIdentity()
```
    Description copied from interface: ITKMessageProperties
    
    Returns the audit identity of the ITK message originator
    
    Specified by:
    
    getAuditIdentity in interface ITKMessageProperties
    
    Returns:
    An ITKIdentity object containing the audit id
  - setAuditIdentity
```
public void setAuditIdentity(ITKIdentity auditIdentity)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the audit identity of the message originator
    
    Specified by:
    
    setAuditIdentity in interface ITKMessageProperties
  - getServiceId
```
public String getServiceId()
```
    Description copied from interface: ITKMessageProperties
    
    ITK message service associated with the message
    
    Specified by:
    
    getServiceId in interface ITKMessageProperties
    
    Returns:
    a String identifying the ITK Service Id
  - setServiceId
```
public void setServiceId(String serviceId)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the ITK message serviceId associated with this message
    
    Specified by:
    
    setServiceId in interface ITKMessageProperties
    
    Parameters:
    serviceId - The String identifying the ITK Service (from ITK Domain Message Specifications)
  - getBusinessPayloadId
```
public String getBusinessPayloadId()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the business payloadId associated with this message. This business payload message Id is typically used for tracking and correlating messages.
    
    Note The business payload id is logically distinct from the ITKMessageProperties.getTrackingId() as it is an id that is typically embedded somewhere in the business payload - for example as a document instance id in a CDA message, whereas the ITKMessageProperties.getTrackingId() is specifically an id assigned when sending the message between two or more endpoints and should not have meaning beyond the original ITK transmission and associated acknowledgements.
    
    Specified by:
    
    getBusinessPayloadId in interface ITKMessageProperties
    
    Returns:
    The UUID associated with the ITK Message business payload
  - setBusinessPayloadId
```
public void setBusinessPayloadId(String businessPayloadId)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the business payloadId associated with this message. This business payload message Id is typically used for tracking and correlating messages
    
    Specified by:
    
    setBusinessPayloadId in interface ITKMessageProperties
    
    Parameters:
    businessPayloadId - The UUID associated with the ITK Message business payload
  - getProfileId
```
public String getProfileId()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the profileId associated with the ITKMessage. The profile Id represents the set of rules used to construct the message and provides a single String that aides with message/document version management as well as allowing message/document consumers to understand whether or not they are capable of handling the associated ITK Message
    
    Specified by:
    
    getProfileId in interface ITKMessageProperties
    
    Returns:
    The profile id (e.g. nhs-en:profile:nonCodedCDADocument-v2-0)
  - setProfileId
```
public void setProfileId(String profileId)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the profileId associated with the ITKMessage. The profile Id represents the set of rules used to construct the message and provides a single String that aides with message/document version management as well as allowing message/document consumers to understand whether or not they are capable of handling the associated ITK Message
    
    Specified by:
    
    setProfileId in interface ITKMessageProperties
    
    Parameters:
    profileId - The profile id (e.g. nhs-en:profile:nonCodedCDADocument-v2-0)
  - getInboundTransportProperties
```
public ITKTransportProperties getInboundTransportProperties()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the ITKTransportProperties that are associated with the ITKMessage that was received by the service provider on the inbound leg in an asynchronous request/response invocation.
    
    The inboundITKTransportProperties are not expected to be processed by the application layer, however where present the application layer is responsible for attaching the inboundITKTransportProperties to any responses generated such that these transport properties are available to the transport layers transmitting the response.
    
    A typical use of this mechanism is for the propagation of the <wsa:replyTo/> address such that it is available to the to the transport layers managing the "reply".
    
    Note although this pattern adds some additional burden on the application layer it offers significant advantages over the alternative where the transport layer has to maintain state and correlate messages - potentially over several distributed nodes
    
    Specified by:
    
    getInboundTransportProperties in interface ITKMessageProperties
    
    Returns:
    inboundITKTransportProperties - the ITKTransportProperties that were obtained from the inbound message.
  - setInboundTransportProperties
```
public void setInboundTransportProperties(ITKTransportProperties inboundTransportProperties)
```
    Description copied from interface: ITKMessageProperties
    
    Sets the ITKTransportProperties that are associated with the ITKMessage that was received by the service provider on the inbound leg in an asynchronous request/response invocation.
    
    The inboundITKTransportProperties are not expected to be processed by the application layer, however where present the application layer is responsible for attaching the inboundITKTransportProperties to any responses generated such that these transport properties are available to the transport layers transmitting the response.
    
    A typical use of this mechanism is for the propagation of the <wsa:replyTo/> URL such that it is available to the to the transport layers managing the "reply".
    
    Note although this pattern adds some additional burden on the application layer it offers significant advantages over the alternative where the transport layer has to maintain state and correlate messages - potentially over several distributed nodes
    
    Specified by:
    
    setInboundTransportProperties in interface ITKMessageProperties
    
    Parameters:
    inboundTransportProperties - The ITKTransportProperties that were obtained from the inbound message.
  - getHandlingSpecifications
```
public Map<String,String> getHandlingSpecifications()
```
    Description copied from interface: ITKMessageProperties
    
    Obtains the Map of the handling specifications associated with the ITKMessage.
    
    Handling specifications provide an extensible mechanism for the message originator to attach special processing instructions with the message. The current ITK specifications provide two built-in handling specifications - one for requesting a business acknowledgement message (ITKMessageProperties.BUSINESS_ACK_HANDLING_SPECIFICATION_KEY), and one to explicitly associated an interaction Id with the message (ITKMessageProperties.INTERACTION_HANDLING_SPECIFICATION_KEY).
    
    Specified by:
    
    getHandlingSpecifications in interface ITKMessageProperties
    
    Returns:
    The Map of all handling specifications associated with the message. For each entry in the Map contains both the key (e.g. urn:nhs:itk:ns:201005:ackrequested) and the associated value. If no handling specifications are associated with the message then an empty map is returned.
  - addHandlingSpecification
```
public void addHandlingSpecification(String key,
                            String value)
```
    Description copied from interface: ITKMessageProperties
    
    Allows the message originator to add a handling specification to the associated ITKMessage.
    
    Handling specifications provide an extensible mechanism for the message originator to attach special processing instructions with the message. The current ITK specifications provide two built-in handling specifications - one for requesting a business acknowledgement message (ITKMessageProperties.BUSINESS_ACK_HANDLING_SPECIFICATION_KEY), and one to explicitly associated an interaction Id with the message (ITKMessageProperties.INTERACTION_HANDLING_SPECIFICATION_KEY).
    
    Specified by:
    
    addHandlingSpecification in interface ITKMessageProperties
    
    Parameters:
    key - The handling specification key - for instance ITKMessageProperties.BUSINESS_ACK_HANDLING_SPECIFICATION_KEY
    value - The appropriate value for the handling specification
  - getHandlingSpecification
```
public String getHandlingSpecification(String key)
```
    Description copied from interface: ITKMessageProperties
    
    Convenience method that allows the value of the handling specification to be obtained directly.
    
    Specified by:
    
    getHandlingSpecification in interface ITKMessageProperties
    
    Parameters:
    key - The handling specification key - for instance ITKMessageProperties.BUSINESS_ACK_HANDLING_SPECIFICATION_KEY
    
    Returns:
    The value associated with the provided key or null if the handling specification indicated by the key was not present
  - extractDistributionEnvelopeFromSoap
```
public static Document extractDistributionEnvelopeFromSoap(Document doc)
                                                    throws ITKMessagingException
```
    Extract distribution envelope from soap.
    
    Parameters:
    doc - the doc
    
    Returns:
    the document
    
    Throws:
    
    ITKMessagingException - the iTK messaging exception
  - build
```
public static ITKMessageProperties build(Document distributionEnvelope)
                                  throws ITKMessagingException
```
    Builds the.
    
    Parameters:
    distributionEnvelope - the distribution envelope
    
    Returns:
    the iTK message properties
    
    Throws:
    
    ITKMessagingException - the iTK messaging exception

All content is available under the Open Government Licence, except where otherwise stated
All example source code is available under Apache 2.0, except where otherwise stated

Class ITKMessagePropertiesImpl

Field Summary

Fields inherited from interface uk.nhs.interoperability.infrastructure.ITKMessageProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ITKMessagePropertiesImpl

Method Detail

getTrackingId

setTrackingId

getFromAddress

setFromAddress

getToAddress

setToAddress

getAuditIdentity

setAuditIdentity

getServiceId

setServiceId

getBusinessPayloadId

setBusinessPayloadId

getProfileId

setProfileId

getInboundTransportProperties

setInboundTransportProperties

getHandlingSpecifications

addHandlingSpecification

getHandlingSpecification

extractDistributionEnvelopeFromSoap

build