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

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

All Implemented Interfaces:

ITKTransportProperties
```
public class ITKTransportPropertiesImpl
extends Object
implements ITKTransportProperties
```
The Class ITKTransportPropertiesImpl.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Constructor Summary

Constructors
Constructor and Description

ITKTransportPropertiesImpl(String transportType)
Instantiates a new iTK transport properties impl.

Constructors
Constructor and Description
`ITKTransportPropertiesImpl(String transportType)` Instantiates a new iTK transport properties impl.

Method Summary

Methods
Modifier and Type	Method and Description
`static ITKTransportProperties`	`buildFromSoap(Document doc)` Builds the from soap.
`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 `ITKTransportProperties.getTransportReplyTo()` property or failing that the `ITKTransportProperties.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 `ITKTransportProperties.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 `ITKTransportProperties.setTransportReplyTo(String)` property or failing that the `ITKTransportProperties.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 `ITKTransportProperties.setTransportFrom(String)`
`void`	`setTransportTo(String transportTo)` Sets the transport hop destination.
`void`	`setTransportType(String transportType)` Sets the transport type associated with this transport hop
`String`	`toString()`

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

- Constructor Detail
  - ITKTransportPropertiesImpl
```
public ITKTransportPropertiesImpl(String transportType)
```
    Instantiates a new iTK transport properties impl.
    
    Parameters:
    transportType - the transport type
- Method Detail
  - getTransportFrom
```
public String getTransportFrom()
```
    Description copied from interface: ITKTransportProperties
    
    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/>.
    
    Specified by:
    
    getTransportFrom in interface ITKTransportProperties
    
    Returns:
    The address of the message originator
  - setTransportFrom
```
public void setTransportFrom(String transportFrom)
```
    Description copied from interface: ITKTransportProperties
    
    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/>.
    
    Specified by:
    
    setTransportFrom in interface ITKTransportProperties
    
    Parameters:
    transportFrom - The address of the message originator
  - getTransportTo
```
public String getTransportTo()
```
    Description copied from interface: ITKTransportProperties
    
    Gets the transport hop destination. Typically (at least for SOAP) this may be equivalent to ITKTransportProperties.getInvokedUrl()
    
    Specified by:
    
    getTransportTo in interface ITKTransportProperties
    
    Returns:
    The destination system address
  - setTransportTo
```
public void setTransportTo(String transportTo)
```
    Description copied from interface: ITKTransportProperties
    
    Sets the transport hop destination. Typically (at least for SOAP) this may be equivalent to ITKTransportProperties.setInvokedUrl(String)
    
    Specified by:
    
    setTransportTo in interface ITKTransportProperties
    
    Parameters:
    transportTo - The destination system address
  - getInvokedUrl
```
public String getInvokedUrl()
```
    Description copied from interface: ITKTransportProperties
    
    Gets the URL of the invoked service or transport hop.
    
    For SOAP this is mapped to/from <wsa:To/>
    
    Specified by:
    
    getInvokedUrl in interface ITKTransportProperties
    
    Returns:
    the URL of the transport hop destination
  - setInvokedUrl
```
public void setInvokedUrl(String invokedUrl)
```
    Description copied from interface: ITKTransportProperties
    
    Sets the URL of the invoked service or transport hop.
    
    For SOAP this is mapped to/from <wsa:To/>
    
    Specified by:
    
    setInvokedUrl in interface ITKTransportProperties
    
    Parameters:
    invokedUrl - The URL of the transport hop destination
  - getTransportRelatesTo
```
public String getTransportRelatesTo()
```
    Description copied from interface: ITKTransportProperties
    
    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/>.
    
    Specified by:
    
    getTransportRelatesTo in interface ITKTransportProperties
    
    Returns:
    The message id of the message to which this relates. For request messages this will return null
  - setTransportRelatesTo
```
public void setTransportRelatesTo(String transportRelatesTo)
```
    Description copied from interface: ITKTransportProperties
    
    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/>.
    
    Specified by:
    
    setTransportRelatesTo in interface ITKTransportProperties
    
    Parameters:
    transportRelatesTo - The message id of the message to which this relates. For request messages this should be null
  - getTransportReplyTo
```
public String getTransportReplyTo()
```
    Description copied from interface: ITKTransportProperties
    
    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 ITKTransportProperties.getTransportFrom()
    
    Specified by:
    
    getTransportReplyTo in interface ITKTransportProperties
    
    Returns:
    The transport reply to address - e.g. http://myserver.com/responsehandler
  - setTransportReplyTo
```
public void setTransportReplyTo(String transportReplyTo)
```
    Description copied from interface: ITKTransportProperties
    
    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 ITKTransportProperties.setTransportFrom(String)
    
    Specified by:
    
    setTransportReplyTo in interface ITKTransportProperties
    
    Parameters:
    transportReplyTo - The transport reply to address - e.g. http://myserver.com/responsehandler
  - getTransportFaultTo
```
public String getTransportFaultTo()
```
    Description copied from interface: ITKTransportProperties
    
    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 ITKTransportProperties.getTransportReplyTo() property or failing that the ITKTransportProperties.getTransportFrom()
    
    Specified by:
    
    getTransportFaultTo in interface ITKTransportProperties
    
    Returns:
    The transport fault to address - e.g. http://myserver.com/faulthandler
  - setTransportFaultTo
```
public void setTransportFaultTo(String transportFaultTo)
```
    Description copied from interface: ITKTransportProperties
    
    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 ITKTransportProperties.setTransportReplyTo(String) property or failing that the ITKTransportProperties.setTransportFrom(String)
    
    Specified by:
    
    setTransportFaultTo in interface ITKTransportProperties
    
    Parameters:
    transportFaultTo - The transport fault to address - e.g. http://myserver.com/faulthandler
  - getTransportAction
```
public String getTransportAction()
```
    Description copied from interface: ITKTransportProperties
    
    Gets the transportAction for the associated ITKMessage.
    
    For SOAP this is mapped to/from <wsa:Action/>
    
    Specified by:
    
    getTransportAction in interface ITKTransportProperties
    
    Returns:
    The transport action - e.g. urn:nhs-itk:services:201005:transferPatient-v1-0
  - setTransportAction
```
public void setTransportAction(String transportAction)
```
    Description copied from interface: ITKTransportProperties
    
    Sets the transportAction for the associated ITKMessage.
    
    For SOAP this is mapped to/from <wsa:Action/>
    
    Specified by:
    
    setTransportAction in interface ITKTransportProperties
    
    Parameters:
    transportAction - The transport action - e.g. urn:nhs-itk:services:201005:transferPatient-v1-0
  - getTransportMessageId
```
@Requirement(traceTo="WS-ADR-01",
             status="implemented")
public String getTransportMessageId()
```
    Description copied from interface: ITKTransportProperties
    
    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/>).
    
    Specified by:
    
    getTransportMessageId in interface ITKTransportProperties
    
    Returns:
    the transportMessageId for the transport hop
  - setTransportMessageId
```
@Requirement(traceTo="WS-ADR-01",
             status="implemented")
public void setTransportMessageId(String transportMessageId)
```
    Description copied from interface: ITKTransportProperties
    
    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/>).
    
    Specified by:
    
    setTransportMessageId in interface ITKTransportProperties
  - setTransportType
```
public void setTransportType(String transportType)
```
    Description copied from interface: ITKTransportProperties
    
    Sets the transport type associated with this transport hop
    
    Specified by:
    
    setTransportType in interface ITKTransportProperties
    
    Parameters:
    transportType - The transportType. Can be one of ITKTransportRoute.DTS; ITKTransportRoute.HTTP_WS; ITKTransportRoute.SPINE_TMS or ITKTransportRoute.UNKNOWN
  - getTransportFaultToRoute
```
public ITKTransportRoute getTransportFaultToRoute()
```
    Description copied from interface: ITKTransportProperties
    
    Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous faults to.
    
    Specified by:
    
    getTransportFaultToRoute in interface ITKTransportProperties
    
    Returns:
    A fully constructed ITKTransportRoute or null if there is no ITKTransportProperties.getTransportFaultTo() address specified.
  - getTransportReplyToRoute
```
public ITKTransportRoute getTransportReplyToRoute()
```
    Description copied from interface: ITKTransportProperties
    
    Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous response messages to.
    
    Specified by:
    
    getTransportReplyToRoute in interface ITKTransportProperties
    
    Returns:
    A fully constructed ITKTransportRoute or null if there is no ITKTransportProperties.getTransportReplyTo() address specified.
  - buildFromSoap
```
@Requirement(traceTo="WS-EXT-03",
             status="not-started")
public static ITKTransportProperties buildFromSoap(Document doc)
                                            throws ITKMessagingException
```
    Builds the from soap.
    
    Parameters:
    doc - the doc
    
    Returns:
    the iTK transport properties
    
    Throws:
    
    ITKMessagingException - the iTK messaging exception
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

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 ITKTransportPropertiesImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ITKTransportPropertiesImpl

Method Detail

getTransportFrom

setTransportFrom

getTransportTo

setTransportTo

getInvokedUrl

setInvokedUrl

getTransportRelatesTo

setTransportRelatesTo

getTransportReplyTo

setTransportReplyTo

getTransportFaultTo

setTransportFaultTo

getTransportAction

setTransportAction

getTransportMessageId

setTransportMessageId

setTransportType

getTransportFaultToRoute

getTransportReplyToRoute

buildFromSoap

toString