Interface ISysEventPublisher

  • All Known Implementing Classes:
    SystemEventPublisher

    public interface ISysEventPublisher
    Provides a System Event Publisher interface which is used to publish system event messages
    Since:
    18.5.0
    • Method Detail

      • publish

        void publish​(String msg,
                     ServletContext servletContext)
        Parameters:
        msg - JSON string messages to be published
      • isAuditLogPublish

        boolean isAuditLogPublish()
        Return true if audit log messages should be published
        Returns:
        boolean if audit log message should be published
      • getAuditLogQueue

        String getAuditLogQueue()
        Returns:
        AuditLogQueue string or default queue if AuditLogQueue is not specified
      • isJobPublish

        boolean isJobPublish()
        Return true if job messages should be published
        Returns:
        boolean if job message should be published
      • isSubmissionPublish

        boolean isSubmissionPublish()
        Returns:
        boolean if submission changes should be published
      • isSubmissionFormDataMapPublish

        boolean isSubmissionFormDataMapPublish()
        Returns:
        boolean if the submission formDataMap should be published along with
      • isSubmissionErrorLogPublish

        boolean isSubmissionErrorLogPublish()
        Returns:
        boolean if new submission error service log should be published.
      • isSubmissionEventLogPublish

        boolean isSubmissionEventLogPublish()
        Returns:
        boolean if new submission event service log should be published.
      • isSubmissionMilestonePublish

        boolean isSubmissionMilestonePublish()
        Returns:
        boolean if new submission milestones should be published
      • isSubmissionPropertyPublish

        boolean isSubmissionPropertyPublish()
        Returns:
        boolean if new submission properties should be published
      • isSubmissionGroovyLogPublish

        boolean isSubmissionGroovyLogPublish()
        Returns:
        boolean if new submission groovy service log should be published
      • isSubmissionGroovyLogDataPublish

        boolean isSubmissionGroovyLogDataPublish()
        Returns:
        boolean if new submission groovy service log data should be published
      • isSubmissionRequestLogPublish

        boolean isSubmissionRequestLogPublish()
        Returns:
        boolean if new submission request log should be published
      • isSystemHealthPublish

        boolean isSystemHealthPublish()
        Returns:
        boolean if system health records should be published
      • isUserAuthPublish

        boolean isUserAuthPublish()
        Returns:
        boolean if user authentication event should be published
      • getJobQueue

        String getJobQueue()
        Returns:
        JobQueue string or default queue if JobQueue is not specified
      • getSubmissionQueue

        String getSubmissionQueue()
        Returns:
        SubmissionQueue string or default queue if SubmissionQueue is not specified
      • getSystemHealthQueue

        String getSystemHealthQueue()
        Returns:
        SystemHealthQueue string or default queue if SystemHealthQueue is not specified
      • getUserAuthQueue

        String getUserAuthQueue()
        Returns:
        UserAuthQueue string or default queue if UserAuthQueue is not specified