Class EventLogService


  • public class EventLogService
    extends BaseService
    Provides event log service including error, warning and info events.
    • Constructor Detail

      • EventLogService

        public EventLogService()
    • Method Detail

      • logErrorEvent

        public void logErrorEvent​(String message)
        Log a error event with the given message.
        Parameters:
        message - error message
      • logErrorEvent

        public void logErrorEvent​(String messageFormat,
                                  Object[] args)
        Log a error event with the given message.
        Parameters:
        messageFormat - the error message format
        args - the message arguments
      • logErrorEvent

        public void logErrorEvent​(String messageFormat,
                                  Object[] args,
                                  Submission submission)
        Log a error event with the given message format, arguements and submission.
        Parameters:
        messageFormat - the error message format
        args - the message arguments
        submission - the form submission
        Since:
        3.6.0
      • logErrorEvent

        public void logErrorEvent​(String messageFormat,
                                  Object[] args,
                                  EmailQueue emailQueue)
        Log a error event with the given message and associate with the Email Queue item.
        Parameters:
        messageFormat - the error message format
        args - the message arguments
        emailQueue - the email queue that the message is put on to
      • logErrorEvent

        public void logErrorEvent​(String message,
                                  EmailQueue emailQueue)
        Log a error event with the given message and associate with the Email Queue item.
        Parameters:
        message - the error message to log
        emailQueue - the email queue that the message is put on to
        Since:
        5.0.0
      • logErrorEvent

        public void logErrorEvent​(String message,
                                  HttpServletRequest request)
        Log a warn error with the given message and servlet request.
        Parameters:
        message - the warn message to log
        request - the servlet request to log
        Since:
        4.3.2
      • logErrorEvent

        public void logErrorEvent​(String message,
                                  Submission submission)
        Log a error event with the given message and associated submission.
        Parameters:
        message - error message
        submission - the associated submission
      • logErrorEvent

        public void logErrorEvent​(String message,
                                  Submission submission,
                                  HttpServletRequest request)
        Log a error event with the given message and associated submission.
        Parameters:
        message - error message
        submission - the associated submission
        request - the servlet request
        Since:
        4.3.2
      • logErrorEvent

        public void logErrorEvent​(String message,
                                  Submission submission,
                                  HttpServletRequest request,
                                  boolean writeToLogger)
        Log a error event with the given message and associated submission.
        Parameters:
        message - error message
        submission - the associated submission
        request - the servlet request
        writeToLogger - specify whether to write to the server log file
        Since:
        5.0.0
      • logWarnEvent

        public void logWarnEvent​(String message)
        Log a warning event with the given message.
        Parameters:
        message - error message
      • logWarnEvent

        public void logWarnEvent​(String messageFormat,
                                 Object[] args)
        Log a warning event with the given message.
        Parameters:
        messageFormat - the warning message format
        args - the message arguments
      • logWarnEvent

        public void logWarnEvent​(String message,
                                 HttpServletRequest request)
        Log a warn event with the given message and servlet request.
        Parameters:
        message - the warn message to log
        request - the servlet request to log
        Since:
        4.3.2
      • logWarnEvent

        public void logWarnEvent​(String message,
                                 Submission submission)
        Log a warning event with the given message and associated submission.
        Parameters:
        message - warning message
        submission - the associated submission
      • logWarnEvent

        public void logWarnEvent​(String message,
                                 Submission submission,
                                 HttpServletRequest request)
        Log a warning event with the given message and associated submission.
        Parameters:
        message - warning message
        submission - the associated submission
        request - the servlet request
        Since:
        4.3.2
      • logWarnEvent

        public void logWarnEvent​(String message,
                                 Submission submission,
                                 HttpServletRequest request,
                                 boolean writeToLogger)
        Log a warning event with the given message and associated submission.
        Parameters:
        message - warning message
        submission - the associated submission
        request - the servlet request
        writeToLogger - specify whether to write to the server log file
        Since:
        5.0.0
      • logInfoEvent

        public void logInfoEvent​(String message)
        Log an info event with the given message.
        Parameters:
        message - info message
      • logInfoEvent

        public void logInfoEvent​(String messageFormat,
                                 Object[] args)
        Log a info event with the given message.
        Parameters:
        messageFormat - the info message format
        args - the message arguments
      • logInfoEvent

        public void logInfoEvent​(String messageFormat,
                                 Object[] args,
                                 Submission submission)
        Log a info event with the given message and associate with the submission.
        Parameters:
        messageFormat - the info message format
        args - the message arguments
        submission - the associated submission
      • logInfoEvent

        public void logInfoEvent​(String message,
                                 HttpServletRequest request)
        Log a info event with the given message and servlet request.
        Parameters:
        message - the warn message to log
        request - the servlet request to log
        Since:
        4.3.2
      • logInfoEvent

        public void logInfoEvent​(String message,
                                 Submission submission)
        Log an info event with the given message and associated submission.
        Parameters:
        message - info message
        submission - the associated submission
      • logInfoEvent

        public void logInfoEvent​(String message,
                                 Submission submission,
                                 HttpServletRequest request)
        Log an info event with the given message and associated submission.
        Parameters:
        message - info message
        submission - the associated submission
        request - the servlet request
        Since:
        4.3.2
      • logInfoEvent

        public void logInfoEvent​(String message,
                                 Submission submission,
                                 HttpServletRequest request,
                                 boolean writeToLogger)
        Log an info event with the given message and associated submission.
        Parameters:
        message - info message
        submission - the associated submission
        request - the servlet request
        writeToLogger - specify whether to write to the server log file
        Since:
        4.3.3
      • logInfoEvent

        @Deprecated
        public void logInfoEvent​(String message,
                                 EmailQueue emailQueue)
        Deprecated.
        Log an info event with the given message and associated email queue.
        Parameters:
        message - info message
        emailQueue - the email queue that the the message is put on to
      • logSecurityEvent

        public void logSecurityEvent​(String message)
        Log a security event with the given message.
        Parameters:
        message - error message
      • logSecurityEvent

        public void logSecurityEvent​(String message,
                                     boolean writeToLogger)
        Log a security event with the given message.
        Parameters:
        message - error message
        writeToLogger - write the message to the server log file
        Since:
        4.2.0
      • logSecurityEvent

        public void logSecurityEvent​(String message,
                                     HttpServletRequest request)
        Log a security event with the given message and servlet request.
        Parameters:
        message - the warn message to log
        request - the servlet request to log
        Since:
        4.3.2
      • logSecurityEvent

        public void logSecurityEvent​(String message,
                                     Submission submission)
        Log a security event with the given message and for the given submission.
        Parameters:
        message - error message
        submission - the submission
      • logSecurityEvent

        public void logSecurityEvent​(String message,
                                     Submission submission,
                                     boolean writeToLogger)
        Log a security event with the given message and for the given submission.
        Parameters:
        message - error message
        submission - the submission
        writeToLogger - specify whether to write to the server log file
        Since:
        4.3.3
      • logSecurityEvent

        public void logSecurityEvent​(String message,
                                     Submission submission,
                                     HttpServletRequest request)
        Log a security event with the given message and for the given submission.
        Parameters:
        message - error message
        submission - the submission
        request - the servlet request
      • logSecurityEvent

        public void logSecurityEvent​(String message,
                                     Submission submission,
                                     HttpServletRequest request,
                                     boolean writeToLogger)
        Log a security event with the given message and for the given submission.
        Parameters:
        message - error message
        submission - the submission
        request - the servlet request
        writeToLogger - specify whether to write to the server log file
      • logSecurityEvent

        public void logSecurityEvent​(String messageFormat,
                                     Object[] args)
        Log a security event with the given message.
        Parameters:
        messageFormat - the error message format
        args - the message arguments
      • logEvent

        protected void logEvent​(String type,
                                String message,
                                Submission submission,
                                boolean writeToLogger)