Package com.avoka.fc.core.service
Class ErrorLoggerSvc
java.lang.Object
com.avoka.fc.core.service.ErrorLoggerSvc
Provides an ErrorLog Service.
- Since:
- 5.1.3
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddContext
(String key, String value) Set a key-value entry of context message.log()
Log an error.Set the throwable cause to log.setContext
(String context) Set the context message.setEmailQueue
(EmailQueue emailQueue) Set the email queue to log.setFormXml
(String formXml) Set the form XML to log.setGroovyError
(boolean groovyError) Set the error log to be a groovy error.setJobAction
(JobAction jobAction) Set the job action to log.setMessage
(String message) Set the error message.setRequest
(jakarta.servlet.http.HttpServletRequest request) Set http servlet request.setSolution
(String solution) Set an optional message outlining a solution to the problem.Set the source class of the error.setSubmission
(Submission submission) Set the associated submission with errorsetUserMessage
(String userMessage) Set the end user display message.
-
Constructor Details
-
ErrorLoggerSvc
Constructor of ErrorLog Service.- Parameters:
errorType
- error type
-
-
Method Details
-
addContext
Set a key-value entry of context message.- Parameters:
key
- the key of the contextvalue
- the value of the context- Returns:
- this error log service
-
setCause
Set the throwable cause to log.- Parameters:
cause
- the throwable cause to log- Returns:
- this error log service
-
setContext
Set the context message.- Parameters:
context
- the context- Returns:
- this error log service
-
setEmailQueue
Set the email queue to log.- Parameters:
emailQueue
- the email queue to log- Returns:
- this error log service
-
setFormXml
Set the form XML to log.- Parameters:
formXml
- the form XML to log- Returns:
- this error log service
- Since:
- 18.11.0
-
setGroovyError
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
Set the job action to log.- Parameters:
jobAction
- the job action to log- Returns:
- this error log service
- Since:
- 17.1.0
-
setMessage
Set the error message.- Parameters:
message
- the error message- Returns:
- this error log service
- Since:
- 17.10.0
-
setRequest
Set http servlet request.- Parameters:
request
- http servlet request- Returns:
- this error log service
-
setSolution
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
Set the source class of the error.- Parameters:
source
- the source class of the error- Returns:
- this error log service
-
setSubmission
Set the associated submission with error- Parameters:
submission
- the associated submission with error- Returns:
- this error log service
-
setUserMessage
Set the end user display message.- Parameters:
userMessage
- the end user display message- Returns:
- this error log service
-
log
Log an error.- Returns:
- error log object
-