Package org.openehealth.ipf.commons.ihe.ws.correlation

Class EhcacheAsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

java.lang.Object

org.openehealth.ipf.commons.ihe.ws.correlation.EhcacheAsynchronyCorrelator<AuditDatasetType>

All Implemented Interfaces:

AsynchronyCorrelator<AuditDatasetType>

public class EhcacheAsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>
extends Object
implements AsynchronyCorrelator<AuditDatasetType>

Ehcache-based implementation of asynchronous message correlator.

Author:

Dmytro Rud

Field Summary

Fields inherited from interface org.openehealth.ipf.commons.ihe.ws.correlation.AsynchronyCorrelator

FORCE_CORRELATION

Constructor Summary

Constructors

Constructor	Description
EhcacheAsynchronyCorrelator(javax.cache.Cache<String,Serializable> ehcache)

Method Summary

Modifier and Type	Method	Description
boolean	delete(String messageId)	Deletes information pieces about the message with the given ID.
AuditDatasetType	getAuditDataset(String messageId)	Returns the audit dataset for the request message with the given ID, or null if the message is unknown.
String	getCorrelationKey(String messageId)	Returns the user-defined correlation key for the message with the given ID, or null if the message is unknown or the user did not provided any correlation key.
String	getMessageId(String alternativeKey)	Determines WS-Addressing message ID ("primary key") which corresponds to the given alternative key.
String	getServiceEndpointUri(String messageId)	Returns the URI of the endpoint to which the message with the given ID has been sent, or null if the message is unknown.
void	storeAlternativeKeys(String messageId, String... alternativeKeys)	Stores a set of alternative keys for the message with the given WS-Addressing ID.
void	storeAuditDataset(String messageId, WsAuditDataset auditDataset)	Stores audit dataset.
void	storeCorrelationKey(String messageId, String correlationKey)	Stores a user-defined correlation key.
void	storeServiceEndpointUri(String messageId, String serviceEndpointUri)	Stores a service endpoint URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

EhcacheAsynchronyCorrelator

public EhcacheAsynchronyCorrelator(javax.cache.Cache<String,Serializable> ehcache)

Method Detail

storeServiceEndpointUri

public void storeServiceEndpointUri(String messageId,
                                    String serviceEndpointUri)

Description copied from interface: AsynchronyCorrelator

Stores a service endpoint URI.

Specified by:

storeServiceEndpointUri in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

Parameters:

messageId - WS-Addressing message ID of the request.

serviceEndpointUri - URL of the endpoint the request is being sent to.

storeCorrelationKey

public void storeCorrelationKey(String messageId,
                                String correlationKey)

Description copied from interface: AsynchronyCorrelator

Stores a user-defined correlation key.

Specified by:

storeCorrelationKey in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

Parameters:

messageId - WS-Addressing message ID of the request.

correlationKey - correlation key provided by the user.

storeAuditDataset

public void storeAuditDataset(String messageId,
                              WsAuditDataset auditDataset)

Description copied from interface: AsynchronyCorrelator

Stores audit dataset.

Specified by:

storeAuditDataset in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

Parameters:

messageId - WS-Addressing message ID of the request.

auditDataset - audit dataset.

getServiceEndpointUri

public String getServiceEndpointUri(String messageId)

Description copied from interface: AsynchronyCorrelator

Returns the URI of the endpoint to which the message with the given ID has been sent, or null if the message is unknown.

Specified by:

getServiceEndpointUri in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

getCorrelationKey

public String getCorrelationKey(String messageId)

Description copied from interface: AsynchronyCorrelator

Returns the user-defined correlation key for the message with the given ID, or null if the message is unknown or the user did not provided any correlation key.

Specified by:

getCorrelationKey in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

getAuditDataset

public AuditDatasetType getAuditDataset(String messageId)

Description copied from interface: AsynchronyCorrelator

Returns the audit dataset for the request message with the given ID, or null if the message is unknown.

Specified by:

getAuditDataset in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

storeAlternativeKeys

public void storeAlternativeKeys(String messageId,
                                 String... alternativeKeys)

Description copied from interface: AsynchronyCorrelator

Stores a set of alternative keys for the message with the given WS-Addressing ID. When the <RelatesTo> header of the incoming response does not contain a valid/a known message ID for correlation, the system will use transaction-specific mechanisms to extract additional keys from the message body and to perform the correlation of their basis.

The correlator must maintain bi-directional correspondence between the "primary" key (WS-Addressing message ID of the request) and the alternative keys. The uniqueness of the alternative keys should be provided, but cannot be guaranteed.

Specified by:

storeAlternativeKeys in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

Parameters:

messageId - WS-Addressing message ID of the request.

alternativeKeys - alternative keys, should be not null.

getMessageId

public String getMessageId(String alternativeKey)

Description copied from interface: AsynchronyCorrelator

Determines WS-Addressing message ID ("primary key") which corresponds to the given alternative key.

Specified by:

getMessageId in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

Parameters:

alternativeKey - alternative key.

Returns:

WS-Addressing message ID or null when not found.

delete

public boolean delete(String messageId)

Description copied from interface: AsynchronyCorrelator

Deletes information pieces about the message with the given ID.

This method is supposed to be called internally after the correlation of an asynchronous response has been completed; the user does not have to call it explicitly (but who knows...).

Specified by:

delete in interface AsynchronyCorrelator<AuditDatasetType extends WsAuditDataset>

Returns:

true when there actually was something to delete, i.e. when the given ID was known; false otherwise.