Index (ITK API 0.1-SNAPSHOT API)

A B D G H I M N O P R S U

A

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
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.
auditEvent(String, long, ITKMessageProperties) - Method in interface uk.nhs.interoperability.capabilities.AuditService: Writes an audit event to the audit service using the supplied information.
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

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

D

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
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.
DTS - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute: Constant to indicate a DTS (Data Transfer Service) ITKTransportRoute

G

getAuditIdentity() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Returns the audit identity of the ITK message originator
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.
getBusinessPayloadId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Obtains the business payloadId associated with this message.
getDestinationType() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute: Obtains the destination type
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
getExceptionToAddress() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute: Obtains the address for sending an exceptions that are reported asynchronously
getFromAddress() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Obtains the originators ITK address
getFullPayload() - Method in interface uk.nhs.interoperability.payload.ITKMessage: Obtains the full ITKMessage including any wrappers
getHandlingSpecification(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Convenience method that allows the value of the handling specification to be obtained directly.
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.
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
getIntendedRecipient() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails: Provides the ITKAddress for the intended recipient of the message being acknowledged
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/>
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() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException: Obtains the standard (human readable message) associated with the ITKMessagingException.
getMessageProperties() - Method in interface uk.nhs.interoperability.payload.ITKMessage: Obtains the ITKMessageProperties associated with this message.
getMimeType() - Method in interface uk.nhs.interoperability.service.ITKService: Specifies the appropriate mime type for this service
getNackError() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails: Obtains details about the error for which the Nack is being generated.
getPhysicalAddress() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute: Obtains the transport specific physical destination address
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.
getProfileId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Obtains the profileId associated with the ITKMessage.
getProfileSupportLevel(String) - Method in interface uk.nhs.interoperability.capabilities.ITKProfileManager: Determines whether the provided profileId is supported.
getRelatedItkTransportProperties() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
getRelatedMessageProperties() - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
getReplyToAddress() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute: Obtains the address for any asynchronous replies
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
getService(String) - Method in interface uk.nhs.interoperability.capabilities.DirectoryOfServices: Get the ITKService for the supplied serviceId
getServiceId() - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: ITK message service associated with the message
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
getTimeToLive() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute: Obtains the time to live for any messages being sent via this ITKTransportRoute
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.
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.
getTrackingRef() - Method in interface uk.nhs.interoperability.infrastructure.ITKAckDetails: The tracking id reference from the message being acknowledged
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 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 interface uk.nhs.interoperability.transport.ITKTransportProperties: Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous faults to.
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 interface uk.nhs.interoperability.transport.ITKTransportProperties: Gets the unique transport level identifier for the associated message.
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 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 interface uk.nhs.interoperability.transport.ITKTransportProperties: Convenience method to return a fully constructed ITKTransportRoute for returning asynchronous response messages to.
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
getType() - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress: Obtains the address type
getType() - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity: Obtains the identity type
getURI() - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress: Obtain the URI associated with this address - e.g.
getURI() - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity: Obtain the URI associated with this identity
getWrapperType() - Method in interface uk.nhs.interoperability.transport.ITKTransportRoute: Obtains the details of any transport route wrappers that are required for the business payload

H

HTTP_WS - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute: Constant to indicate an HTTP SOAP/Web Service ITKTransportRoute

I

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 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
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
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.
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
ITKIdentity - Interface in uk.nhs.interoperability.infrastructure: Interface representing a logical identity of a person or system typically used for audit purposes.
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.
ITKMessageProperties - Interface in uk.nhs.interoperability.infrastructure: Interface that represents the addressing, audit and other meta-data information associated with the ITK Message.
ITKMessageSender - Interface in uk.nhs.interoperability.source: Interface that represents the application entry point for sending ITK messages to a remote Destination.
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
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
ITKSender - Interface in uk.nhs.interoperability.transport: Interface that represents the transport neutral interface for sending ITK messages to a remote destination.
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.
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
ITKTransportRoute - Interface in uk.nhs.interoperability.transport: Interface representing the properties of a physical (transport specific) destination.
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

M

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

N

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
NOT_SUPPORTED - Static variable in interface uk.nhs.interoperability.capabilities.ITKProfileManager: The profileId is either unknown or is not accepted by the recipient

O

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 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 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 interface uk.nhs.interoperability.consumer.ITKMessageConsumer: Call to process a request message where the application response is returned synchronously (in the same thread)

P

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: Standard text associated with the ITKMessagingException.PROCESSING_ERROR_NOT_RETRYABLE_CODE
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: Standard text associated with the ITKMessagingException.PROCESSING_ERROR_RETRYABLE_CODE

R

resolveDestination(String, ITKAddress) - Method in interface uk.nhs.interoperability.capabilities.DirectoryOfServices: Resolve the ITKTransportRoute for the supplied service and logical destination address.
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)

S

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(ITKTransportRoute, ITKMessage) - Method in interface uk.nhs.interoperability.transport.ITKSender: Operation that allows a business payload and ITK wrappers (e.g.
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.
sendAysnc(ITKTransportRoute, ITKMessage) - Method in interface uk.nhs.interoperability.transport.ITKSender: Operation that allows a business payload and ITK wrappers (e.g.
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(ITKTransportRoute, ITKMessage) - Method in interface uk.nhs.interoperability.transport.ITKSender: Operation that allows a business payload and ITK wrappers (e.g.
setAuditIdentity(ITKIdentity) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Sets the audit identity of the message originator
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.
setBusinessPayloadId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Sets the business payloadId associated with this message.
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
setFromAddress(ITKAddress) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Sets the originators address for this message.
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
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/>
setMessageProperties(ITKMessageProperties) - Method in interface uk.nhs.interoperability.payload.ITKMessage: Sets the ITKMessageProperties associated with this message.
setProfileId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Sets the profileId associated with the ITKMessage.
setRelatedItkTransportProperties(ITKTransportProperties) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
setRelatedMessageProperties(ITKMessageProperties) - Method in exception uk.nhs.interoperability.infrastructure.ITKMessagingException
setServiceId(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKMessageProperties: Sets the ITK message serviceId associated with this message
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.
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.
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 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 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 interface uk.nhs.interoperability.transport.ITKTransportProperties: Sets the unique transport level identifier for the associated message.
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 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 interface uk.nhs.interoperability.transport.ITKTransportProperties: Sets the transport hop destination.
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 interface uk.nhs.interoperability.infrastructure.ITKIdentity: Allows the identity type to be specified if it is not the ITKIdentity.DEFAULT_IDENTITY_TYPE
setURI(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKAddress: Set the URI for this address
setURI(String) - Method in interface uk.nhs.interoperability.infrastructure.ITKIdentity: Set the URI for this identity
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
SPINE_TMS - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute: Constant to indicate a Spine TMS forward channel ITKTransportRoute
supportsAsync() - Method in interface uk.nhs.interoperability.service.ITKService: Determines whether or not this service supports an asynchronous invocation.
supportsSync() - Method in interface uk.nhs.interoperability.service.ITKService: Determines whether or not this service supports synchronous invocation.

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.consumer - package uk.nhs.interoperability.consumer: API pertinent to ITK message consumers.
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.transport - package uk.nhs.interoperability.transport: Interfaces representing the abstraction of transport elements of the ITK transport and distribution infrastructure.
UNKNOWN - Static variable in interface uk.nhs.interoperability.transport.ITKTransportRoute: Indicates an unknown transport type

A B D G H I M N O P R S U

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