Package com.avoka.fc.core.service

Class ErrorLoggerSvc

  • public class ErrorLoggerSvc
extends Object
    Provides an ErrorLog Service.
    Since:
    5.1.3

    • Constructor Detail

      • ErrorLoggerSvc

        public ErrorLoggerSvc​(String errorType)
        Constructor of ErrorLog Service.
        Parameters:
        errorType - error type

    • Method Detail

      • addContext

        public ErrorLoggerSvc addContext​(String key,
                                 String value)
        Set a key-value entry of context message.
        Parameters:
        key - the key of the context
        value - the value of the context
        Returns:
        this error log service

      • setCause

        public ErrorLoggerSvc setCause​(Throwable cause)
        Set the throwable cause to log.
        Parameters:
        cause - the throwable cause to log
        Returns:
        this error log service

      • setContext

        public ErrorLoggerSvc setContext​(String context)
        Set the context message.
        Parameters:
        context - the context
        Returns:
        this error log service

      • setEmailQueue

        public ErrorLoggerSvc setEmailQueue​(EmailQueue emailQueue)
        Set the email queue to log.
        Parameters:
        emailQueue - the email queue to log
        Returns:
        this error log service

      • setFormXml

        public ErrorLoggerSvc setFormXml​(String formXml)
        Set the form XML to log.
        Parameters:
        formXml - the form XML to log
        Returns:
        this error log service
        Since:
        18.11.0

      • setGroovyError

        public ErrorLoggerSvc setGroovyError​(boolean groovyError)
        Set the error log to be a groovy error.
        Parameters:
        groovyError - specify whether a groovy error
        Returns:
        the error log service
        Since:
        17.1.0

      • setJobAction

        public ErrorLoggerSvc setJobAction​(JobAction jobAction)
        Set the job action to log.
        Parameters:
        jobAction - the job action to log
        Returns:
        this error log service
        Since:
        17.1.0

      • setMessage

        public ErrorLoggerSvc setMessage​(String message)
        Set the error message.
        Parameters:
        message - the error message
        Returns:
        this error log service
        Since:
        17.10.0

      • setRequest

        public ErrorLoggerSvc setRequest​(HttpServletRequest request)
        Set http servlet request.
        Parameters:
        request - http servlet request
        Returns:
        this error log service

      • setSolution

        public ErrorLoggerSvc setSolution​(String solution)
        Set an optional message outlining a solution to the problem.
        Parameters:
        solution - an optional message outlining a solution to the problem
        Returns:
        this error log service

      • setSource

        public ErrorLoggerSvc setSource​(Class source)
        Set the source class of the error.
        Parameters:
        source - the source class of the error
        Returns:
        this error log service

      • setSubmission

        public ErrorLoggerSvc setSubmission​(Submission submission)
        Set the associated submission with error
        Parameters:
        submission - the associated submission with error
        Returns:
        this error log service

      • setUserMessage

        public ErrorLoggerSvc setUserMessage​(String userMessage)
        Set the end user display message.
        Parameters:
        userMessage - the end user display message
        Returns:
        this error log service

      • log

        public ErrorLog log()
        Log an error.
        Returns:
        error log object