uk.nhs.interoperability.transport

Interface ITKTransportRoute

All Known Implementing Classes:

ITKTransportRouteImpl

public interface ITKTransportRoute

Interface representing the properties of a physical (transport specific) destination.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECT Constant to indicate that the service provider can be reached directly without any intermediary routing or the need for routing components an message instance information.
static String	DISTRIBUTION_ENVELOPE Constant to indicate that a distribution envelope should wrap the business payload for the transport route.
static String	DTS Constant to indicate a DTS (Data Transfer Service) ITKTransportRoute
static String	HTTP_WS Constant to indicate an HTTP SOAP/Web Service ITKTransportRoute
static String	NO_WRAPPER Constant to indicate that no wrappers are required for the transport route
static String	ROUTED Constant to indicate that the service provider can be reached via the routed message pattern (note this does not preclude the service provider being invoked via a single message hop)
static String	SPINE_TMS Constant to indicate a Spine TMS forward channel ITKTransportRoute
static String	UNKNOWN Indicates an unknown transport type

Method Summary

Methods

Modifier and Type	Method and Description
String	getDestinationType() Obtains the destination type
String	getExceptionToAddress() Obtains the address for sending an exceptions that are reported asynchronously
String	getPhysicalAddress() Obtains the transport specific physical destination address
String	getReplyToAddress() Obtains the address for any asynchronous replies
int	getTimeToLive() Obtains the time to live for any messages being sent via this ITKTransportRoute
String	getTransportType() Obtains the transport type for this ITKTransportRoute instance
String	getWrapperType() Obtains the details of any transport route wrappers that are required for the business payload
void	setWrapperType(String wrapperType) Sets the details of any transport route wrappers that are required for the business payload

Field Detail

UNKNOWN

static final String UNKNOWN

Indicates an unknown transport type

See Also:

Constant Field Values

HTTP_WS

static final String HTTP_WS

Constant to indicate an HTTP SOAP/Web Service ITKTransportRoute

See Also:

Constant Field Values

DTS

static final String DTS

Constant to indicate a DTS (Data Transfer Service) ITKTransportRoute

See Also:

Constant Field Values

SPINE_TMS

static final String SPINE_TMS

Constant to indicate a Spine TMS forward channel ITKTransportRoute

See Also:

Constant Field Values

DIRECT

static final String DIRECT

Constant to indicate that the service provider can be reached directly without any intermediary routing or the need for routing components an message instance information.

See Also:

Constant Field Values

ROUTED

static final String ROUTED

Constant to indicate that the service provider can be reached via the routed message pattern (note this does not preclude the service provider being invoked via a single message hop)

See Also:

Constant Field Values

NO_WRAPPER

static final String NO_WRAPPER

Constant to indicate that no wrappers are required for the transport route

See Also:

Constant Field Values

DISTRIBUTION_ENVELOPE

static final String DISTRIBUTION_ENVELOPE

Constant to indicate that a distribution envelope should wrap the business payload for the transport route.

Any additional wrappers such as <SOAP/> wrappers are implied and handled via the transport specific components

See Also:

Constant Field Values

Method Detail

getTransportType

String getTransportType()

Obtains the transport type for this ITKTransportRoute instance

Returns:

the transport type. Can be one of DTS; HTTP_WS; SPINE_TMS or UNKNOWN

getPhysicalAddress

String getPhysicalAddress()

Obtains the transport specific physical destination address

Returns:

A string representation of the transport specific destination address for this ITKTransportRoute

getReplyToAddress

String getReplyToAddress()

Obtains the address for any asynchronous replies

Returns:

the address for any asynchronous replies

getExceptionToAddress

String getExceptionToAddress()

Obtains the address for sending an exceptions that are reported asynchronously

Returns:

the address for asynchronous exceptions

getDestinationType

String getDestinationType()

Obtains the destination type

Returns:

the destination type - can be one of DIRECT or ROUTED

getWrapperType

String getWrapperType()

Obtains the details of any transport route wrappers that are required for the business payload

Returns:

The wrapper type - can be one of NO_WRAPPER or DISTRIBUTION_ENVELOPE

setWrapperType

void setWrapperType(String wrapperType)

Sets the details of any transport route wrappers that are required for the business payload

Parameters:

wrapperType - The wrapper type - can be one of NO_WRAPPER or DISTRIBUTION_ENVELOPE

getTimeToLive

int getTimeToLive()

Obtains the time to live for any messages being sent via this ITKTransportRoute

Returns:

The time to live (in Seconds)