Package ca.uhn.fhir.rest.server.messaging.json

Class BaseJsonMessage<T>

java.lang.Object

ca.uhn.fhir.rest.server.messaging.json.BaseJsonMessage<T>

All Implemented Interfaces:

ca.uhn.fhir.model.api.IModelJson, IMessage<T>, IMessageDeliveryContext, org.springframework.messaging.Message<T>

Direct Known Subclasses:

ResourceOperationJsonMessage

public abstract class BaseJsonMessage<T>
extends Object
implements IMessage<T>, org.springframework.messaging.Message<T>, ca.uhn.fhir.model.api.IModelJson, IMessageDeliveryContext

Field Summary

Fields inherited from interface ca.uhn.fhir.model.api.IModelJson

SENSITIVE_DATA_FILTER_NAME

Constructor Summary

Constructors

Constructor	Description
BaseJsonMessage()	Constructor

Method Summary

Modifier and Type	Method	Description
HapiMessageHeaders	getHapiHeaders()
org.springframework.messaging.MessageHeaders	getHeaders()
String	getMessageKey()	The message key is used by brokers that support channel partitioning.
int	getRetryCount()
protected void	setDefaultRetryHeaders()
void	setHeaders(HapiMessageHeaders theHeaders)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.rest.server.messaging.IMessage

getHeader, getHeadersAsStrings, getPayload

Methods inherited from interface org.springframework.messaging.Message

getPayload

Constructor Details

BaseJsonMessage

public BaseJsonMessage()

Constructor

Method Details

setDefaultRetryHeaders

protected void setDefaultRetryHeaders()

getHeaders

@Nonnull
public org.springframework.messaging.MessageHeaders getHeaders()

Specified by:

getHeaders in interface IMessage<T>

Specified by:

getHeaders in interface org.springframework.messaging.Message<T>

Returns:

a map of message headers

getHapiHeaders

public HapiMessageHeaders getHapiHeaders()

setHeaders

public void setHeaders(HapiMessageHeaders theHeaders)

getMessageKey

@Nonnull
public String getMessageKey()

Description copied from interface: IMessage

The message key is used by brokers that support channel partitioning. The message key is used to determine which partition a message is stored on. If message order is important, then the same message key should be used for all messages that need to preserve their order. E.g. if a series of messages create, update, and delete a resource, the resource id would be a good candidate for the message key to ensure the order of operations is preserved on all messages concerning that resource.

Specified by:

getMessageKey in interface IMessage<T>

Returns:

the key of the message.

getRetryCount

public int getRetryCount()

Specified by:

getRetryCount in interface IMessageDeliveryContext

Returns:

the number of retries for this message delivery. The first delivery has a retry count of 0.