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

All Known Implementing Classes:

ITKTransportPropertiesImpl
```
public interface ITKTransportProperties
```
Container for transport properties associated with the ITKMessage.

The transport properties represented here have been drived from the useful set of properties from <soap/> however they should be abstract enough to represent for different transports such as TMS and DTS

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

See Also:
ITKMessageProperties, ITKMessage

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getInvokedUrl()` Gets the URL of the invoked service or transport hop. For SOAP this is mapped to/from `<wsa:To/>`
`String`	`getTransportAction()` Gets the transportAction for the associated ITKMessage. For SOAP this is mapped to/from `<wsa:Action/>`
`String`	`getTransportFaultTo()` Gets the transport address property that allows asynchronous transport layer faults to be returned. For SOAP this is mapped to/from `<wsa:FaultTo/>` Note if the transport does not support a distinct `faultTo` property this should return the same as `getTransportReplyTo()` property or failing that the `getTransportFrom()`
`ITKTransportRoute`	`getTransportFaultToRoute()` Convenience method to return a fully constructed `ITKTransportRoute` for returning asynchronous faults to.
`String`	`getTransportFrom()` Gets the transport from address property - this may be used to return asynchronous responses to the originator. For SOAP this is mapped to/from `<wsa:From/>`.
`String`	`getTransportMessageId()` Gets the unique transport level identifier for the associated message.
`String`	`getTransportRelatesTo()` Gets the transport relates to property that allows asynchronous transport layer messages to be correlated with their associated requests. For SOAP this is mapped to/from `<wsa:RelatesTo/>`.
`String`	`getTransportReplyTo()` Gets the transport address property that allows asynchronous transport layer responses to be returned. For SOAP this is mapped to/from `<wsa:ReplyTo/>`. Note if the transport does not support a distinct `replyTo` property this should return the same as the `getTransportFrom()`
`ITKTransportRoute`	`getTransportReplyToRoute()` Convenience method to return a fully constructed `ITKTransportRoute` for returning asynchronous response messages to.
`String`	`getTransportTo()` Gets the transport hop destination.
`void`	`setInvokedUrl(String invokedUrl)` Sets the URL of the invoked service or transport hop. For SOAP this is mapped to/from `<wsa:To/>`
`void`	`setTransportAction(String transportAction)` Sets the transportAction for the associated ITKMessage. For SOAP this is mapped to/from `<wsa:Action/>`
`void`	`setTransportFaultTo(String transportFaultTo)` Sets the transport address property that allows asynchronous transport layer faults to be returned. For SOAP this is mapped to/from `<wsa:FaultTo/>`. Note if the transport does not support a distinct `faultTo` property this should be set to the same as `setTransportReplyTo(String)` property or failing that the `setTransportFrom(String)`
`void`	`setTransportFrom(String transportFrom)` Sets the transport from address property - this may be used to return asynchronous responses to the originator. For SOAP this is mapped to/from `<wsa:From/>`.
`void`	`setTransportMessageId(String transportMessageId)` Sets the unique transport level identifier for the associated message.
`void`	`setTransportRelatesTo(String transportRelatesTo)` Sets the transport relates to property that allows asynchronous transport layer messages to be correlated with their associated requests. For SOAP this is mapped to/from `<wsa:RelatesTo/>`.
`void`	`setTransportReplyTo(String transportReplyTo)` Sets the transport address property that allows asynchronous transport layer responses to be returned. For SOAP this is mapped to/from `<wsa:ReplyTo/>`. Note if the transport does not support a distinct `replyTo` property this should be set to the same as the `setTransportFrom(String)`
`void`	`setTransportTo(String transportTo)` Sets the transport hop destination.
`void`	`setTransportType(String transportType)` Sets the transport type associated with this transport hop

- Method Detail
  - setTransportMessageId
```
@Requirement(traceTo="WS-ADR-01",
             status="abstract")
void setTransportMessageId(String transportMessageId)
```
    Sets the unique transport level identifier for the associated message. Typically this identifier is not know by, or preserved by application layer components and is often only pertinent to an individual transport hop (for example ITK WS-ADR-01 says every hop/WS invocation should use a new <wsa:MessageID/>).
    
    Parameters:
    transportMessageId -
  - getTransportMessageId
```
@Requirement(traceTo="WS-ADR-01",
             status="abstract")
String getTransportMessageId()
```
    Gets the unique transport level identifier for the associated message. Typically this identifier is not know by, or preserved by application layer components and is often only pertinent to an individual transport hop (for example ITK WS-ADR-01 says every hop/WS invocation should use a new <wsa:MessageID/>).
    
    Returns:
    the transportMessageId for the transport hop
  - setInvokedUrl
```
void setInvokedUrl(String invokedUrl)
```
    Sets the URL of the invoked service or transport hop.
    
    For SOAP this is mapped to/from <wsa:To/>
    
    Parameters:
    invokedUrl - The URL of the transport hop destination
  - getInvokedUrl
```
String getInvokedUrl()
```
    Gets the URL of the invoked service or transport hop.
    
    For SOAP this is mapped to/from <wsa:To/>
    
    Returns:
    the URL of the transport hop destination
  - setTransportAction
```
void setTransportAction(String transportAction)
```
    Sets the transportAction for the associated ITKMessage.
    
    For SOAP this is mapped to/from <wsa:Action/>
    
    Parameters:
    transportAction - The transport action - e.g. urn:nhs-itk:services:201005:transferPatient-v1-0
  - getTransportAction
```
String getTransportAction()
```
    Gets the transportAction for the associated ITKMessage.
    
    For SOAP this is mapped to/from <wsa:Action/>
    
    Returns:
    The transport action - e.g. urn:nhs-itk:services:201005:transferPatient-v1-0
  - setTransportFaultTo
```
void setTransportFaultTo(String transportFaultTo)
```
    Sets the transport address property that allows asynchronous transport layer faults to be returned.
    
    For SOAP this is mapped to/from <wsa:FaultTo/>.
    
    Note if the transport does not support a distinct faultTo property this should be set to the same as setTransportReplyTo(String) property or failing that the setTransportFrom(String)
    
    Parameters:
    transportFaultTo - The transport fault to address - e.g. http://myserver.com/faulthandler
  - getTransportFaultTo
```
String getTransportFaultTo()
```
    Gets the transport address property that allows asynchronous transport layer faults to be returned.
    
    For SOAP this is mapped to/from <wsa:FaultTo/>
    
    Note if the transport does not support a distinct faultTo property this should return the same as getTransportReplyTo() property or failing that the getTransportFrom()
    
    Returns:
    The transport fault to address - e.g. http://myserver.com/faulthandler
  - setTransportReplyTo
```
void setTransportReplyTo(String transportReplyTo)
```
    Sets the transport address property that allows asynchronous transport layer responses to be returned.
    
    For SOAP this is mapped to/from <wsa:ReplyTo/>.
    
    Note if the transport does not support a distinct replyTo property this should be set to the same as the setTransportFrom(String)
    
    Parameters:
    transportReplyTo - The transport reply to address - e.g. http://myserver.com/responsehandler
  - getTransportReplyTo
```
String getTransportReplyTo()
```
    Gets the transport address property that allows asynchronous transport layer responses to be returned.
    
    For SOAP this is mapped to/from <wsa:ReplyTo/>.
    
    Note if the transport does not support a distinct replyTo property this should return the same as the getTransportFrom()
    
    Returns:
    The transport reply to address - e.g. http://myserver.com/responsehandler
  - setTransportRelatesTo
```
void setTransportRelatesTo(String transportRelatesTo)
```
    Sets the transport relates to property that allows asynchronous transport layer messages to be correlated with their associated requests.
    
    For SOAP this is mapped to/from <wsa:RelatesTo/>.
    
    Parameters:
    transportRelatesTo - The message id of the message to which this relates. For request messages this should be null
  - getTransportRelatesTo
```
String getTransportRelatesTo()
```
    Gets the transport relates to property that allows asynchronous transport layer messages to be correlated with their associated requests.
    
    For SOAP this is mapped to/from <wsa:RelatesTo/>.
    
    Returns:
    The message id of the message to which this relates. For request messages this will return null
  - setTransportTo
```
void setTransportTo(String transportTo)
```
    Sets the transport hop destination. Typically (at least for SOAP) this may be equivalent to setInvokedUrl(String)
    
    Parameters:
    transportTo - The destination system address
  - getTransportTo
```
String getTransportTo()
```
    Gets the transport hop destination. Typically (at least for SOAP) this may be equivalent to getInvokedUrl()
    
    Returns:
    The destination system address
  - setTransportFrom
```
void setTransportFrom(String transportFrom)
```
    Sets the transport from address property - this may be used to return asynchronous responses to the originator.
    
    For SOAP this is mapped to/from <wsa:From/>.
    
    Parameters:
    transportFrom - The address of the message originator
  - getTransportFrom
```
String getTransportFrom()
```
    Gets the transport from address property - this may be used to return asynchronous responses to the originator.
    
    For SOAP this is mapped to/from <wsa:From/>.
    
    Returns:
    The address of the message originator
  - setTransportType
```
void setTransportType(String transportType)
```
    Sets the transport type associated with this transport hop
    
    Parameters:
    transportType - The transportType. Can be one of ITKTransportRoute.DTS; ITKTransportRoute.HTTP_WS; ITKTransportRoute.SPINE_TMS or ITKTransportRoute.UNKNOWN
  - getTransportReplyToRoute
```
ITKTransportRoute getTransportReplyToRoute()
```
    Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous response messages to.
    
    Returns:
    A fully constructed ITKTransportRoute or null if there is no getTransportReplyTo() address specified.
  - getTransportFaultToRoute
```
ITKTransportRoute getTransportFaultToRoute()
```
    Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous faults to.
    
    Returns:
    A fully constructed ITKTransportRoute or null if there is no getTransportFaultTo() address specified.

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

Interface ITKTransportProperties

Method Summary

Method Detail

setTransportMessageId

getTransportMessageId

setInvokedUrl

getInvokedUrl

setTransportAction

getTransportAction

setTransportFaultTo

getTransportFaultTo

setTransportReplyTo

getTransportReplyTo

setTransportRelatesTo

getTransportRelatesTo

setTransportTo

getTransportTo

setTransportFrom

getTransportFrom

setTransportType

getTransportReplyToRoute

getTransportFaultToRoute