A B C D E F G H I L M N O P Q R S T U V W X 

A

AbstractCallbackListenerServlet - Class in uk.nhs.interoperability.consumer
 
AbstractCallbackListenerServlet() - Constructor for class uk.nhs.interoperability.consumer.AbstractCallbackListenerServlet
 
AbstractRoutedMessageServlet - Class in uk.nhs.interoperability.consumer
The Class AbstractRoutedMessageServlet.
AbstractRoutedMessageServlet() - Constructor for class uk.nhs.interoperability.consumer.AbstractRoutedMessageServlet
 
AbstractSimpleMessageServlet - Class in uk.nhs.interoperability.consumer
The Class AbstractSimpleMessageServlet.
AbstractSimpleMessageServlet() - Constructor for class uk.nhs.interoperability.consumer.AbstractSimpleMessageServlet
 
ACCEPTED - Static variable in interface uk.nhs.interoperability.capabilities.ITKProfileManager
The profileId is recognised and can be processed by the recipient
ACCESS_DENIED_CODE - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Access Denied
ACCESS_DENIED_TEXT - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Standard text associated with the ITKMessagingException.ACCESS_DENIED_CODE
ACK_PROFILE_ID - Static variable in class uk.nhs.interoperability.transport.ITKInfrastructureAck
The Constant ACK_PROFILE_ID.
ACK_SERVICE_ID - Static variable in class uk.nhs.interoperability.transport.ITKInfrastructureAck
The Constant ACK_SERVICE_ID.
addHandlingSpecification(String, String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Allows the message originator to add a handling specification to the associated ITKMessage.

Handling specifications provide an extensible mechanism for the message originator to attach special processing instructions with the message.
addHandlingSpecification(String, String) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
addITKWrappers(ITKMessage) - Method in class uk.nhs.interoperability.consumer.ITKServlet
Adds the itk wrappers.
ADTAsyncSender - Class in uk.nhs.interoperability.client.samples.adt
The Class ADTAsyncSender.
ADTAsyncSender() - Constructor for class uk.nhs.interoperability.client.samples.adt.ADTAsyncSender
 
ADTConsumerServlet - Class in uk.nhs.interoperability.consumer.adt
The Class ADTConsumerServlet.
ADTConsumerServlet() - Constructor for class uk.nhs.interoperability.consumer.adt.ADTConsumerServlet
Instantiates a new aDT consumer servlet.
ADTServlet - Class in uk.nhs.interoperability.client.samples.adt
The Class ADTServlet.
ADTServlet() - Constructor for class uk.nhs.interoperability.client.samples.adt.ADTServlet
Instantiates a new aDT servlet.
ADTSyncSender - Class in uk.nhs.interoperability.client.samples.adt
The Class ADTSyncSender.
ADTSyncSender() - Constructor for class uk.nhs.interoperability.client.samples.adt.ADTSyncSender
 
ASYNCREQ - Static variable in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
The Constant ASYNCREQ.
ASYNCRESP - Static variable in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
The Constant ASYNCRESP.
auditEvent(String, long, ITKMessageProperties) - Method in interface uk.nhs.interoperability.capabilities.AuditService
Writes an audit event to the audit service using the supplied information.
auditEvent(String, long, ITKMessageProperties) - Method in class uk.nhs.interoperability.service.ITKSimpleAudit
 
AuditException - Exception in uk.nhs.interoperability.capabilities
An exception to report any errors writing audit entries for instance insufficient information to create the audit entry, DB connectivity or file I/O issues.
AuditException(String) - Constructor for exception uk.nhs.interoperability.capabilities.AuditException
Creates an AuditException with any relevant diagnostic information about the error - such as the likely cause - for instance insufficient information to write an audit record
AuditException(Throwable) - Constructor for exception uk.nhs.interoperability.capabilities.AuditException
Creates an AuditException that wraps an underlying Throwable which has been encountered when try to write the audit record
AuditException(String, Throwable) - Constructor for exception uk.nhs.interoperability.capabilities.AuditException
Creates an AuditException that wraps an underlying Throwable which has been encountered when try to write the audit record as well as any additional diagnostic information about the error
AuditService - Interface in uk.nhs.interoperability.capabilities
An representation of an ITK compliant* audit service that has the capability to audit ITK messaging related events In general the expected usage pattern is to audit on both the client and service provider sides of any ITK operation.

B

build(Document) - Static method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
Builds the.
buildFromSoap(Document) - Static method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
Builds the from soap.
BusAckSender - Class in uk.nhs.interoperability.client.samples
The Class BusAckSender.
BusAckSender() - Constructor for class uk.nhs.interoperability.client.samples.BusAckSender
 
BUSINESS_ACK_HANDLING_SPECIFICATION_KEY - Static variable in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
The handling specification key for the property that allows the message originator to specify whether or not they would like a business Acknowledgement.

Permissible values for this handling specification are the Strings true or false
businessPayload - Variable in class uk.nhs.interoperability.payload.ITKMessageImpl
The business payload.

C

CDARepository - Class in uk.nhs.interoperability.client.samples.cda
The Class CDARepository.
CDARepository() - Constructor for class uk.nhs.interoperability.client.samples.cda.CDARepository
 
CDASender - Class in uk.nhs.interoperability.client.samples.cda
The Class CDASender.
CDASender() - Constructor for class uk.nhs.interoperability.client.samples.cda.CDASender
 
CDASenderWithAck - Class in uk.nhs.interoperability.client.samples.cda
The Class CDASenderWithAck.
CDASenderWithAck() - Constructor for class uk.nhs.interoperability.client.samples.cda.CDASenderWithAck
 
CDAView - Class in uk.nhs.interoperability.client.samples.cda
The Class CDAView.
CDAView() - Constructor for class uk.nhs.interoperability.client.samples.cda.CDAView
Instantiates a new cDA view.
checkProfileId(ITKMessageProperties) - Method in class uk.nhs.interoperability.consumer.ITKServlet
Checks whether the profileId in as identified in the ITKMessagingProperties is supported by the recipient.
checkServiceId(ITKMessageProperties) - Method in class uk.nhs.interoperability.consumer.ITKServlet
Check service id.
ConsumerApplicationEmulator - Class in uk.nhs.interoperability.consumer.appemulator
The Class ConsumerApplicationEmulator.
ConsumerApplicationEmulator() - Constructor for class uk.nhs.interoperability.consumer.appemulator.ConsumerApplicationEmulator
Instantiates a new consumer application emulator.
createDocumentFromNode(Node) - Static method in class uk.nhs.interoperability.util.xml.DomUtils
Creates the document from node.
createList() - Method in class uk.nhs.interoperability.client.samples.notification.NotificationView
Creates the list.

D

DE_ADDRESSED - Static variable in class uk.nhs.interoperability.payload.DEWrappedMessage
Constant to indicate that the on the wire Distribution envelope XML contains logical originating and destination addresses
DE_UNADDRESSED - Static variable in class uk.nhs.interoperability.payload.DEWrappedMessage
Constant to indicate that the on-the-wire Distribution envelope XML omits logical addressing (for instance this is not required in the case of synchronous calls)
DEBUG - Static variable in class uk.nhs.interoperability.util.Logger
The Constant DEBUG.
debug(String) - Static method in class uk.nhs.interoperability.util.Logger
Debug.
decodeErrorCode() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Convenience method to decode any errorCode from the ITKMessagingException.DEFAULT_ERROR_CODESYSTEM_OID.
DEFAULT_ADDRESS_TYPE - Static variable in interface uk.nhs.interoperability.infrastructure.ITKAddress
The OID representing the default (ITK) address type.
DEFAULT_ERROR_CODESYSTEM_OID - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
This is the OID to represent the default code system when raising SOAP faults etc.
DEFAULT_IDENTITY_TYPE - Static variable in interface uk.nhs.interoperability.infrastructure.ITKIdentity
The OID representing the default (ITK) address type.
DEPRECATED - Static variable in interface uk.nhs.interoperability.capabilities.ITKProfileManager
The profileId is recognised and can be processed by the recipient - however support for this profile is deprecated and is likely to be removed in the future
DEWrappedMessage - Class in uk.nhs.interoperability.payload
The Class DEWrappedMessage.
DEWrappedMessage() - Constructor for class uk.nhs.interoperability.payload.DEWrappedMessage
Instantiates a new dE wrapped message.
DEWrappedMessage(ITKMessage) - Constructor for class uk.nhs.interoperability.payload.DEWrappedMessage
Instantiates a new dE wrapped message.
DEWrappedMessage(ITKService, ITKMessage, boolean) - Constructor for class uk.nhs.interoperability.payload.DEWrappedMessage
Instantiates a new dE wrapped message.
DIRECT - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
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.
DirectoryOfServices - Interface in uk.nhs.interoperability.capabilities
An abstraction for an endpoint resolution directory.
DISTRIBUTION_ENVELOPE - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
Constant to indicate that a distribution envelope should wrap the business payload for the transport route.
DocStore - Class in uk.nhs.interoperability.client.samples.cda
The Class DocStore.
DocStore() - Constructor for class uk.nhs.interoperability.client.samples.cda.DocStore
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.adt.ADTServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.cda.CDAView
Do get.
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.cda.HelloWorldCDASourceServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationSenderServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationView
Do get.
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberServlet
 
DomUtils - Class in uk.nhs.interoperability.util.xml
The Class DomUtils.
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.adt.ADTServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.cda.CDAView
Do post.
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.cda.HelloWorldCDASourceServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationSenderServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationView
Do post.
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.consumer.AbstractCallbackListenerServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.consumer.AbstractRoutedMessageServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class uk.nhs.interoperability.consumer.AbstractSimpleMessageServlet
 
dos - Variable in class uk.nhs.interoperability.consumer.ITKServlet
The dos.
doTransform(String, String) - Static method in class uk.nhs.interoperability.transform.TransformManager
Do transform.
doTransform(String, String, Map<String, String>) - Static method in class uk.nhs.interoperability.transform.TransformManager
Do transform.
DTS - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
Constant to indicate a DTS (Data Transfer Service) ITKTransportRoute

E

ERROR - Static variable in class uk.nhs.interoperability.util.Logger
The Constant ERROR.
error(String, Throwable) - Static method in class uk.nhs.interoperability.util.Logger
Error.
extractDistributionEnvelopeFromSoap(Document) - Static method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
Extract distribution envelope from soap.

F

FATAL - Static variable in class uk.nhs.interoperability.util.Logger
The Constant FATAL.
fatal(String, Throwable) - Static method in class uk.nhs.interoperability.util.Logger
Fatal.

G

getAction() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the action.
getAuditIdentity() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Returns the audit identity of the ITK message originator
getAuditIdentity() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getBusinessPayload() - Method in interface uk.nhs.interoperability.payload.ITKMessage
Obtains the business payload portion of the message to be transmitted via the ITK transport and distribution infrastructure.

Note: those (ADT v2 pipe and hat) messages that ITK requires to be base64 encoded when being transmitted will not be encoded - i.e.
getBusinessPayload() - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
 
getBusinessPayload() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getBusinessPayloadId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the business payloadId associated with this message.
getBusinessPayloadId() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getCallbackHandler() - Method in class uk.nhs.interoperability.client.samples.RoutedMessageCallbackHandler
 
getCallbackHandler() - Method in class uk.nhs.interoperability.client.samples.SimpleMessageCallbackHandler
 
getCallbackHandler() - Method in class uk.nhs.interoperability.consumer.AbstractCallbackListenerServlet
Gets the callback handler.
getContactAddress() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the contact address.
getContactName() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the contact name.
getContactOrg() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the contact org.
getCreated() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the created.
getCreatedDateString() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the created date string.
getDateOfBirth() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Gets the date of birth.
getDateOfBirth() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the date of birth.
getDateOfBirth() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Gets the date of birth.
getDateOfBirth() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Gets the date of birth.
getDateOfBirth() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Gets the date of birth.
getDestinationType() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the destination type
getDestinationType() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getDocument(String) - Static method in class uk.nhs.interoperability.client.samples.cda.DocStore
Gets the document.
getEffectiveTime() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the effective time.
getErrorCode() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Obtains the errorCode associated with the ITKMessagingException.
getErrorCodeSystem() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Obtains the errorCodeSystem for any errorCode associated with the ITKMessagingException.
getErrorId() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Obtains the unique errorId for the ITKMessagingException The errorId is typically expected to be used in applications logs to uniquely tie log messages / exception traces together to aid in diagnostics
getEventTypeCode() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the event type code.
getEventTypeDesc() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the event type desc.
getExceptionToAddress() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the address for sending an exceptions that are reported asynchronously
getExceptionToAddress() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getExpires() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the expires.
getExpiryDateString() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the expiry date string.
getFaultTo() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the fault to.
getFrom() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the from.
getFromAddress() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the originators ITK address
getFromAddress() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getFullPayload() - Method in class uk.nhs.interoperability.payload.DEWrappedMessage
 
getFullPayload() - Method in interface uk.nhs.interoperability.payload.ITKMessage
Obtains the full ITKMessage including any wrappers
getFullPayload() - Method in class uk.nhs.interoperability.payload.ITKSimpleMessageResponse
 
getFullPayload() - Method in class uk.nhs.interoperability.payload.SimpleMessage
 
getFullPayload() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getFullPayload() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
 
getGender() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
 
getGivenName() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Gets the given name.
getGivenName() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Gets the given name.
getGivenName() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Gets the given name.
getGivenName() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Gets the given name.
getHandlingSpecification(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Convenience method that allows the value of the handling specification to be obtained directly.
getHandlingSpecification(String) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getHandlingSpecifications() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the Map of the handling specifications associated with the ITKMessage.

Handling specifications provide an extensible mechanism for the message originator to attach special processing instructions with the message.
getHandlingSpecifications() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getHL7DateTime() - Static method in class uk.nhs.interoperability.util.HL7Utils
Create a new HL7DateTime string of the form 201107121534 e.g.
getInboundTransportProperties() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the ITKTransportProperties that are associated with the ITKMessage that was received by the service provider on the inbound leg in an asynchronous request/response invocation.

The inboundITKTransportProperties are not expected to be processed by the application layer, however where present the application layer is responsible for attaching the inboundITKTransportProperties to any responses generated such that these transport properties are available to the transport layers transmitting the response.

A typical use of this mechanism is for the propagation of the <wsa:replyTo/> address such that it is available to the to the transport layers managing the "reply".

Note although this pattern adds some additional burden on the application layer it offers significant advantages over the alternative where the transport layer has to maintain state and correlate messages - potentially over several distributed nodes
getInboundTransportProperties() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getInstance() - Static method in class uk.nhs.interoperability.service.ITKSimpleAudit
Gets the single instance of ITKSimpleAudit.
getIntendedRecipient() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails
Provides the ITKAddress for the intended recipient of the message being acknowledged
getIntendedRecipient() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getInvokedUrl() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getInvokedUrl() - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Gets the URL of the invoked service or transport hop.

For SOAP this is mapped to/from <wsa:To/>
getLocalIdentifier() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
 
getLocalIdentifier() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
 
getLocalizedMessage() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Obtains the standard (human readable message) associated with the ITKMessagingException in the language for the Locale where it localised messages are available.
getMessage(String) - Static method in class uk.nhs.interoperability.client.samples.MessageStore
 
getMessage() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Obtains the standard (human readable message) associated with the ITKMessagingException.
getMessageConsumer() - Method in class uk.nhs.interoperability.client.samples.cda.CDARepository
 
getMessageConsumer() - Method in class uk.nhs.interoperability.client.samples.notification.NotificationRepository
 
getMessageConsumer() - Method in class uk.nhs.interoperability.consumer.AbstractRoutedMessageServlet
Gets the message consumer.
getMessageConsumer() - Method in class uk.nhs.interoperability.consumer.AbstractSimpleMessageServlet
Gets the message consumer.
getMessageConsumer() - Method in class uk.nhs.interoperability.consumer.adt.ADTConsumerServlet
 
getMessageConsumer() - Method in class uk.nhs.interoperability.consumer.appemulator.ConsumerApplicationEmulator
 
getMessageConsumer() - Method in class uk.nhs.interoperability.consumer.appemulator.RoutedApplicationEmulator
 
getMessageConsumer() - Method in class uk.nhs.interoperability.consumer.smsp.SMSProviderServlet
 
getMessageId() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Gets the message id.
getMessageId() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the message id.
getMessageId() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Gets the message id.
getMessageId() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Gets the message id.
getMessageId() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Gets the message id.
getMessageId() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the message id.
getMessageList() - Static method in class uk.nhs.interoperability.client.samples.notification.NotificationStore
Gets the message list.
getMessageProperties() - Method in interface uk.nhs.interoperability.payload.ITKMessage
Obtains the ITKMessageProperties associated with this message.
getMessageProperties() - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
 
getMimeType() - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
 
getMimeType() - Method in interface uk.nhs.interoperability.service.ITKService
Specifies the appropriate mime type for this service
getMsgType() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the msg type.
getNackError() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails
Obtains details about the error for which the Nack is being generated.
getNackError() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getNamespaceURI(String) - Method in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
 
getNHSNumber() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Gets the nHS number.
getNHSNumber() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the nHS number.
getNHSNumber() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Gets the nHS number.
getNhsNumber() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Gets the nhs number.
getNHSNumber() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Gets the nHS number.
getNhsNumber() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Gets the nhs number.
getNHSNumber(GetNHSNumberRequest, ITKAddress) - Method in class uk.nhs.interoperability.client.samples.smsp.SpineMiniServicesClient
Get NHS number.
getNHSNumber() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Gets the nHS number.
getNhsNumber() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Gets the nhs number.
GetNHSNumberRequest - Class in uk.nhs.interoperability.client.samples.smsp
The Class GetNHSNumberRequest.
GetNHSNumberRequest() - Constructor for class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Instantiates a new verify nhs number request.
GetNHSNumberResponse - Class in uk.nhs.interoperability.client.samples.smsp
The Class GetNHSNumberResponse.
GetNHSNumberResponse(ITKMessage) - Constructor for class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Instantiates a new verify nhs number response.
GetNHSNumberServlet - Class in uk.nhs.interoperability.client.samples.smsp
The Class GetNHSNumberServlet.
GetNHSNumberServlet() - Constructor for class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberServlet
Instantiates a new verify nhs number servlet.
getNotification(String) - Static method in class uk.nhs.interoperability.client.samples.notification.NotificationStore
Gets the notification.
getPatientAddress() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the patient address.
getPatientDetailsByNHSNumber(GetPatientDetailsByNHSNumberRequest, ITKAddress) - Method in class uk.nhs.interoperability.client.samples.smsp.SpineMiniServicesClient
Gets the patient details by nhs number.
GetPatientDetailsByNHSNumberRequest - Class in uk.nhs.interoperability.client.samples.smsp
The Class GetPatientDetailsByNHSNumberRequest.
GetPatientDetailsByNHSNumberRequest() - Constructor for class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Instantiates a new gets the patient details by nhs number request.
GetPatientDetailsByNHSNumberResponse - Class in uk.nhs.interoperability.client.samples.smsp
The Class GetPatientDetailsByNHSNumberResponse.
GetPatientDetailsByNHSNumberResponse(ITKMessage) - Constructor for class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Instantiates a new gets the patient details by nhs number response.
GetPatientDetailsByNHSNumberServlet - Class in uk.nhs.interoperability.client.samples.smsp
The Class GetPatientDetailsByNHSNumberServlet.
GetPatientDetailsByNHSNumberServlet() - Constructor for class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberServlet
Instantiates a new gets the patient details by nhs number servlet.
getPatientName() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the patient name.
getPayload() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
 
getPayload() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Gets the response message.
getPayload() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
 
getPayload() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the payload.
getPhysicalAddress() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the transport specific physical destination address
getPhysicalAddress() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getPostcode() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Gets the postcode.
getPostcode() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Gets the postcode.
getPrefix(String) - Method in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
 
getPrefixes(String) - Method in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
 
getPreresolvedRoute() - Method in interface uk.nhs.interoperability.payload.ITKMessage
Obtains any pre-resolved ITKTransportRoute associated with this ITKMessage.

A pre-resolved transport route might be present if this ITKMessage instance is a response where the return address is already known (e.g.
getPreresolvedRoute() - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
 
getPreresolvedRoute() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
 
getPresentationText() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Gets the presentation text.
getProfileId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the profileId associated with the ITKMessage.
getProfileId() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getProfileSupportLevel(String) - Method in interface uk.nhs.interoperability.capabilities.ITKProfileManager
Determines whether the provided profileId is supported.
getProfileSupportLevel(String) - Method in class uk.nhs.interoperability.consumer.ITKProfileManagerImpl
 
getPropertiesMatching(String) - Static method in class uk.nhs.interoperability.util.ITKApplicationProperties
Gets the properties matching.
getPropertiesMatching(Properties, String) - Static method in class uk.nhs.interoperability.util.ITKApplicationProperties
Gets the properties matching.
getPropertiesMatching(String) - Static method in class uk.nhs.interoperability.util.ITKDirectoryProperties
Gets the properties matching.
getPropertiesMatching(Properties, String) - Static method in class uk.nhs.interoperability.util.ITKDirectoryProperties
Gets the properties matching.
getProperty(String) - Static method in class uk.nhs.interoperability.util.ITKApplicationProperties
Gets the property.
getProperty(String) - Static method in class uk.nhs.interoperability.util.ITKDirectoryProperties
Gets the property.
getProperty(String) - Static method in class uk.nhs.interoperability.util.ITKServiceProperties
Gets the property.
getRecipientAddress() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the recipient address.
getRecipientOrg() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the recipient org.
getRelatedItkTransportProperties() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
getRelatedMessageProperties() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
getReplyTo() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the reply to.
getReplyToAddress() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the address for any asynchronous replies
getReplyToAddress() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getReportingIdentity() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails
Get the identity of the node that originated the InfrastructureAck This may be different to the ITKAckDetails.getIntendedRecipient() if a nack was generated by an intermediary node
getReportingIdentity() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getResponseCode() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Gets the response code.
getResponseCode() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Gets the response code.
getResponseCode() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Gets the response code.
getResponseMessage() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Gets the response message.
getResponseMessage() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Gets the response message.
getSenderOrg() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Gets the sender org.
getService(String) - Method in interface uk.nhs.interoperability.capabilities.DirectoryOfServices
Get the ITKService for the supplied serviceId
getService(String) - Method in class uk.nhs.interoperability.service.ITKSimpleDOS
 
getServiceId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
ITK message service associated with the message
getServiceId() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getServiceId() - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
 
getServiceId() - Method in interface uk.nhs.interoperability.service.ITKService
Obtains the service identifier associated with this ITKService object
getServiceRef() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails
The service identifier from the message being acknowledged
getServiceRef() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getSurname() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Gets the surname.
getSurname() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Gets the surname.
getSurname() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Gets the surname.
getSurname() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Gets the surname.
getTimeToLive() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the time to live for any messages being sent via this ITKTransportRoute
getTimeToLive() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getTimeToLive() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the time to live.
getTo() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the to.
getToAddress() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the destination address for the associated ITK Message.

Note Whilst the ITK Specifications allow for multiple recipients to be specified this version of the ITK API only supports a single recipient to be defined as this satisfies the majority of anticipated use-cases.
getToAddress() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getTrackingId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Obtains the tracking id associated with the ITKMessage when sending the message between two or more endpoints.
getTrackingId() - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
getTrackingRef() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails
The tracking id reference from the message being acknowledged
getTrackingRef() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
getTransportAction() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportAction() - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Gets the transportAction for the associated ITKMessage.

For SOAP this is mapped to/from <wsa:Action/>
getTransportFaultTo() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportFaultTo() - Method in interface uk.nhs.interoperability.transport.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()
getTransportFaultToRoute() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportFaultToRoute() - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous faults to.
getTransportFrom() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportFrom() - Method in interface uk.nhs.interoperability.transport.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/>.

getTransportMessageId() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportMessageId() - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Gets the unique transport level identifier for the associated message.
getTransportRelatesTo() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportRelatesTo() - Method in interface uk.nhs.interoperability.transport.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/>.

getTransportReplyTo() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportReplyTo() - Method in interface uk.nhs.interoperability.transport.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()
getTransportReplyToRoute() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportReplyToRoute() - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous response messages to.
getTransportTo() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
getTransportTo() - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Gets the transport hop destination.
getTransportType() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the transport type for this ITKTransportRoute instance
getTransportType() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getType() - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress
Obtains the address type
getType() - Method in class uk.nhs.interoperability.infrastructure.ITKAddressImpl
 
getType() - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity
Obtains the identity type
getType() - Method in class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
 
getURI() - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress
Obtain the URI associated with this address - e.g.
getURI() - Method in class uk.nhs.interoperability.infrastructure.ITKAddressImpl
 
getURI() - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity
Obtain the URI associated with this identity
getURI() - Method in class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
 
getUsername() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Gets the username.
getVerifiedIndicator() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Gets the verified indicator.
getVerifiedIndicator() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Gets the verified indicator.
getWrapperType() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Obtains the details of any transport route wrappers that are required for the business payload
getWrapperType() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
getXPathExpression(String) - Static method in class uk.nhs.interoperability.util.xml.XPaths
 

H

hasValue(String) - Static method in class uk.nhs.interoperability.util.StringUtils
Checks for value.
HelloWorldCDASourceServlet - Class in uk.nhs.interoperability.client.samples.cda
The Class HelloWorldCDASourceServlet.
HelloWorldCDASourceServlet() - Constructor for class uk.nhs.interoperability.client.samples.cda.HelloWorldCDASourceServlet
Instantiates a new hello world cda source servlet.
HL7NAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant HL7NAMESPACE.
HL7NAMESPACE_DEFAULY_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant HL7NAMESPACE_DEFAULY_PREFIX.
HL7Utils - Class in uk.nhs.interoperability.util
The Class HL7Utils.
HL7V2NAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant HL7V2NAMESPACE.
HL7V2NAMESPACE_DEFAULT_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant HL7V2NAMESPACE_DEFAULT_PREFIX.
HTTP_WS - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
Constant to indicate an HTTP SOAP/Web Service ITKTransportRoute

I

InfAckSender - Class in uk.nhs.interoperability.client.samples
The Class InfAckSender.
InfAckSender() - Constructor for class uk.nhs.interoperability.client.samples.InfAckSender
 
INFO - Static variable in class uk.nhs.interoperability.util.Logger
The Constant INFO.
info(String) - Static method in class uk.nhs.interoperability.util.Logger
Info.
init() - Method in class uk.nhs.interoperability.consumer.AbstractCallbackListenerServlet
 
init() - Method in class uk.nhs.interoperability.consumer.AbstractRoutedMessageServlet
 
init() - Method in class uk.nhs.interoperability.consumer.AbstractSimpleMessageServlet
 
init() - Method in class uk.nhs.interoperability.consumer.ITKServlet
 
INTERACTION_HANDLING_SPECIFICATION_KEY - Static variable in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
The handling specification key for the property that allows the message originator to explicitly specify the interaction id of the message.

The value for this handling specification should be the interaction id of the message - e.g.
INVALID_MESSAGE_CODE - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Invalid Message - the message structure or content is unrecognised or incorrect
INVALID_MESSAGE_TEXT - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Standard text associated with the ITKMessagingException.INVALID_MESSAGE_CODE
isBase64() - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
 
isBase64() - Method in interface uk.nhs.interoperability.service.ITKService
Determines whether this service expects the business payload data to be base64 encoded.

Note: In ITK all ADT v2 pipe and hat messages are required to base64 encoded during transmission
isNack() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails
Convenient method to simply establish whether the ITKAckDetails represents an Ack or Nack
isNack() - Method in class uk.nhs.interoperability.transport.ITKInfrastructureAck
 
isResponse() - Method in interface uk.nhs.interoperability.payload.ITKMessage
Indicates whether this ITKMessage instance is in response to a request message such as a query
isResponse - Variable in class uk.nhs.interoperability.payload.ITKMessageImpl
The is response.
isResponse() - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
 
ITK_AUDIT_IDENTITY_TYPE - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_AUDIT_IDENTITY_URI.
ITK_AUDIT_IDENTITY_TYPE_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_AUDIT_IDENTITY_TYPE_XPATH.
ITK_AUDIT_IDENTITY_URI - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_AUDIT_IDENTITY_URI.
ITK_AUDIT_IDENTITY_URI_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_AUDIT_IDENTITY_URI_XPATH.
ITK_BUSINESS_ACK_HANDLING_SPECIFICATIONS - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_BUSINESS_ACK_HANDLING_SPECIFICATIONS.
ITK_BUSINESS_ACK_HANDLING_SPECIFICATIONS_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_BUSINESS_ACK_HANDLING_SPECIFICATIONS_XPATH.
ITK_FIRST_BASE64 - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_BASE64.
ITK_FIRST_BASE64_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_BASE64_XPATH.
ITK_FIRST_MIMETYPE - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_MIMETYPE.
ITK_FIRST_MIMETYPE_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_MIMETYPE_XPATH.
ITK_FIRST_PAYLOAD - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_PAYLOAD.
ITK_FIRST_PAYLOAD_ID - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_PAYLOAD_ID.
ITK_FIRST_PAYLOAD_ID_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_PAYLOAD_ID_XPATH.
ITK_FIRST_PAYLOAD_TEXT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_PAYLOAD_TEXT.
ITK_FIRST_PAYLOAD_TEXT_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_PAYLOAD_TEXT_XPATH.
ITK_FIRST_PAYLOAD_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_PAYLOAD_XPATH.
ITK_FIRST_TO_ADDRESS - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_TO_ADDRESS.
ITK_FIRST_TO_ADDRESS_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FIRST_TO_ADDRESS_XPATH.
ITK_FROM_ADDRESS - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FROM_ADDRESS.
ITK_FROM_ADDRESS_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_FROM_ADDRESS_XPATH.
ITK_PAYLOAD_COUNT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
Counts the number of payloads present in the message (does not rely on the count provided in the message itself).
ITK_PAYLOAD_COUNT_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_PAYLOAD_COUNT_XPATH.
ITK_PROFILE_ID - Static variable in class uk.nhs.interoperability.util.xml.XPaths
Obtains the profile id.
ITK_PROFILE_ID_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_PROFILE_ID_XPATH.
ITK_SERVICE - Static variable in class uk.nhs.interoperability.util.xml.XPaths
XPath to extract the technical service from the message e.g.
ITK_SERVICE_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_SERVICE_XPATH.
ITK_SIMPLE_MESSAGE_RESPONSE - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_SIMPLE_MESSAGE_RESPONSE.
ITK_SIMPLE_MESSAGE_RESPONSE_CONTENT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_SIMPLE_MESSAGE_RESPONSE_CONTENT.
ITK_SIMPLE_MESSAGE_RESPONSE_CONTENT_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_SIMPLE_MESSAGE_RESPONSE_CONTENT_XPATH.
ITK_TRACKING_ID - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The tracking id associated with the message.
ITK_TRACKING_ID_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ITK_TRACKING_ID_XPATH.
ITKAckDetails - Interface in uk.nhs.interoperability.infrastructure
Interface representing the pertinent information contained within an ITK Infrastructure Ack.
ITKAddress - Interface in uk.nhs.interoperability.infrastructure
Interface representing a logical address of a message originator or destination.
ITKAddressImpl - Class in uk.nhs.interoperability.infrastructure
The Class ITKAddressImpl.
ITKAddressImpl(String, String) - Constructor for class uk.nhs.interoperability.infrastructure.ITKAddressImpl
Instantiates a new iTK address impl.
ITKAddressImpl(String) - Constructor for class uk.nhs.interoperability.infrastructure.ITKAddressImpl
Instantiates a new iTK address impl.
ITKApplicationProperties - Class in uk.nhs.interoperability.util
The Class ITKApplicationProperties.
ITKApplicationProperties() - Constructor for class uk.nhs.interoperability.util.ITKApplicationProperties
 
ITKCallbackHandler - Interface in uk.nhs.interoperability.source
Interface defining the application responsibilities for managing asynchronous invocation responses - including standard business responses (e.g.
ITKCommsException - Exception in uk.nhs.interoperability.infrastructure
An exception to report any underlying transport / communication errors.
ITKCommsException(String) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKCommsException
Creates an ITKCommsException with any relevant diagnostic information about the error - such as the likely cause
ITKCommsException(Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKCommsException
Creates an ITKCommsException that wraps an underlying Throwable which has been encountered when sending/receiving a message
ITKCommsException(String, Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKCommsException
Creates an ITKCommsException that wraps an underlying Throwable which has been encountered when sending/receiving a message
ITKDirectoryProperties - Class in uk.nhs.interoperability.util
The Class ITKDirectoryProperties.
ITKDirectoryProperties() - Constructor for class uk.nhs.interoperability.util.ITKDirectoryProperties
 
ITKIdentity - Interface in uk.nhs.interoperability.infrastructure
Interface representing a logical identity of a person or system typically used for audit purposes.
ITKIdentityImpl - Class in uk.nhs.interoperability.infrastructure
The Class ITKIdentityImpl.
ITKIdentityImpl(String, String) - Constructor for class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
Instantiates a new iTK identity impl.
ITKIdentityImpl(String) - Constructor for class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
Instantiates a new iTK identity impl.
ITKInfrastructureAck - Class in uk.nhs.interoperability.transport
The Class ITKInfrastructureAck.
ITKInfrastructureAck(ITKMessageProperties, String) - Constructor for class uk.nhs.interoperability.transport.ITKInfrastructureAck
Instantiates a new iTK infrastructure ack.
ITKInfrastructureAck(ITKMessageProperties, String, ITKMessagingException) - Constructor for class uk.nhs.interoperability.transport.ITKInfrastructureAck
Instantiates a new iTK infrastructure ack.
ITKMessage - Interface in uk.nhs.interoperability.payload
Interface representing the characteristics of an ITK message being transmitted via the ITK message transport and distribution layers (i.e.
ITKMessageConsumer - Interface in uk.nhs.interoperability.consumer
API contract for between the transport and application layers for a message/document consumer application.
ITKMessageImpl - Class in uk.nhs.interoperability.payload
The Class ITKMessageImpl.
ITKMessageImpl() - Constructor for class uk.nhs.interoperability.payload.ITKMessageImpl
Instantiates a new iTK message impl.
ITKMessageImpl(ITKMessageProperties) - Constructor for class uk.nhs.interoperability.payload.ITKMessageImpl
Instantiates a new iTK message impl.
ITKMessageImpl(ITKMessageProperties, String, String, boolean) - Constructor for class uk.nhs.interoperability.payload.ITKMessageImpl
Instantiates a new iTK message impl.
ITKMessageProperties - Interface in uk.nhs.interoperability.infrastructure
Interface that represents the addressing, audit and other meta-data information associated with the ITK Message.
ITKMessagePropertiesImpl - Class in uk.nhs.interoperability.infrastructure
The Class ITKMessagePropertiesImpl.
ITKMessagePropertiesImpl() - Constructor for class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
ITKMessageSender - Interface in uk.nhs.interoperability.source
Interface that represents the application entry point for sending ITK messages to a remote Destination.
ITKMessageSenderImpl - Class in uk.nhs.interoperability.source
The Class ITKMessageSenderImpl.
ITKMessageSenderImpl() - Constructor for class uk.nhs.interoperability.source.ITKMessageSenderImpl
Instantiates a new iTK message sender impl.
ITKMessagingException - Exception in uk.nhs.interoperability.infrastructure
Base exception for the ITK Messaging api.
ITKMessagingException(String) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Creates an ITKMessagingException with any relevant diagnostic information about the error - such as the likely cause
ITKMessagingException(Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Creates an ITKMessagingException that wraps an underlying Throwable which has been encountered when sending/receiving a message
ITKMessagingException(int, String) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Creates an ITKMessagingException with any relevant diagnostic information about the error - such as the likely cause.
ITKMessagingException(String, Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Creates an ITKMessagingException that wraps an underlying Throwable which has been encountered when sending/receiving a message
ITKMessagingException(int, String, Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Creates an ITKMessagingException that wraps an underlying Throwable which has been encountered when sending/receiving a message

Note: by default the errorCode is assumed to be a code associated with the ITKMessagingException.DEFAULT_ERROR_CODESYSTEM_OID codeSystem
ITKMessagingException(ITKTransportProperties, ITKMessageProperties, int, String) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
ITKMessagingException(ITKTransportProperties, ITKMessageProperties, int, String, Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
ITKMessagingException(ITKMessageProperties, int, String) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
ITKMessagingException(ITKMessageProperties, int, String, Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
ITKNAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant ITKNAMESPACE.
ITKNAMESPACE_DEFAULT_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant ITKNAMESPACE_DEFAULT_PREFIX.
ITKProfileManager - Interface in uk.nhs.interoperability.capabilities
Interface used by ITK message recipients to determine whether or not the received message is a supported profile, is deprecated or is not supported.

Note: This interface is a candidate for migration to the itk-api project in due course
ITKProfileManagerImpl - Class in uk.nhs.interoperability.consumer
The Class ITKProfileManagerImpl.
ITKProfileManagerImpl() - Constructor for class uk.nhs.interoperability.consumer.ITKProfileManagerImpl
Instantiates a new iTK profile manager impl.
ITKProfileManagerImpl(Properties) - Constructor for class uk.nhs.interoperability.consumer.ITKProfileManagerImpl
Instantiates a new iTK profile manager impl.
ITKSender - Interface in uk.nhs.interoperability.transport
Interface that represents the transport neutral interface for sending ITK messages to a remote destination.
ITKSenderWSImpl - Class in uk.nhs.interoperability.transport.WS
The Class ITKSenderWSImpl.
ITKSenderWSImpl() - Constructor for class uk.nhs.interoperability.transport.WS.ITKSenderWSImpl
 
ITKService - Interface in uk.nhs.interoperability.service
Definition of a fully resolved ITKService including the supported pattern, mime type and whether or not the payload should be base64 encoded.
ITKServiceImpl - Class in uk.nhs.interoperability.infrastructure
The Class ITKServiceImpl.
ITKServiceImpl(String) - Constructor for class uk.nhs.interoperability.infrastructure.ITKServiceImpl
Instantiates a new iTK service impl.
ITKServiceProperties - Class in uk.nhs.interoperability.util
The Class ITKServiceProperties.
ITKServiceProperties() - Constructor for class uk.nhs.interoperability.util.ITKServiceProperties
 
ITKServlet - Class in uk.nhs.interoperability.consumer
The Class ITKServlet.
ITKServlet() - Constructor for class uk.nhs.interoperability.consumer.ITKServlet
 
ITKSimpleAudit - Class in uk.nhs.interoperability.service
The Class ITKSimpleAudit.
ITKSimpleAudit() - Constructor for class uk.nhs.interoperability.service.ITKSimpleAudit
 
ITKSimpleDOS - Class in uk.nhs.interoperability.service
The Class ITKSimpleDOS.
ITKSimpleDOS() - Constructor for class uk.nhs.interoperability.service.ITKSimpleDOS
 
ITKSimpleMessageResponse - Class in uk.nhs.interoperability.payload
The Class ITKSimpleMessageResponse.
ITKSimpleMessageResponse(ITKMessageProperties, boolean) - Constructor for class uk.nhs.interoperability.payload.ITKSimpleMessageResponse
Instantiates a new iTK simple message response.
ITKSimpleMessageResponse() - Constructor for class uk.nhs.interoperability.payload.ITKSimpleMessageResponse
Instantiates a new iTK simple message response.
ITKSOAPException - Exception in uk.nhs.interoperability.transport.WS
The Class ITKSOAPException.
ITKSOAPException(ITKMessagingException) - Constructor for exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Instantiates a new iTKSOAP exception.
ITKSOAPException(ITKMessageProperties, int, String, Throwable) - Constructor for exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Instantiates a new iTKSOAP exception.
ITKSOAPException(ITKMessageProperties, int, String) - Constructor for exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Instantiates a new iTKSOAP exception.
ITKSOAPException(String, Throwable) - Constructor for exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Instantiates a new iTKSOAP exception.
ITKSOAPException(String) - Constructor for exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Instantiates a new iTKSOAP exception.
ITKSOAPException(Throwable) - Constructor for exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Instantiates a new iTKSOAP exception.
ITKTransportProperties - Interface in uk.nhs.interoperability.transport
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
ITKTransportPropertiesImpl - Class in uk.nhs.interoperability.infrastructure
The Class ITKTransportPropertiesImpl.
ITKTransportPropertiesImpl(String) - Constructor for class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
Instantiates a new iTK transport properties impl.
ITKTransportRoute - Interface in uk.nhs.interoperability.transport
Interface representing the properties of a physical (transport specific) destination.
ITKTransportRouteImpl - Class in uk.nhs.interoperability.transport
The Class ITKTransportRouteImpl.
ITKTransportRouteImpl(String, String) - Constructor for class uk.nhs.interoperability.transport.ITKTransportRouteImpl
Instantiates a new iTK transport route impl.
ITKTransportRouteImpl(String, String, String, String, String, String, int) - Constructor for class uk.nhs.interoperability.transport.ITKTransportRouteImpl
Instantiates a new iTK transport route impl.
ITKTransportTimeoutException - Exception in uk.nhs.interoperability.infrastructure
An exception to report any underlying transport / communication timeout errors.
ITKTransportTimeoutException(String) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKTransportTimeoutException
Creates an ITKTransportTimeoutException with any relevant diagnostic information about the error - such as the likely cause
ITKTransportTimeoutException(Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKTransportTimeoutException
Creates an ITKTransportTimeoutException that wraps an underlying Throwable which has been encountered when sending/responding to a message
ITKTransportTimeoutException(String, Throwable) - Constructor for exception uk.nhs.interoperability.infrastructure.ITKTransportTimeoutException
Creates an ITKTransportTimeoutException that wraps an underlying Throwable which has been encountered when sending/responding to a message

L

Logger - Class in uk.nhs.interoperability.util
Simple Logging class - created to avoid unnecessary dependencies on external libraries.
Logger() - Constructor for class uk.nhs.interoperability.util.Logger
 

M

main(String[]) - Static method in class uk.nhs.interoperability.client.samples.adt.ADTAsyncSender
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.adt.ADTSyncSender
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.BusAckSender
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.cda.CDASender
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.cda.CDASenderWithAck
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.InfAckSender
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.notification.NotificationSender
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.smsp.SpineMiniServicesClient
The main method.
main(String[]) - Static method in class uk.nhs.interoperability.client.samples.StandaloneServer
Entry point for starting the Standalone Server from the executable war.
MESSAGE_PROCESSING_FAILURE - Static variable in interface uk.nhs.interoperability.capabilities.AuditService
Constant representing the event of message processing failure
MESSAGE_RECEIPT_EVENT - Static variable in interface uk.nhs.interoperability.capabilities.AuditService
Constant representing the receipt of an ITK message
MESSAGE_SENT_EVENT - Static variable in interface uk.nhs.interoperability.capabilities.AuditService
Constant representing the sending of an ITK message
messageProperties - Variable in class uk.nhs.interoperability.payload.ITKMessageImpl
The message properties.
MessageQueue - Class in uk.nhs.interoperability.util
The Class MessageQueue.
MessageQueue() - Constructor for class uk.nhs.interoperability.util.MessageQueue
Instantiates a new message queue.
MessageStore - Class in uk.nhs.interoperability.client.samples
 
MessageStore() - Constructor for class uk.nhs.interoperability.client.samples.MessageStore
 

N

namespaces - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The namespaces.
NO_ERROR_CODE - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Default error "code" that indicates that no error code is associated with this ITKMessagingException
NO_WRAPPER - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
Constant to indicate that no wrappers are required for the transport route
NonCodedCDA - Class in uk.nhs.interoperability.client.samples.cda
The Class NonCodedCDA.
NonCodedCDA() - Constructor for class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Instantiates a new non coded cda.
NOT_SUPPORTED - Static variable in interface uk.nhs.interoperability.capabilities.ITKProfileManager
The profileId is either unknown or is not accepted by the recipient
Notification - Class in uk.nhs.interoperability.client.samples.notification
The Class Notification.
Notification() - Constructor for class uk.nhs.interoperability.client.samples.notification.Notification
Instantiates a new notification.
NotificationRepository - Class in uk.nhs.interoperability.client.samples.notification
The Class NotificationRepository.
NotificationRepository() - Constructor for class uk.nhs.interoperability.client.samples.notification.NotificationRepository
 
NotificationSender - Class in uk.nhs.interoperability.client.samples.notification
The Class NotificationSender.
NotificationSender() - Constructor for class uk.nhs.interoperability.client.samples.notification.NotificationSender
 
NotificationSenderServlet - Class in uk.nhs.interoperability.client.samples.notification
The Class NotificationSenderServlet.
NotificationSenderServlet() - Constructor for class uk.nhs.interoperability.client.samples.notification.NotificationSenderServlet
Instantiates a new notification sender servlet.
NotificationStore - Class in uk.nhs.interoperability.client.samples.notification
The Class NotificationStore.
NotificationStore() - Constructor for class uk.nhs.interoperability.client.samples.notification.NotificationStore
 
NotificationView - Class in uk.nhs.interoperability.client.samples.notification
The Class NotificationView.
NotificationView() - Constructor for class uk.nhs.interoperability.client.samples.notification.NotificationView
Instantiates a new notification view.
NS_CONTEXT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant NS_CONTEXT.

O

onAck(ITKAckDetails) - Method in class uk.nhs.interoperability.client.samples.RoutedMessageCallbackHandler
 
onAck(ITKAckDetails) - Method in class uk.nhs.interoperability.client.samples.SimpleMessageCallbackHandler
 
onAck(ITKAckDetails) - Method in interface uk.nhs.interoperability.source.ITKCallbackHandler
Method invoked by the transport and distribution layer upon receipt of a positive infrastructure acknowledgement (Ack).

Application components are not required to provide any functionality that is triggered by this acknowledgement however it is anticipated that this could be used to implement "delivery receipt" functionality.
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.client.samples.cda.CDARepository
 
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationRepository
 
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.client.samples.RoutedMessageCallbackHandler
 
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.client.samples.SimpleMessageCallbackHandler
 
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.consumer.appemulator.ConsumerApplicationEmulator
 
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.consumer.appemulator.RoutedApplicationEmulator
 
onMessage(ITKMessage) - Method in class uk.nhs.interoperability.consumer.appemulator.SimpleApplicationEmulator
 
onMessage(ITKMessage) - Method in interface uk.nhs.interoperability.consumer.ITKMessageConsumer
Call to process a request message where no application response is returned synchronously.
onMessage(ITKMessage) - Method in interface uk.nhs.interoperability.source.ITKCallbackHandler
Allows the transport and distribution infrastructure to pass back an asynchronous response received in response to an asynchronous request.

The response message may be a generic ITK Business Acknowledgement (for instance as a result of a sendCDA invocation) or a specific business response associated with the request message.

Note: It is the responsibility of the application to maintain state and do the necessary correlation of this message against the original request to complete the transaction.
onNack(ITKAckDetails) - Method in class uk.nhs.interoperability.client.samples.RoutedMessageCallbackHandler
 
onNack(ITKAckDetails) - Method in class uk.nhs.interoperability.client.samples.SimpleMessageCallbackHandler
 
onNack(ITKAckDetails) - Method in interface uk.nhs.interoperability.source.ITKCallbackHandler
Method invoked by the transport and distribution layer upon receipt of a negative infrastructure acknowledgement (Nack).

Application components are not required to provide any functionality that is triggered by this acknowledgement however it is anticipated that this could be used to implement "delivery failure" functionality.
onSyncMessage(ITKMessage) - Method in class uk.nhs.interoperability.client.samples.cda.CDARepository
 
onSyncMessage(ITKMessage) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationRepository
Routed messages do not support true synchronous responses.
onSyncMessage(ITKMessage) - Method in class uk.nhs.interoperability.consumer.appemulator.ConsumerApplicationEmulator
 
onSyncMessage(ITKMessage) - Method in class uk.nhs.interoperability.consumer.appemulator.RoutedApplicationEmulator
 
onSyncMessage(ITKMessage) - Method in class uk.nhs.interoperability.consumer.appemulator.SimpleApplicationEmulator
 
onSyncMessage(ITKMessage) - Method in interface uk.nhs.interoperability.consumer.ITKMessageConsumer
Call to process a request message where the application response is returned synchronously (in the same thread)

P

parse(String) - Static method in class uk.nhs.interoperability.util.xml.DomUtils
Parses the.
parseSOAPFault(String) - Static method in exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Parses the soap fault.
preResolvedTransportRoute - Variable in class uk.nhs.interoperability.payload.ITKMessageImpl
The pre resolved transport route.
PRETTY_PRINT - Static variable in class uk.nhs.interoperability.util.xml.DomUtils
The Constant PRETTY_PRINT.
process(String) - Method in class uk.nhs.interoperability.client.samples.notification.NotificationView
Process.
PROCESSING_ERROR_NOT_RETRYABLE_CODE - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Processing Error (not retryable) - a non-recoverable processing error has been encountered
PROCESSING_ERROR_NOT_RETRYABLE_TEXT - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
PROCESSING_ERROR_RETRYABLE_CODE - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Processing Error (retryable) - a recoverable processing error has been encountered
PROCESSING_ERROR_RETRYABLE_TEXT - Static variable in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
putDocument(String, String) - Static method in class uk.nhs.interoperability.client.samples.cda.DocStore
Put document.
putMessage(String, String) - Static method in class uk.nhs.interoperability.client.samples.MessageStore
 
putNotification(String, String) - Static method in class uk.nhs.interoperability.client.samples.notification.NotificationStore
Put notification.

Q

queue(ITKMessage) - Method in class uk.nhs.interoperability.util.MessageQueue
Queue.

R

readRequestContent(HttpServletRequest) - Static method in class uk.nhs.interoperability.util.ServletUtils
Read request content.
resolveDestination(String, ITKAddress) - Method in interface uk.nhs.interoperability.capabilities.DirectoryOfServices
Resolve the ITKTransportRoute for the supplied service and logical destination address.
resolveDestination(String, ITKAddress) - Method in class uk.nhs.interoperability.service.ITKSimpleDOS
 
resolveFaultToAddress(ITKTransportProperties) - Static method in class uk.nhs.interoperability.transport.WS.SOAPUtils
Resolve fault to address.
resolveReplyToAddress(ITKTransportProperties) - Static method in class uk.nhs.interoperability.transport.WS.SOAPUtils
Resolve reply to address.
ROOT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ROOT.
ROOT_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant ROOT_XPATH.
ROUTED - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
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)
RoutedApplicationEmulator - Class in uk.nhs.interoperability.consumer.appemulator
The Class RoutedApplicationEmulator.
RoutedApplicationEmulator() - Constructor for class uk.nhs.interoperability.consumer.appemulator.RoutedApplicationEmulator
Instantiates a new routed application emulator.
RoutedMessageCallbackHandler - Class in uk.nhs.interoperability.client.samples
The Class RoutedMessageCallbackHandler.
RoutedMessageCallbackHandler() - Constructor for class uk.nhs.interoperability.client.samples.RoutedMessageCallbackHandler
 
run() - Method in class uk.nhs.interoperability.consumer.appemulator.ConsumerApplicationEmulator
 
run() - Method in class uk.nhs.interoperability.consumer.appemulator.RoutedApplicationEmulator
 
run() - Method in class uk.nhs.interoperability.consumer.appemulator.SimpleApplicationEmulator
 
run() - Method in class uk.nhs.interoperability.util.MessageQueue
 

S

send(NonCodedCDA, ITKAddress) - Method in class uk.nhs.interoperability.client.samples.cda.CDASender
Send.
send(ITKMessage) - Method in interface uk.nhs.interoperability.source.ITKMessageSender
Operation that allows a business payload to be sent to the destination service/system with no response expected (a.k.a.
send(ITKMessage) - Method in class uk.nhs.interoperability.source.ITKMessageSenderImpl
 
send(ITKTransportRoute, ITKMessage) - Method in interface uk.nhs.interoperability.transport.ITKSender
Operation that allows a business payload and ITK wrappers (e.g.
send(ITKTransportRoute, ITKMessage) - Method in class uk.nhs.interoperability.transport.WS.ITKSenderWSImpl
 
sendAsync(ITKMessage) - Method in interface uk.nhs.interoperability.source.ITKMessageSender
Operation that allows a business payload to be sent asynchronously to the destination service/system.
sendAsync(ITKMessage) - Method in class uk.nhs.interoperability.source.ITKMessageSenderImpl
 
sendAysnc(ITKTransportRoute, ITKMessage) - Method in interface uk.nhs.interoperability.transport.ITKSender
Operation that allows a business payload and ITK wrappers (e.g.
sendAysnc(ITKTransportRoute, ITKMessage) - Method in class uk.nhs.interoperability.transport.WS.ITKSenderWSImpl
 
sendInfrastructureAck(ITKMessageProperties) - Method in class uk.nhs.interoperability.consumer.ITKServlet
Send infrastructure ack.
sendSync(ITKMessage) - Method in interface uk.nhs.interoperability.source.ITKMessageSender
Operation that allows a business payload to be sent synchronously to the destination service/system returning the appropriate business response.
sendSync(ITKMessage) - Method in class uk.nhs.interoperability.source.ITKMessageSenderImpl
 
sendSync(ITKTransportRoute, ITKMessage) - Method in interface uk.nhs.interoperability.transport.ITKSender
Operation that allows a business payload and ITK wrappers (e.g.
sendSync(ITKTransportRoute, ITKMessage) - Method in class uk.nhs.interoperability.transport.WS.ITKSenderWSImpl
 
serialise() - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Serialise.
serialise() - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Serialise.
serialise() - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Serialise.
serialise() - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Serialise.
serialise() - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Serialise.
serialise() - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Serialise.
serialiseToXML(Document) - Static method in class uk.nhs.interoperability.util.xml.DomUtils
Serialise to xml.
serialiseToXML(Document, boolean) - Static method in class uk.nhs.interoperability.util.xml.DomUtils
Serialise to xml.
serialiseXML() - Method in exception uk.nhs.interoperability.transport.WS.ITKSOAPException
Builds a complete soap wrapped SOAPFault.
ServletUtils - Class in uk.nhs.interoperability.util
The Class ServletUtils.
ServletUtils() - Constructor for class uk.nhs.interoperability.util.ServletUtils
 
setAction(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the action.
setAuditIdentity(ITKIdentity) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the audit identity of the message originator
setAuditIdentity(ITKIdentity) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setBase64(boolean) - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
Sets the base64.
setBusinessPayload(String) - Method in class uk.nhs.interoperability.payload.DEWrappedMessage
 
setBusinessPayload(String) - Method in interface uk.nhs.interoperability.payload.ITKMessage
Sets the business payload portion of the message to be transmitted via the ITK transport and distribution infrastructure.

Note: those (ADT v2 pipe and hat) messages that ITK requires to be base64 encoded when being transmitted must not need to be pre-encoded - i.e.
setBusinessPayload(String) - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
 
setBusinessPayloadId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the business payloadId associated with this message.
setBusinessPayloadId(String) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setContactAddress(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the contact address.
setContactName(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the contact name.
setContactOrg(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the contact org.
setDateOfBirth(String) - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Sets the date of birth.
setDateOfBirth(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the date of birth.
setDateOfBirth(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Sets the date of birth.
setDateOfBirth(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Sets the date of birth.
setDateOfBirth(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Sets the date of birth.
setEffectiveTime(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the effective time.
setErrorCode(int) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Sets the errorCode associated with the ITKMessagingException.
setErrorCodeSystem(String) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Sets the errorCodeSystem for any errorCode associated with the ITKMessagingException.
setErrorId(String) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
Obtains the unique errorId for the ITKMessagingException The errorId is typically expected to be used in applications logs to uniquely tie log messages / exception traces together to aid in diagnostics
setEventTypeCode(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the event type code.
setEventTypeDesc(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the event type desc.
setFaultTo(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the fault to.
setFrom(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the from.
setFromAddress(ITKAddress) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the originators address for this message.
setFromAddress(ITKAddress) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setGender(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
 
setGivenName(String) - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Sets the given name.
setGivenName(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Sets the given name.
setGivenName(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Sets the given name.
setGivenName(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Sets the given name.
setInboundTransportProperties(ITKTransportProperties) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the ITKTransportProperties that are associated with the ITKMessage that was received by the service provider on the inbound leg in an asynchronous request/response invocation.

The inboundITKTransportProperties are not expected to be processed by the application layer, however where present the application layer is responsible for attaching the inboundITKTransportProperties to any responses generated such that these transport properties are available to the transport layers transmitting the response.

A typical use of this mechanism is for the propagation of the <wsa:replyTo/> URL such that it is available to the to the transport layers managing the "reply".

Note although this pattern adds some additional burden on the application layer it offers significant advantages over the alternative where the transport layer has to maintain state and correlate messages - potentially over several distributed nodes
setInboundTransportProperties(ITKTransportProperties) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setInvokedUrl(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setInvokedUrl(String) - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Sets the URL of the invoked service or transport hop.

For SOAP this is mapped to/from <wsa:To/>
setIsReponse(boolean) - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
Sets the checks if is reponse.
setLocalIdentifier(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
 
setLocalIdentifier(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
 
setMessageId(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the message id.
setMessageProperties(ITKMessageProperties) - Method in interface uk.nhs.interoperability.payload.ITKMessage
Sets the ITKMessageProperties associated with this message.
setMessageProperties(ITKMessageProperties) - Method in class uk.nhs.interoperability.payload.ITKMessageImpl
 
setMimeType(String) - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
Sets the mime type.
setMsgType(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the msg type.
setNHSNumber(String) - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Sets the nHS number.
setNHSNumber(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the nHS number.
setNHSNumber(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Sets the nHS number.
setNhsNumber(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Sets the nhs number.
setNHSNumber(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Sets the nHS number.
setNhsNumber(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Sets the nhs number.
setNHSNumber(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Sets the nHS number.
setNhsNumber(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Sets the nhs number.
setPatientAddress(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the patient address.
setPatientName(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the patient name.
setPayload(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the payload.
setPostcode(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Sets the postcode.
setPostcode(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Sets the postcode.
setPresentationText(String) - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Sets the presentation text.
setProfileId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the profileId associated with the ITKMessage.
setProfileId(String) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setRecipientAddress(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the recipient address.
setRecipientOrg(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the recipient org.
setRelatedItkTransportProperties(ITKTransportProperties) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
setRelatedMessageProperties(ITKMessageProperties) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
 
setReplyTo(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the reply to.
setResponseCode(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Sets the response code.
setResponseCode(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Sets the response code.
setResponseCode(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Sets the response code.
setResponseMessage(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberResponse
Sets the response message.
setResponseMessage(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Sets the response message.
setResponseMessage(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Sets the response message.
setSenderOrg(String) - Method in class uk.nhs.interoperability.client.samples.notification.Notification
Sets the sender org.
setServiceId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the ITK message serviceId associated with this message
setServiceId(String) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setServiceId(String) - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
Sets the service id.
setSupportsAsync(boolean) - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
Sets the supports async.
setSupportsSync(boolean) - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
Sets the supports sync.
setSurname(String) - Method in class uk.nhs.interoperability.client.samples.cda.NonCodedCDA
Sets the surname.
setSurname(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetNHSNumberRequest
Sets the surname.
setSurname(String) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberRequest
Sets the surname.
setSurname(String) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Sets the surname.
setTimeToLive(int) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the time to live.
setTo(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the to.
setToAddress(ITKAddress) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the destination address for the associated ITK Message.

Note Whilst the ITK Specifications allow for multiple recipients to be specified this version of the ITK API only supports a single recipient to be defined as this satisfies the majority of anticipated use-cases.
setToAddress(ITKAddress) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setTrackingId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties
Sets the tracking id associated with the ITKMessage prior to sending the message between two or more endpoints.
setTrackingId(String) - Method in class uk.nhs.interoperability.infrastructure.ITKMessagePropertiesImpl
 
setTransportAction(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportAction(String) - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Sets the transportAction for the associated ITKMessage.

For SOAP this is mapped to/from <wsa:Action/>
setTransportFaultTo(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportFaultTo(String) - Method in interface uk.nhs.interoperability.transport.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)
setTransportFrom(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportFrom(String) - Method in interface uk.nhs.interoperability.transport.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/>.

setTransportMessageId(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportMessageId(String) - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Sets the unique transport level identifier for the associated message.
setTransportRelatesTo(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportRelatesTo(String) - Method in interface uk.nhs.interoperability.transport.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/>.

setTransportReplyTo(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportReplyTo(String) - Method in interface uk.nhs.interoperability.transport.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)
setTransportTo(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportTo(String) - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Sets the transport hop destination.
setTransportType(String) - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
setTransportType(String) - Method in interface uk.nhs.interoperability.transport.ITKTransportProperties
Sets the transport type associated with this transport hop
setType(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress
Allows the address type to be specified if it is not the ITKAddress.DEFAULT_ADDRESS_TYPE
setType(String) - Method in class uk.nhs.interoperability.infrastructure.ITKAddressImpl
 
setType(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity
Allows the identity type to be specified if it is not the ITKIdentity.DEFAULT_IDENTITY_TYPE
setType(String) - Method in class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
 
setURI(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress
Set the URI for this address
setURI(String) - Method in class uk.nhs.interoperability.infrastructure.ITKAddressImpl
 
setURI(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity
Set the URI for this identity
setURI(String) - Method in class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
 
setUsername(String) - Method in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Sets the username.
setVerifiedIndicator(boolean) - Method in class uk.nhs.interoperability.client.samples.smsp.GetPatientDetailsByNHSNumberResponse
Sets the verified indicator.
setVerifiedIndicator(boolean) - Method in class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Sets the verified indicator.
setWrapperType(String) - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute
Sets the details of any transport route wrappers that are required for the business payload
setWrapperType(String) - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
SimpleApplicationEmulator - Class in uk.nhs.interoperability.consumer.appemulator
The Class SimpleApplicationEmulator.
SimpleApplicationEmulator() - Constructor for class uk.nhs.interoperability.consumer.appemulator.SimpleApplicationEmulator
Instantiates a new simple application emulator.
SimpleMessage - Class in uk.nhs.interoperability.payload
The Class SimpleMessage.
SimpleMessage() - Constructor for class uk.nhs.interoperability.payload.SimpleMessage
Instantiates a new simple message.
SimpleMessage(String) - Constructor for class uk.nhs.interoperability.payload.SimpleMessage
 
SimpleMessage(ITKMessageProperties, String) - Constructor for class uk.nhs.interoperability.payload.SimpleMessage
 
SimpleMessage(ITKMessageProperties, String, String, boolean) - Constructor for class uk.nhs.interoperability.payload.SimpleMessage
Instantiates a new simple message.
SimpleMessage(ITKMessageProperties) - Constructor for class uk.nhs.interoperability.payload.SimpleMessage
Instantiates a new simple message.
SimpleMessageCallbackHandler - Class in uk.nhs.interoperability.client.samples
The Class SimpleMessageCallbackHandler.
SimpleMessageCallbackHandler() - Constructor for class uk.nhs.interoperability.client.samples.SimpleMessageCallbackHandler
 
SMSProviderServlet - Class in uk.nhs.interoperability.consumer.smsp
The Class SMSProviderServlet.
SMSProviderServlet() - Constructor for class uk.nhs.interoperability.consumer.smsp.SMSProviderServlet
Instantiates a new SMSProviderServlet.
SOAP_BODY - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_BODY.
SOAP_BODY_CONTENT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
Obtains the SOAP body contents - typically this will contain the ITK distribution envelope.
SOAP_BODY_CONTENT_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_BODY_CONTENT_XPATH.
SOAP_BODY_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_BODY_XPATH.
SOAP_HEADER - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_HEADER.
SOAP_HEADER_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_HEADER_XPATH.
SOAP_WRAPPED_ITK_FIRST_PAYLOAD - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_WRAPPED_ITK_FIRST_PAYLOAD.
SOAP_WRAPPED_ITK_FIRST_PAYLOAD_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_WRAPPED_ITK_FIRST_PAYLOAD_XPATH.
SOAP_WRAPPED_ITK_SIMPLE_MESSAGE_RESPONSE - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_WRAPPED_ITK_SIMPLE_MESSAGE_RESPONSE.
SOAP_WRAPPED_ITK_SIMPLE_MESSAGE_RESPONSE_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant SOAP_WRAPPED_ITK_SIMPLE_MESSAGE_RESPONSE_XPATH.
SOAPENVNAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant SOAPENVNAMESPACE.
SOAPENVNAMESPACE_DEFAULT_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant SOAPENVNAMESPACE_DEFAULT_PREFIX.
SOAPUtils - Class in uk.nhs.interoperability.transport.WS
The Class SOAPUtils.
SPINE_TMS - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
Constant to indicate a Spine TMS forward channel ITKTransportRoute
SpineMiniServicesClient - Class in uk.nhs.interoperability.client.samples.smsp
The Class SpineMiniServicesClient.
SpineMiniServicesClient() - Constructor for class uk.nhs.interoperability.client.samples.smsp.SpineMiniServicesClient
 
StandaloneServer - Class in uk.nhs.interoperability.client.samples
Creates a standalone server for the war - i.e.
StringUtils - Class in uk.nhs.interoperability.util
The Class StringUtils.
supportsAsync() - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
 
supportsAsync() - Method in interface uk.nhs.interoperability.service.ITKService
Determines whether or not this service supports an asynchronous invocation.
supportsSync() - Method in class uk.nhs.interoperability.infrastructure.ITKServiceImpl
 
supportsSync() - Method in interface uk.nhs.interoperability.service.ITKService
Determines whether or not this service supports synchronous invocation.
SYNCREQ - Static variable in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
The Constant SYNCREQ.
SYNCRESP - Static variable in class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
The Constant SYNCRESP.

T

toString() - Method in class uk.nhs.interoperability.infrastructure.ITKAddressImpl
 
toString() - Method in class uk.nhs.interoperability.infrastructure.ITKIdentityImpl
 
toString() - Method in class uk.nhs.interoperability.infrastructure.ITKTransportPropertiesImpl
 
toString() - Method in class uk.nhs.interoperability.transport.ITKTransportRouteImpl
 
TRACE - Static variable in class uk.nhs.interoperability.util.Logger
The Constant TRACE.
trace(String) - Static method in class uk.nhs.interoperability.util.Logger
Trace.
TransformManager - Class in uk.nhs.interoperability.transform
The Class TransformManager.
TransformManager() - Constructor for class uk.nhs.interoperability.transform.TransformManager
 

U

uk.nhs.interoperability.capabilities - package uk.nhs.interoperability.capabilities
Additional ITK API capabilities/extensions for features that are not fully specified by the (normative) written ITK Specifications
uk.nhs.interoperability.client.samples - package uk.nhs.interoperability.client.samples
 
uk.nhs.interoperability.client.samples.adt - package uk.nhs.interoperability.client.samples.adt
 
uk.nhs.interoperability.client.samples.cda - package uk.nhs.interoperability.client.samples.cda
 
uk.nhs.interoperability.client.samples.notification - package uk.nhs.interoperability.client.samples.notification
 
uk.nhs.interoperability.client.samples.smsp - package uk.nhs.interoperability.client.samples.smsp
 
uk.nhs.interoperability.consumer - package uk.nhs.interoperability.consumer
API pertinent to ITK message consumers.
uk.nhs.interoperability.consumer.adt - package uk.nhs.interoperability.consumer.adt
 
uk.nhs.interoperability.consumer.appemulator - package uk.nhs.interoperability.consumer.appemulator
 
uk.nhs.interoperability.consumer.smsp - package uk.nhs.interoperability.consumer.smsp
 
uk.nhs.interoperability.infrastructure - package uk.nhs.interoperability.infrastructure
Base / infrastructure classes necessary to support ITK Transport and distribution.
uk.nhs.interoperability.payload - package uk.nhs.interoperability.payload
Interfaces to support the generic handling of ITK messages by the transport and distribution infrastructure.
uk.nhs.interoperability.service - package uk.nhs.interoperability.service
Interfaces to represent the messaging service elements of the transport and distribution layers.
uk.nhs.interoperability.source - package uk.nhs.interoperability.source
Interfaces to represent information/document/message sources responsibilities in support of ITK message exchange patterns.
uk.nhs.interoperability.transform - package uk.nhs.interoperability.transform
Classes for handling XSLT based transforms.
uk.nhs.interoperability.transport - package uk.nhs.interoperability.transport
Interfaces representing the abstraction of transport elements of the ITK transport and distribution infrastructure.
uk.nhs.interoperability.transport.WS - package uk.nhs.interoperability.transport.WS
HTTP SOAP Web Service transport implementation classes.
uk.nhs.interoperability.util - package uk.nhs.interoperability.util
General utility classes.
uk.nhs.interoperability.util.xml - package uk.nhs.interoperability.util.xml
XML manipulation and utility classes.
UNKNOWN - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute
Indicates an unknown transport type

V

validateDistributionEnvelope(ITKMessageProperties) - Method in class uk.nhs.interoperability.consumer.ITKServlet
Validate distribution envelope.
verifyNHSNumber(VerifyNHSNumberRequest, ITKAddress) - Method in class uk.nhs.interoperability.client.samples.smsp.SpineMiniServicesClient
Verify nhs number.
VerifyNHSNumberRequest - Class in uk.nhs.interoperability.client.samples.smsp
The Class VerifyNHSNumberRequest.
VerifyNHSNumberRequest() - Constructor for class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberRequest
Instantiates a new verify nhs number request.
VerifyNHSNumberResponse - Class in uk.nhs.interoperability.client.samples.smsp
The Class VerifyNHSNumberResponse.
VerifyNHSNumberResponse(ITKMessage) - Constructor for class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberResponse
Instantiates a new verify nhs number response.
VerifyNHSNumberServlet - Class in uk.nhs.interoperability.client.samples.smsp
The Class VerifyNHSNumberServlet.
VerifyNHSNumberServlet() - Constructor for class uk.nhs.interoperability.client.samples.smsp.VerifyNHSNumberServlet
Instantiates a new verify nhs number servlet.

W

WARN - Static variable in class uk.nhs.interoperability.util.Logger
The Constant WARN.
warn(String) - Static method in class uk.nhs.interoperability.util.Logger
Warn.
warn(String, Throwable) - Static method in class uk.nhs.interoperability.util.Logger
Warn.
WSA_ACTION - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_ACTION.
WSA_ACTION_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_ACTION_XPATH.
WSA_FAULT_TO - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_FAULT_TO.
WSA_FAULT_TO_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_FAULT_TO_XPATH.
WSA_FROM - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_FROM.
WSA_FROM_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_FROM_XPATH.
WSA_MSG_ID - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_MSG_ID.
WSA_MSGID_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_MSGID_XPATH.
WSA_REPLY_TO - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_REPLY_TO.
WSA_REPLY_TO_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_REPLY_TO_XPATH.
WSA_SECURITY_CREATED - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_CREATED.
WSA_SECURITY_CREATED_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_CREATED_XPATH.
WSA_SECURITY_EXPIRES - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_EXPIRES.
WSA_SECURITY_EXPIRES_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_EXPIRES_XPATH.
WSA_SECURITY_TIMESTAMP - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_TIMESTAMP.
WSA_SECURITY_TIMESTAMP_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_TIMESTAMP_XPATH.
WSA_SECURITY_USERNAME - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_USERNAME.
WSA_SECURITY_USERNAME_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SECURITY_USERNAME_XPATH.
WSA_SOAP_ERROR_DETAIL - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL.
WSA_SOAP_ERROR_DETAIL_CODE - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_CODE.
WSA_SOAP_ERROR_DETAIL_CODE_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_CODE_XPATH.
WSA_SOAP_ERROR_DETAIL_DIAGNOSTIC - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_DIAGNOSTIC.
WSA_SOAP_ERROR_DETAIL_DIAGNOSTIC_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_DIAGNOSTIC_XPATH.
WSA_SOAP_ERROR_DETAIL_ID - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_ID.
WSA_SOAP_ERROR_DETAIL_ID_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_ID_XPATH.
WSA_SOAP_ERROR_DETAIL_TEXT - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_TEXT.
WSA_SOAP_ERROR_DETAIL_TEXT_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_TEXT_XPATH.
WSA_SOAP_ERROR_DETAIL_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_SOAP_ERROR_DETAIL_XPATH.
WSA_TO - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_TO.
WSA_TO_XPATH - Static variable in class uk.nhs.interoperability.util.xml.XPaths
The Constant WSA_TO_XPATH.
WSANAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant WSANAMESPACE.
WSANAMESPACE_DEFAULT_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant WSANAMESPACE_DEFAULT_PREFIX.
WSSENAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant WSSENAMESPACE.
WSSENAMESPACE_DEFAULT_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant WSSENAMESPACE_DEFAULT_PREFIX.
WSSOAPMessageImpl - Class in uk.nhs.interoperability.transport.WS
The Class WSSOAPMessageImpl.
WSSOAPMessageImpl() - Constructor for class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Instantiates a new wSSOAP message impl.
WSSOAPMessageImpl(ITKMessage, String) - Constructor for class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
 
WSSOAPMessageImpl(ITKTransportRoute, ITKMessage, String) - Constructor for class uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl
Instantiates a new wSSOAP message impl.
WSUNAMESPACE - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant WSUNAMESPACE.
WSUNAMESPACE_DEFAULT_PREFIX - Static variable in class uk.nhs.interoperability.util.xml.XMLNamespaceContext
The Constant WSUNAMESPACE_DEFAULT_PREFIX.

X

XMLNamespaceContext - Class in uk.nhs.interoperability.util.xml
The Class XMLNamespaceContext.
XMLNamespaceContext() - Constructor for class uk.nhs.interoperability.util.xml.XMLNamespaceContext
 
XPaths - Class in uk.nhs.interoperability.util.xml
The Class XPaths.
XPaths() - Constructor for class uk.nhs.interoperability.util.xml.XPaths
 
A B C D E F G H I L M N O P Q R S T U V W X 

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