uk.nhs.interoperability.capabilities

Interface DirectoryOfServices

All Known Implementing Classes:

ITKSimpleDOS

public interface DirectoryOfServices

An abstraction for an endpoint resolution directory. Concrete implementations of this interface can be simple (for instance configuration file based) or be dependent on external services such as a national endpoint directory - for instance Spine Directory Services (SDS)

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

Method Summary

Methods

Modifier and Type	Method and Description
ITKService	getService(String serviceId) Get the ITKService for the supplied serviceId
ITKTransportRoute	resolveDestination(String serviceId, ITKAddress address) Resolve the ITKTransportRoute for the supplied service and logical destination address.

Method Detail

resolveDestination

ITKTransportRoute resolveDestination(String serviceId,
                                   ITKAddress address)

Resolve the ITKTransportRoute for the supplied service and logical destination address. For non-routed messages the returned transport route will provide the physical destination address of the addressee. For routed messages the return ITKTransportRoute may represent the physical route to the actual destination service or it may resolve to an intermediary ITK-router - from the message originators perspective it is agnostic.

Parameters:

serviceId - The serviceId representing the ITK service that is being requested e.g. urn:nhs-itk:services:201005:transferPatient-v1-0

address - The logical address of the destination e.g. urn:nhs-uk:addressing:ods:TESTORGS:ORGB

getService

ITKService getService(String serviceId)

Get the ITKService for the supplied serviceId

Parameters:

serviceId - The ITK Service Id representing the ITK service that is being requested e.g. urn:nhs-itk:services:201005:transferPatient-v1-0