java.lang.Object
- com.avoka.fc.core.service.impl.SystemEventPublisher

All Implemented Interfaces:

IServiceDefinitionAware, ISysEventPublisher
```
public class SystemEventPublisher
extends Object
implements ISysEventPublisher, IServiceDefinitionAware
```
Provides a implementation of ISysEventPublisher for the System Event Publisher Used to publish system event messages.

Since:

18.5.0

Field Summary

Fields
Modifier and Type Field Description

static String SERVICE_NAME

Constructor Summary

Constructors
Constructor Description

SystemEventPublisher()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAuditLogQueue()`	Return the job publishing queue override, if not using default queue name.
`String`	`getJobQueue()`	Return the job publishing queue override, if not using default queue name.
`ServiceDefinition`	`getServiceDefinition()`	Return the service definition for the service.
`String`	`getSubmissionQueue()`	Return the submission publishing queue override, if not using default queue name.
`String`	`getSystemHealthQueue()`	Return the system health publishing queue override, if not using default queue name.
`String`	`getUserAuthQueue()`	Return the user auth publishing queue override, if not using default queue name.
`boolean`	`isAuditLogPublish()`	Return true if audit log messages should be published
`boolean`	`isJobPublish()`	Return true if job messages should be published
`boolean`	`isSubmissionErrorLogPublish()`
`boolean`	`isSubmissionEventLogPublish()`
`boolean`	`isSubmissionFormDataMapPublish()`
`boolean`	`isSubmissionGroovyLogDataPublish()`
`boolean`	`isSubmissionGroovyLogPublish()`
`boolean`	`isSubmissionMilestonePublish()`
`boolean`	`isSubmissionPropertyPublish()`
`boolean`	`isSubmissionPublish()`
`boolean`	`isSubmissionRequestLogPublish()`
`boolean`	`isSystemHealthPublish()`
`boolean`	`isUserAuthPublish()`
`void`	`publish(String msg, ServletContext servletContext)`	Publish the JSON messages to the remote service.
`void`	`setAuditLogPublish(boolean auditLogPublish)`	Set whether audit log messages should be published.
`void`	`setAuditLogQueue(String auditLogQueue)`	Set the audit log publishing queue override, if not using default queue name.
`void`	`setJobPublish(boolean jobPublish)`	Set if the job messages should be published.
`void`	`setJobQueue(String jobQueue)`	Set the job publishing queue override, if not using default queue name.
`void`	`setServiceDefinition(ServiceDefinition serviceDefinition)`	Set the service definition for the service.
`void`	`setSubmissionErrorLogPublish(boolean publish)`	Set if new submission error log should be published.
`void`	`setSubmissionEventLogPublish(boolean publish)`	Set if new submission event log should be published.
`void`	`setSubmissionFormDataMapPublish(boolean publish)`	Set if submission form data map should be published.
`void`	`setSubmissionGroovyLogDataPublish(boolean publish)`	Set if new submission groovy service log data should be published.
`void`	`setSubmissionGroovyLogPublish(boolean publish)`	Set if new submission groovy service log should be published.
`void`	`setSubmissionMilestonePublish(boolean publish)`	Set if new submission milestones should be pub.
`void`	`setSubmissionPropertyPublish(boolean publish)`	Set if new submission properties should be published.
`void`	`setSubmissionPublish(boolean publish)`	Set if submissions changes should be published.
`void`	`setSubmissionQueue(String submissionQueue)`	Set the submission publishing queue override, if not using default queue name.
`void`	`setSubmissionRequestLogPublish(boolean publish)`	Set if new submission request log records should be published.
`void`	`setSystemHealthPublish(Boolean publish)`	Set if system health records should be published.
`void`	`setSystemHealthQueue(String systemHealthQueue)`	Set the system health publishing queue override, if not using default queue name.
`void`	`setUserAuthPublish(Boolean publish)`	Set if user auth records should be published.
`void`	`setUserAuthQueue(String userAuthQueue)`	Set the user auth publishing queue override, if not using default queue name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE_NAME
```
public static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SystemEventPublisher
```
public SystemEventPublisher()
```
- Method Detail
  - publish
```
public void publish(String msg,
                    ServletContext servletContext)
```
    Publish the JSON messages to the remote service.
    
    Specified by:
    
    publish in interface ISysEventPublisher
    
    Parameters:
    
    msg - JSON string messages to be published.
    
    servletContext - the servletContext
  - isAuditLogPublish
```
public boolean isAuditLogPublish()
```
    Return true if audit log messages should be published
    
    Specified by:
    
    isAuditLogPublish in interface ISysEventPublisher
    
    Returns:
    
    boolean if audit log message should be published
  - setAuditLogPublish
```
public void setAuditLogPublish(boolean auditLogPublish)
```
    Set whether audit log messages should be published.
    
    Parameters:
    
    auditLogPublish - the audit log publish flag
  - getAuditLogQueue
```
public String getAuditLogQueue()
```
    Return the job publishing queue override, if not using default queue name.
    
    Specified by:
    
    getAuditLogQueue in interface ISysEventPublisher
    
    Returns:
    
    jobQueue string or default queue if jobQueue is not specified.
  - setAuditLogQueue
```
public void setAuditLogQueue(String auditLogQueue)
```
    Set the audit log publishing queue override, if not using default queue name.
    
    Parameters:
    
    auditLogQueue - the jauditLogQueue to set.
  - isJobPublish
```
public boolean isJobPublish()
```
    Description copied from interface: ISysEventPublisher
    
    Return true if job messages should be published
    
    Specified by:
    
    isJobPublish in interface ISysEventPublisher
    
    Returns:
    
    JobPublish Boolean if job message should be published.
  - setJobPublish
```
public void setJobPublish(boolean jobPublish)
```
    Set if the job messages should be published.
    
    Parameters:
    
    jobPublish - the jobPublish to set.
  - getJobQueue
```
public String getJobQueue()
```
    Return the job publishing queue override, if not using default queue name.
    
    Specified by:
    
    getJobQueue in interface ISysEventPublisher
    
    Returns:
    
    jobQueue string or default queue if jobQueue is not specified.
  - setJobQueue
```
public void setJobQueue(String jobQueue)
```
    Set the job publishing queue override, if not using default queue name.
    
    Parameters:
    
    jobQueue - the jobQueue to set.
  - isSubmissionPublish
```
public boolean isSubmissionPublish()
```
    Specified by:
    
    isSubmissionPublish in interface ISysEventPublisher
    
    Returns:
    
    true if submission changes should be published.
  - setSubmissionPublish
```
public void setSubmissionPublish(boolean publish)
```
    Set if submissions changes should be published.
    
    Parameters:
    
    publish - specify whether to publish submissions
  - isSubmissionFormDataMapPublish
```
public boolean isSubmissionFormDataMapPublish()
```
    Specified by:
    
    isSubmissionFormDataMapPublish in interface ISysEventPublisher
    
    Returns:
    
    true if the submission formDataMap should be published.
  - setSubmissionFormDataMapPublish
```
public void setSubmissionFormDataMapPublish(boolean publish)
```
    Set if submission form data map should be published.
    
    Parameters:
    
    publish - specify whether to publish submission formDataMap
  - isSubmissionMilestonePublish
```
public boolean isSubmissionMilestonePublish()
```
    Specified by:
    
    isSubmissionMilestonePublish in interface ISysEventPublisher
    
    Returns:
    
    true if new submission milestones should be published.
  - setSubmissionMilestonePublish
```
public void setSubmissionMilestonePublish(boolean publish)
```
    Set if new submission milestones should be pub.
    
    Parameters:
    
    publish - specify whether to publish submission milestones
  - isSubmissionPropertyPublish
```
public boolean isSubmissionPropertyPublish()
```
    Specified by:
    
    isSubmissionPropertyPublish in interface ISysEventPublisher
    
    Returns:
    
    true if new submission properties should be published.
  - setSubmissionPropertyPublish
```
public void setSubmissionPropertyPublish(boolean publish)
```
    Set if new submission properties should be published.
    
    Parameters:
    
    publish - specify whether to publish submission properties
  - isSubmissionErrorLogPublish
```
public boolean isSubmissionErrorLogPublish()
```
    Specified by:
    
    isSubmissionErrorLogPublish in interface ISysEventPublisher
    
    Returns:
    
    true if new submission error log should be published.
  - setSubmissionErrorLogPublish
```
public void setSubmissionErrorLogPublish(boolean publish)
```
    Set if new submission error log should be published.
    
    Parameters:
    
    publish - specify whether to publish submission error logs
  - isSubmissionEventLogPublish
```
public boolean isSubmissionEventLogPublish()
```
    Specified by:
    
    isSubmissionEventLogPublish in interface ISysEventPublisher
    
    Returns:
    
    true if new submission event log should be published.
  - setSubmissionEventLogPublish
```
public void setSubmissionEventLogPublish(boolean publish)
```
    Set if new submission event log should be published.
    
    Parameters:
    
    publish - specify whether to publish submission event logs
  - isSubmissionGroovyLogPublish
```
public boolean isSubmissionGroovyLogPublish()
```
    Specified by:
    
    isSubmissionGroovyLogPublish in interface ISysEventPublisher
    
    Returns:
    
    true if new submission groovy service log should be published.
  - setSubmissionGroovyLogPublish
```
public void setSubmissionGroovyLogPublish(boolean publish)
```
    Set if new submission groovy service log should be published.
    
    Parameters:
    
    publish - specify whether to publish submission groovy logs
  - isSubmissionGroovyLogDataPublish
```
public boolean isSubmissionGroovyLogDataPublish()
```
    Specified by:
    
    isSubmissionGroovyLogDataPublish in interface ISysEventPublisher
    
    Returns:
    
    true if new submission groovy service log data should be published.
  - setSubmissionGroovyLogDataPublish
```
public void setSubmissionGroovyLogDataPublish(boolean publish)
```
    Set if new submission groovy service log data should be published.
    
    Parameters:
    
    publish - specify whether to publish submission groovy log data
  - isSubmissionRequestLogPublish
```
public boolean isSubmissionRequestLogPublish()
```
    Specified by:
    
    isSubmissionRequestLogPublish in interface ISysEventPublisher
    
    Returns:
    
    true if the submission request log should be published
  - setSubmissionRequestLogPublish
```
public void setSubmissionRequestLogPublish(boolean publish)
```
    Set if new submission request log records should be published.
    
    Parameters:
    
    publish - specify whether to publish submission request log records
  - getSubmissionQueue
```
public String getSubmissionQueue()
```
    Return the submission publishing queue override, if not using default queue name.
    
    Specified by:
    
    getSubmissionQueue in interface ISysEventPublisher
    
    Returns:
    
    submissionQueue string or default queue if submissionQueue is not specified.
  - setSubmissionQueue
```
public void setSubmissionQueue(String submissionQueue)
```
    Set the submission publishing queue override, if not using default queue name.
    
    Parameters:
    
    submissionQueue - the SubmissionQueue to set.
  - isSystemHealthPublish
```
public boolean isSystemHealthPublish()
```
    Specified by:
    
    isSystemHealthPublish in interface ISysEventPublisher
    
    Returns:
    
    true if system health records should be published.
  - setSystemHealthPublish
```
public void setSystemHealthPublish(Boolean publish)
```
    Set if system health records should be published.
    
    Parameters:
    
    publish - specify whether to publish system health records
  - getSystemHealthQueue
```
public String getSystemHealthQueue()
```
    Return the system health publishing queue override, if not using default queue name.
    
    Specified by:
    
    getSystemHealthQueue in interface ISysEventPublisher
    
    Returns:
    
    systemHealthQueue string or default queue if systemHealthQueue is not specified.
  - setSystemHealthQueue
```
public void setSystemHealthQueue(String systemHealthQueue)
```
    Set the system health publishing queue override, if not using default queue name.
    
    Parameters:
    
    systemHealthQueue - the systemHealthQueue to set.
  - isUserAuthPublish
```
public boolean isUserAuthPublish()
```
    Specified by:
    
    isUserAuthPublish in interface ISysEventPublisher
    
    Returns:
    
    true if user auth records should be published.
  - setUserAuthPublish
```
public void setUserAuthPublish(Boolean publish)
```
    Set if user auth records should be published.
    
    Parameters:
    
    publish - specify whether to publish user auth records
  - getUserAuthQueue
```
public String getUserAuthQueue()
```
    Return the user auth publishing queue override, if not using default queue name.
    
    Specified by:
    
    getUserAuthQueue in interface ISysEventPublisher
    
    Returns:
    
    userAuthQueue string or default queue if userAuthQueue is not specified.
  - setUserAuthQueue
```
public void setUserAuthQueue(String userAuthQueue)
```
    Set the user auth publishing queue override, if not using default queue name.
    
    Parameters:
    
    userAuthQueue - the userAuthQueue to set.
  - getServiceDefinition
```
public ServiceDefinition getServiceDefinition()
```
    Return the service definition for the service.
    
    Specified by:
    
    getServiceDefinition in interface IServiceDefinitionAware
    
    Returns:
    
    the service definition for the service.
  - setServiceDefinition
```
public void setServiceDefinition(ServiceDefinition serviceDefinition)
```
    Set the service definition for the service.
    
    Specified by:
    
    setServiceDefinition in interface IServiceDefinitionAware
    
    Parameters:
    
    serviceDefinition - the service definition for the service.

Class SystemEventPublisher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE_NAME

Constructor Detail

SystemEventPublisher

Method Detail

publish

isAuditLogPublish

setAuditLogPublish

getAuditLogQueue

setAuditLogQueue

isJobPublish

setJobPublish

getJobQueue

setJobQueue

isSubmissionPublish

setSubmissionPublish

isSubmissionFormDataMapPublish

setSubmissionFormDataMapPublish

isSubmissionMilestonePublish

setSubmissionMilestonePublish

isSubmissionPropertyPublish

setSubmissionPropertyPublish

isSubmissionErrorLogPublish

setSubmissionErrorLogPublish

isSubmissionEventLogPublish

setSubmissionEventLogPublish

isSubmissionGroovyLogPublish

setSubmissionGroovyLogPublish

isSubmissionGroovyLogDataPublish

setSubmissionGroovyLogDataPublish

isSubmissionRequestLogPublish

setSubmissionRequestLogPublish

getSubmissionQueue

setSubmissionQueue

isSystemHealthPublish

setSystemHealthPublish

getSystemHealthQueue

setSystemHealthQueue

isUserAuthPublish

setUserAuthPublish

getUserAuthQueue

setUserAuthQueue

getServiceDefinition

setServiceDefinition