Class FFDCResponseBase

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Return comparison result based on the content of the properties.
      java.lang.String getActionDescription()
      Return the description of the action in progress when the exception occurred.
      java.lang.String getExceptionCausedBy()
      Return the name of any nested exception that may indicate the root cause of the exception.
      java.lang.String getExceptionClassName()
      Return the name of the Java class name to use to recreate the exception.
      java.lang.String getExceptionErrorMessage()
      Return the error message associated with the exception.
      java.lang.String getExceptionErrorMessageId()
      Return the formal message identifier for the error message.
      java.lang.String[] getExceptionErrorMessageParameters()
      Return the parameters that were inserted in the error message.
      java.util.Map<java.lang.String,​java.lang.Object> getExceptionProperties()
      Return the additional properties stored by the exceptions.
      java.lang.String getExceptionSystemAction()
      Return the description of the action taken by the system as a result of the exception.
      java.lang.String getExceptionUserAction()
      Return the action that a user should take to resolve the problem.
      int getRelatedHTTPCode()
      Return the HTTP Code to use if forwarding response to HTTP client.
      int hashCode()
      Return hash code for this object
      void setActionDescription​(java.lang.String actionDescription)
      Set up the description of the activity in progress when the exception occurred.
      void setExceptionCausedBy​(java.lang.String exceptionCausedBy)
      Set up the name of any nested exception that may indicate the root cause of the exception.
      void setExceptionClassName​(java.lang.String exceptionClassName)
      Set up the name of the Java class name to use to recreate the exception.
      void setExceptionErrorMessage​(java.lang.String exceptionErrorMessage)
      Set up the error message associated with the exception.
      void setExceptionErrorMessageId​(java.lang.String exceptionErrorMessageId)
      Set up the formal message identifier for the error message.
      void setExceptionErrorMessageParameters​(java.lang.String[] exceptionErrorMessageParameters)
      Set up the list of parameters inserted in to the error message.
      void setExceptionProperties​(java.util.Map<java.lang.String,​java.lang.Object> exceptionProperties)
      Set up the additional properties stored by the exceptions.
      void setExceptionSystemAction​(java.lang.String exceptionSystemAction)
      Set up the description of the action taken by the system as a result of the exception.
      void setExceptionUserAction​(java.lang.String exceptionUserAction)
      Set up the action that a user should take to resolve the problem.
      void setRelatedHTTPCode​(int relatedHTTPCode)
      Set up the HTTP Code to use if forwarding response to HTTP client.
      java.lang.String toString()
      JSON-like toString
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • FFDCResponseBase

        public FFDCResponseBase()
        Default constructor
      • FFDCResponseBase

        public FFDCResponseBase​(FFDCResponseBase template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getExceptionClassName

        public java.lang.String getExceptionClassName()
        Description copied from interface: FFDCResponse
        Return the name of the Java class name to use to recreate the exception.
        Specified by:
        getExceptionClassName in interface FFDCResponse
        Returns:
        String name of the fully-qualified java class name
      • setExceptionClassName

        public void setExceptionClassName​(java.lang.String exceptionClassName)
        Description copied from interface: FFDCResponse
        Set up the name of the Java class name to use to recreate the exception.
        Specified by:
        setExceptionClassName in interface FFDCResponse
        Parameters:
        exceptionClassName - - String name of the fully-qualified java class name
      • getExceptionCausedBy

        public java.lang.String getExceptionCausedBy()
        Description copied from interface: FFDCResponse
        Return the name of any nested exception that may indicate the root cause of the exception.
        Specified by:
        getExceptionCausedBy in interface FFDCResponse
        Returns:
        exception class name
      • setExceptionCausedBy

        public void setExceptionCausedBy​(java.lang.String exceptionCausedBy)
        Description copied from interface: FFDCResponse
        Set up the name of any nested exception that may indicate the root cause of the exception.
        Specified by:
        setExceptionCausedBy in interface FFDCResponse
        Parameters:
        exceptionCausedBy - exception class name
      • getActionDescription

        public java.lang.String getActionDescription()
        Description copied from interface: FFDCResponse
        Return the description of the action in progress when the exception occurred.
        Specified by:
        getActionDescription in interface FFDCResponse
        Returns:
        string description
      • setActionDescription

        public void setActionDescription​(java.lang.String actionDescription)
        Description copied from interface: FFDCResponse
        Set up the description of the activity in progress when the exception occurred.
        Specified by:
        setActionDescription in interface FFDCResponse
        Parameters:
        actionDescription - string description
      • getRelatedHTTPCode

        public int getRelatedHTTPCode()
        Description copied from interface: FFDCResponse
        Return the HTTP Code to use if forwarding response to HTTP client.
        Specified by:
        getRelatedHTTPCode in interface FFDCResponse
        Returns:
        integer HTTP status code
      • setRelatedHTTPCode

        public void setRelatedHTTPCode​(int relatedHTTPCode)
        Description copied from interface: FFDCResponse
        Set up the HTTP Code to use if forwarding response to HTTP client.
        Specified by:
        setRelatedHTTPCode in interface FFDCResponse
        Parameters:
        relatedHTTPCode - - integer HTTP status code
      • getExceptionErrorMessage

        public java.lang.String getExceptionErrorMessage()
        Description copied from interface: FFDCResponse
        Return the error message associated with the exception.
        Specified by:
        getExceptionErrorMessage in interface FFDCResponse
        Returns:
        string error message
      • setExceptionErrorMessage

        public void setExceptionErrorMessage​(java.lang.String exceptionErrorMessage)
        Description copied from interface: FFDCResponse
        Set up the error message associated with the exception.
        Specified by:
        setExceptionErrorMessage in interface FFDCResponse
        Parameters:
        exceptionErrorMessage - - string error message
      • getExceptionErrorMessageId

        public java.lang.String getExceptionErrorMessageId()
        Description copied from interface: FFDCResponse
        Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
        Specified by:
        getExceptionErrorMessageId in interface FFDCResponse
        Returns:
        string identifier
      • setExceptionErrorMessageId

        public void setExceptionErrorMessageId​(java.lang.String exceptionErrorMessageId)
        Description copied from interface: FFDCResponse
        Set up the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
        Specified by:
        setExceptionErrorMessageId in interface FFDCResponse
        Parameters:
        exceptionErrorMessageId - string identifier
      • getExceptionErrorMessageParameters

        public java.lang.String[] getExceptionErrorMessageParameters()
        Description copied from interface: FFDCResponse
        Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
        Specified by:
        getExceptionErrorMessageParameters in interface FFDCResponse
        Returns:
        list of strings
      • setExceptionErrorMessageParameters

        public void setExceptionErrorMessageParameters​(java.lang.String[] exceptionErrorMessageParameters)
        Description copied from interface: FFDCResponse
        Set up the list of parameters inserted in to the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
        Specified by:
        setExceptionErrorMessageParameters in interface FFDCResponse
        Parameters:
        exceptionErrorMessageParameters - list of strings
      • getExceptionSystemAction

        public java.lang.String getExceptionSystemAction()
        Description copied from interface: FFDCResponse
        Return the description of the action taken by the system as a result of the exception.
        Specified by:
        getExceptionSystemAction in interface FFDCResponse
        Returns:
        - string description of the action taken
      • setExceptionSystemAction

        public void setExceptionSystemAction​(java.lang.String exceptionSystemAction)
        Description copied from interface: FFDCResponse
        Set up the description of the action taken by the system as a result of the exception.
        Specified by:
        setExceptionSystemAction in interface FFDCResponse
        Parameters:
        exceptionSystemAction - - string description of the action taken
      • getExceptionUserAction

        public java.lang.String getExceptionUserAction()
        Description copied from interface: FFDCResponse
        Return the action that a user should take to resolve the problem.
        Specified by:
        getExceptionUserAction in interface FFDCResponse
        Returns:
        string instructions
      • setExceptionUserAction

        public void setExceptionUserAction​(java.lang.String exceptionUserAction)
        Description copied from interface: FFDCResponse
        Set up the action that a user should take to resolve the problem.
        Specified by:
        setExceptionUserAction in interface FFDCResponse
        Parameters:
        exceptionUserAction - - string instructions
      • getExceptionProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getExceptionProperties()
        Description copied from interface: FFDCResponse
        Return the additional properties stored by the exceptions.
        Specified by:
        getExceptionProperties in interface FFDCResponse
        Returns:
        property map
      • setExceptionProperties

        public void setExceptionProperties​(java.util.Map<java.lang.String,​java.lang.Object> exceptionProperties)
        Description copied from interface: FFDCResponse
        Set up the additional properties stored by the exceptions.
        Specified by:
        setExceptionProperties in interface FFDCResponse
        Parameters:
        exceptionProperties - property map
      • toString

        public java.lang.String toString()
        JSON-like toString
        Overrides:
        toString in class java.lang.Object
        Returns:
        string containing the property names and values
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Return comparison result based on the content of the properties.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - test object
        Returns:
        result of comparison
      • hashCode

        public int hashCode()
        Return hash code for this object
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int hash code