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

java.lang.Object
- uk.nhs.interoperability.payload.ITKMessageImpl

All Implemented Interfaces:

ITKMessage

Direct Known Subclasses:

DEWrappedMessage, ITKInfrastructureAck, ITKSimpleMessageResponse, SimpleMessage, WSSOAPMessageImpl
```
public abstract class ITKMessageImpl
extends Object
implements ITKMessage
```
The Class ITKMessageImpl.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`businessPayload` The business payload.
`protected boolean`	`isResponse` The is response.
`protected ITKMessageProperties`	`messageProperties` The message properties.
`protected ITKTransportRoute`	`preResolvedTransportRoute` The pre resolved transport route.

Constructor Summary

Constructors
Constructor and Description
`ITKMessageImpl()` Instantiates a new iTK message impl.
`ITKMessageImpl(ITKMessageProperties itkMessageProperties)` Instantiates a new iTK message impl.
`ITKMessageImpl(ITKMessageProperties itkMessageProperties, String auditIdentity, String profileId, boolean reflectMessageProperties)` Instantiates a new iTK message impl.

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.
`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`	`setIsReponse(boolean isReponse)` Sets the checks if is reponse.
`void`	`setMessageProperties(ITKMessageProperties messageProperties)` Sets the `ITKMessageProperties` associated with this message.

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

Methods inherited from interface uk.nhs.interoperability.payload.ITKMessage
getFullPayload

- Field Detail
  - messageProperties
```
protected ITKMessageProperties messageProperties
```
    The message properties.
  - businessPayload
```
protected String businessPayload
```
    The business payload.
  - isResponse
```
protected boolean isResponse
```
    The is response.
  - preResolvedTransportRoute
```
protected ITKTransportRoute preResolvedTransportRoute
```
    The pre resolved transport route.
- Constructor Detail
  - ITKMessageImpl
```
public ITKMessageImpl()
```
    Instantiates a new iTK message impl.
  - ITKMessageImpl
```
public ITKMessageImpl(ITKMessageProperties itkMessageProperties)
```
    Instantiates a new iTK message impl.
    
    Parameters:
    itkMessageProperties - the itk message properties
  - ITKMessageImpl
```
public ITKMessageImpl(ITKMessageProperties itkMessageProperties,
              String auditIdentity,
              String profileId,
              boolean reflectMessageProperties)
```
    Instantiates a new iTK message impl.
    
    Parameters:
    itkMessageProperties - the itk message properties
    auditIdentity - the audit identity
    profileId - the profile id
    reflectMessageProperties - the reflect message properties
- Method Detail
  - 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
    
    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
  - 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
    
    Parameters:
    businessPayload - A string representation of the business payload message
  - getMessageProperties
```
public ITKMessageProperties getMessageProperties()
```
    Description copied from interface: ITKMessage
    
    Obtains the ITKMessageProperties associated with this message. These properties provide relevant addressing and meta-data about the message.
    
    Specified by:
    
    getMessageProperties in interface ITKMessage
    
    Returns:
    the ITKMessageProperties associated with the message or null if no ITKMessageProprties have been set.
  - setMessageProperties
```
public void setMessageProperties(ITKMessageProperties messageProperties)
```
    Description copied from interface: ITKMessage
    
    Sets the ITKMessageProperties associated with this message. These properties provide relevant addressing and meta-data about the message.
    
    Specified by:
    
    setMessageProperties in interface ITKMessage
    
    Parameters:
    messageProperties - the ITKMessageProperties associated with the message.
  - getPreresolvedRoute
```
public ITKTransportRoute getPreresolvedRoute()
```
    Description copied from interface: ITKMessage
    
    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.
    
    Specified by:
    
    getPreresolvedRoute in interface ITKMessage
    
    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
```
public boolean isResponse()
```
    Description copied from interface: ITKMessage
    
    Indicates whether this ITKMessage instance is in response to a request message such as a query
    
    Specified by:
    
    isResponse in interface ITKMessage
    
    Returns:
    true if this message is a response, false otherwise.
  - setIsReponse
```
public void setIsReponse(boolean isReponse)
```
    Sets the checks if is reponse.
    
    Parameters:
    isReponse - the new checks if is reponse

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 ITKMessageImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface uk.nhs.interoperability.payload.ITKMessage

Field Detail

messageProperties

businessPayload

isResponse

preResolvedTransportRoute

Constructor Detail

ITKMessageImpl

ITKMessageImpl

ITKMessageImpl

Method Detail

getBusinessPayload

setBusinessPayload

getMessageProperties

setMessageProperties

getPreresolvedRoute

isResponse

setIsReponse