Package com.broadleafcommerce.deadletter.domain

Class DeadLetter

java.lang.Object
com.broadleafcommerce.deadletter.domain.DeadLetter
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware
public class DeadLetter extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware
This is a representation of a special type of message that stores messages the billing module cannot process due to errors

  • Field Details

    • stacktraceMaxLength

      protected int stacktraceMaxLength
      Maximum length of the stacktrace for this DeadLetter

    • id

      @Size(max=255) protected @Size(max=255) String id

    • jobId

      protected String jobId
      ID of the Billing Job where this dead letter originated

    • messageUUID

      protected String messageUUID
      If this DeadLetter occurred during message transit, id of the message

    • receiptUUID

      protected String receiptUUID
      If this DeadLetter occurred during message consumption, id of message receipt

    • subscriptionName

      protected String subscriptionName
      Name of the message channel binding (subscription) where this DeadLetter originated

    • messagePayload

      protected Object messagePayload
      Payload of the central message object that kicked off the stage of the Billing Job where this DeadLetter occurred

    • errorMessage

      protected String errorMessage
      The message of the exception that caused this DeadLetter

    • stacktrace

      protected String stacktrace
      The stacktrace of the exception that caused this DeadLetter

    • resolutionStatus

      protected DeadLetterResolutionStatusEnum resolutionStatus
      Resolution status of this DeadLetter

    • supportsRetry

      protected boolean supportsRetry
      Whether this instance is supported by an active DeadLetterRetryHandler

  • Constructor Details

    • DeadLetter

      public DeadLetter()

    • DeadLetter

      public DeadLetter(int stacktraceMaxLength, String id, String jobId, String messageUUID, String receiptUUID, String subscriptionName, Object messagePayload, String errorMessage, String stacktrace, DeadLetterResolutionStatusEnum resolutionStatus, boolean supportsRetry, com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

  • Method Details

    • getResolutionStatus

      public DeadLetterResolutionStatusEnum getResolutionStatus()

    • getStacktraceMaxLength

      public int getStacktraceMaxLength()
      Maximum length of the stacktrace for this DeadLetter

    • getId

      public String getId()

    • getJobId

      public String getJobId()
      ID of the Billing Job where this dead letter originated

    • getMessageUUID

      public String getMessageUUID()
      If this DeadLetter occurred during message transit, id of the message

    • getReceiptUUID

      public String getReceiptUUID()
      If this DeadLetter occurred during message consumption, id of message receipt

    • getSubscriptionName

      public String getSubscriptionName()
      Name of the message channel binding (subscription) where this DeadLetter originated

    • getMessagePayload

      public Object getMessagePayload()
      Payload of the central message object that kicked off the stage of the Billing Job where this DeadLetter occurred

    • getErrorMessage

      public String getErrorMessage()
      The message of the exception that caused this DeadLetter

    • getStacktrace

      public String getStacktrace()
      The stacktrace of the exception that caused this DeadLetter

    • isSupportsRetry

      public boolean isSupportsRetry()
      Whether this instance is supported by an active DeadLetterRetryHandler

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • setStacktraceMaxLength

      public void setStacktraceMaxLength(int stacktraceMaxLength)
      Maximum length of the stacktrace for this DeadLetter

    • setId

      public void setId(String id)

    • setJobId

      public void setJobId(String jobId)
      ID of the Billing Job where this dead letter originated

    • setMessageUUID

      public void setMessageUUID(String messageUUID)
      If this DeadLetter occurred during message transit, id of the message

    • setReceiptUUID

      public void setReceiptUUID(String receiptUUID)
      If this DeadLetter occurred during message consumption, id of message receipt

    • setSubscriptionName

      public void setSubscriptionName(String subscriptionName)
      Name of the message channel binding (subscription) where this DeadLetter originated

    • setMessagePayload

      public void setMessagePayload(Object messagePayload)
      Payload of the central message object that kicked off the stage of the Billing Job where this DeadLetter occurred

    • setErrorMessage

      public void setErrorMessage(String errorMessage)
      The message of the exception that caused this DeadLetter

    • setStacktrace

      public void setStacktrace(String stacktrace)
      The stacktrace of the exception that caused this DeadLetter

    • setResolutionStatus

      public void setResolutionStatus(DeadLetterResolutionStatusEnum resolutionStatus)
      Resolution status of this DeadLetter

    • setSupportsRetry

      public void setSupportsRetry(boolean supportsRetry)
      Whether this instance is supported by an active DeadLetterRetryHandler

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object