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

Class BaseResourceMessage

java.lang.Object

ca.uhn.fhir.rest.server.messaging.BaseResourceMessage

All Implemented Interfaces:

ca.uhn.fhir.model.api.IModelJson, IResourceMessage

Direct Known Subclasses:

BaseResourceModifiedMessage

public abstract class BaseResourceMessage
extends Object
implements IResourceMessage, ca.uhn.fhir.model.api.IModelJson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BaseResourceMessage.OperationTypeEnum

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseResourceMessage.OperationTypeEnum	myOperationType

Constructor Summary

Constructors

Constructor	Description
BaseResourceMessage()

Method Summary

Modifier and Type	Method	Description
void	copyAdditionalPropertiesFrom(BaseResourceMessage theMsg)	Copies any attributes from the given message into this messsage.
Optional<String>	getAttribute(String theKey)	Returns an attribute stored in this message.
Map<String,String>	getAttributes()
String	getMediaType()
String	getMessageKey()
protected String	getMessageKeyDefaultValue()	Provides a fallback value when method getMessageKey() returns null.
String	getMessageKeyOrDefault()	Returns getMessageKey() or getMessageKeyDefaultValue() when getMessageKey() returns null.
String	getMessageKeyOrNull()	Deprecated.
BaseResourceMessage.OperationTypeEnum	getOperationType()	Returns the BaseResourceMessage.OperationTypeEnum that is occurring to the Resource of the message
String	getTransactionId()	Retrieve the transaction ID related to this message.
void	setAttribute(String theKey, String theValue)	Sets an attribute stored in this message.
void	setMediaType(String theMediaType)
void	setMessageKey(String theMessageKey)
void	setOperationType(BaseResourceMessage.OperationTypeEnum theOperationType)	Sets the BaseResourceMessage.OperationTypeEnum occuring to the resource of the message.
void	setTransactionId(String theTransactionId)	Adds a transaction ID to this message.

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.IResourceMessage

getPayloadId

Field Details

myOperationType

protected BaseResourceMessage.OperationTypeEnum myOperationType

Constructor Details

BaseResourceMessage

public BaseResourceMessage()

Method Details

getAttribute

public Optional<String> getAttribute(String theKey)

Returns an attribute stored in this message.

Attributes are just a spot for user data of any kind to be added to the message for pasing along the subscription processing pipeline (typically by interceptors). Values will be carried from the beginning to the end.

Note that messages are designed to be passed into queueing systems and serialized as JSON. As a result, only strings are currently allowed as values.

setAttribute

public void setAttribute(String theKey,
 String theValue)

Sets an attribute stored in this message.

Attributes are just a spot for user data of any kind to be added to the message for passing along the subscription processing pipeline (typically by interceptors). Values will be carried from the beginning to the end.

Note that messages are designed to be passed into queueing systems and serialized as JSON. As a result, only strings are currently allowed as values.

Parameters:

theKey - The key (must not be null or blank)

theValue - The value (must not be null)

copyAdditionalPropertiesFrom

public void copyAdditionalPropertiesFrom(BaseResourceMessage theMsg)

Copies any attributes from the given message into this messsage.

See Also:

• setAttribute(String, String)
• getAttribute(String)

getOperationType

public BaseResourceMessage.OperationTypeEnum getOperationType()

Returns the BaseResourceMessage.OperationTypeEnum that is occurring to the Resource of the message

Returns:

the operation type.

setOperationType

public void setOperationType(BaseResourceMessage.OperationTypeEnum theOperationType)

Sets the BaseResourceMessage.OperationTypeEnum occuring to the resource of the message.

Parameters:

theOperationType - The operation type to set.

getTransactionId

@Nullable
public String getTransactionId()

Retrieve the transaction ID related to this message.

Returns:

the transaction ID, or null.

setTransactionId

public void setTransactionId(String theTransactionId)

Adds a transaction ID to this message. This ID can be used for many purposes. For example, performing tracing across asynchronous hooks, tying data together, or downstream logging purposes.

One current internal implementation uses this field to tie back MDM processing results (which are asynchronous) to the original transaction log that caused the MDM processing to occur.

Parameters:

theTransactionId - An ID representing a transaction of relevance to this message.

getMediaType

public String getMediaType()

setMediaType

public void setMediaType(String theMediaType)

getMessageKeyOrNull

@Deprecated
@Nullable
public String getMessageKeyOrNull()

Deprecated.

getMessageKey

@Nullable
public String getMessageKey()

setMessageKey

public void setMessageKey(String theMessageKey)

getMessageKeyOrDefault

@Nullable
public String getMessageKeyOrDefault()

Returns getMessageKey() or getMessageKeyDefaultValue() when getMessageKey() returns null.

Returns:

the message key value or default

getMessageKeyDefaultValue

@Nullable
protected String getMessageKeyDefaultValue()

Provides a fallback value when method getMessageKey() returns null.

Returns:

null by default

getAttributes

public Map<String,String> getAttributes()