uk.nhs.interoperability.infrastructure

Interface ITKAddress

All Known Implementing Classes:

ITKAddressImpl

public interface ITKAddress

Interface representing a logical address of a message originator or destination. The underlying ITK specification provides a structured address format of the form urn:nhs-uk:addressing:ods:RHM:department:workgroup where the first part (urn:nhs-uk:addressing:ods) is fixed the next part (RHM in this example) is the ODS code for the NHS organisation and the latter structures of the address (department:workgroup) can be locally defined.

From a messaging standpoint the exact structures on the right hand side are not important, however enough information must be provided to unambiguously resolve the ITKTransportRoute of the recipient system (or potentially the next hop in the case of a routed message) via the DirectoryOfServices

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ADDRESS_TYPE The OID representing the default (ITK) address type.

Method Summary

Methods

Modifier and Type	Method and Description
String	getType() Obtains the address type
String	getURI() Obtain the URI associated with this address - e.g.
void	setType(String type) Allows the address type to be specified if it is not the DEFAULT_ADDRESS_TYPE
void	setURI(String uRI) Set the URI for this address

Field Detail

DEFAULT_ADDRESS_TYPE

static final String DEFAULT_ADDRESS_TYPE

The OID representing the default (ITK) address type.

See Also:

Constant Field Values

Method Detail

setType

void setType(String type)

Allows the address type to be specified if it is not the DEFAULT_ADDRESS_TYPE

Parameters:

type - The OID representing the address type

getType

String getType()

Obtains the address type

Returns:

the OID representing the type of address

setURI

void setURI(String uRI)

Set the URI for this address

Parameters:

uRI - the URI to set

getURI

String getURI()

Obtain the URI associated with this address - e.g. urn:nhs-uk:addressing:ods:RHM:department:workgroup