Class ExceptionMessageDefinition


  • public class ExceptionMessageDefinition
    extends MessageDefinition
    ExceptionMessageDefinition extends MessageDefinition to provide a container that describes a single instance of a message for an exception.
    • Constructor Detail

      • ExceptionMessageDefinition

        public ExceptionMessageDefinition​(int httpErrorCode,
                                          java.lang.String messageId,
                                          java.lang.String messageTemplate,
                                          java.lang.String systemAction,
                                          java.lang.String userAction)
        Constructor to save all the fixed values of a message. This is typically populated from an Enum message set. The constructor passes most values to the super class and just retains the additional value for the exception.
        Parameters:
        httpErrorCode - the HTTP code that describes the nature of the error
        messageId - unique Id for the message
        messageTemplate - text for the message
        systemAction - description of the action taken by the system when the condition happened
        userAction - instructions for resolving the situation, if any
    • Method Detail

      • getHttpErrorCode

        public int getHttpErrorCode()
        Return the HTTP code that describes the nature of the exception.
        Returns:
        integer code
      • toString

        public java.lang.String toString()
        JSON-style toString.
        Overrides:
        toString in class MessageDefinition
        Returns:
        list of properties and their values.