uk.nhs.interoperability.client.samples

Class SimpleMessageCallbackHandler

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

uk.nhs.interoperability.consumer.ITKServlet

uk.nhs.interoperability.consumer.AbstractCallbackListenerServlet

uk.nhs.interoperability.client.samples.SimpleMessageCallbackHandler

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, ITKCallbackHandler

public class SimpleMessageCallbackHandler
extends AbstractCallbackListenerServlet
implements ITKCallbackHandler

The Class SimpleMessageCallbackHandler.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

See Also:

Serialized Form

Field Summary

Fields inherited from class uk.nhs.interoperability.consumer.ITKServlet

dos

Constructor Summary

Constructors

Constructor and Description
SimpleMessageCallbackHandler()

Method Summary

Methods

Modifier and Type	Method and Description
ITKCallbackHandler	getCallbackHandler() Gets the callback handler.
void	onAck(ITKAckDetails ack) 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.
void	onMessage(ITKMessage request) 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.
void	onNack(ITKAckDetails nack) 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.

Methods inherited from class uk.nhs.interoperability.consumer.AbstractCallbackListenerServlet

doPost, init

Methods inherited from class uk.nhs.interoperability.consumer.ITKServlet

addITKWrappers, checkProfileId, checkServiceId, sendInfrastructureAck, validateDistributionEnvelope

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleMessageCallbackHandler

public SimpleMessageCallbackHandler()

Method Detail

onMessage

public void onMessage(ITKMessage request)

Description copied from interface: 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.

Specified by:

onMessage in interface ITKCallbackHandler

Parameters:

request - The ITKMessage representing the response

onAck

public void onAck(ITKAckDetails ack)

Description copied from interface: 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.

Specified by:

onAck in interface ITKCallbackHandler

Parameters:

ack - The (positive) acknowledgement. This can be correlated back to the request via the ITKAckDetails.getTrackingRef() method. Note correlation is an application layer responsibility.

onNack

public void onNack(ITKAckDetails nack)

Description copied from interface: 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.

Specified by:

onNack in interface ITKCallbackHandler

Parameters:

nack - The (negative) acknowledgement. This can be correlated back to the request via the ITKAckDetails.getTrackingRef() method. Note correlation is an application layer responsibility. Details of the error associated with the "delivery failure" can be retrieved via the ITKAckDetails.getNackError() method.

getCallbackHandler

public ITKCallbackHandler getCallbackHandler()

Description copied from class: AbstractCallbackListenerServlet

Gets the callback handler.

Specified by:

getCallbackHandler in class AbstractCallbackListenerServlet

Returns:

the callback handler