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

Interface IResourceMessage

All Superinterfaces:
IHasPayloadMessageKey
All Known Implementing Classes:
BaseResourceMessage, BaseResourceModifiedMessage, ResourceOperationMessage
public interface IResourceMessage extends IHasPayloadMessageKey
IMessage implementations that deliver a FHIR Resource payload can implement this interface to make the resource id available to loggers.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getPayloadId()
    This method is primarily used for logging
    void
    setPayloadId(org.hl7.fhir.instance.model.api.IIdType theResourceId)
     
    void
    setPayloadMessageKey(String thePayloadMessageKey)
    In cases where the IMessage extracts the message key from the payload, this method can be used to set the message key that will be used.

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

    getPayloadMessageKey

  • Method Details

    • setPayloadId

      void setPayloadId(org.hl7.fhir.instance.model.api.IIdType theResourceId)
      Parameters:
      theResourceId - of the resource contained in the payload

    • getPayloadId

      String getPayloadId()
      This method is primarily used for logging
      Returns:
      the id of the resource contained in the payload

    • setPayloadMessageKey

      void setPayloadMessageKey(String thePayloadMessageKey)
      In cases where the IMessage extracts the message key from the payload, this method can be used to set the message key that will be used. See IMessage.getMessageKey() and IHasPayloadMessageKey.getPayloadMessageKey()
      Parameters:
      thePayloadMessageKey - the message key that should be used for the message delivering this payload