Package com.broadleafcommerce.common.audit.env

Class AuditProcessingProperties

java.lang.Object
com.broadleafcommerce.common.audit.env.AuditProcessingProperties
@ConfigurationProperties(prefix="broadleaf.audit.processing") public class AuditProcessingProperties extends Object
Configuration related to audit processing

  • Constructor Details

    • AuditProcessingProperties

      public AuditProcessingProperties()

  • Method Details

    • isAutoStartup

      public boolean isAutoStartup()
      Whether audit processing should begin automatically during application startup. Default is true.

    • isEnabled

      public boolean isEnabled()
      Whether audit processing is enabled. Default is false.

    • getHandlerMaxThreadCount

      public int getHandlerMaxThreadCount()
      The number of threads ChangeAuditHandler uses to process incoming DeployCompletedEvent instances. The default is 20.

    • getHandlerQueueCapacity

      public int getHandlerQueueCapacity()
      Queue capacity for the ThreadPoolTaskExecutor backing the handler thread pool. The default is 10.

    • getHandlerCoreThreadCount

      public int getHandlerCoreThreadCount()
      Core thread count for the ThreadPoolTaskExecutor backing the handler thread pool. The default is 5.

    • getEventRecorderBatchFileMaxRecordCount

      public int getEventRecorderBatchFileMaxRecordCount()
      Max number of AuditEvent records to include in a single batch file for subsequent ingestion. Default is 100.

    • getEventRecorderBatchFileCompletionTimeout

      public long getEventRecorderBatchFileCompletionTimeout()
      Duration of time (milliseconds) that should not be exceeded for a batch file to be considered complete. Normally, batch files must contain eventRecorderBatchFileMaxRecordCount records for completion. However, if left incomplete long enough (#eventRecorderBatchFileCompletionTimeout), then the partial file will be moved to the next phase for ingestion. Default is 60000.

    • getEventRecorderMaxThreadCount

      public int getEventRecorderMaxThreadCount()
      The number of threads AuditEventRecorder uses to process incoming AuditEvent instances. The default is 10.

    • getEventRecorderQueueCapacity

      public int getEventRecorderQueueCapacity()
      Queue capacity for the ThreadPoolTaskExecutor backing the event recorder thread pool. The default is 50.

    • getEventRecorderCoreThreadCount

      public int getEventRecorderCoreThreadCount()
      Core thread count for the ThreadPoolTaskExecutor backing the event recorder thread pool. The default is 3.

    • getDefaultMutationNotifyEventTypes

      public Map<String,List<Class<?>>> getDefaultMutationNotifyEventTypes()
      List of Trackable domain types by arbitrary subject name that should be audited according to the default converter behavior provided by DefaultAbstractMutationNotifyEventConverter. Additional implementations of this abstract converter may be supplied for more complex audit conversion cases.

    • getEnabledTypes

      public Map<String,Boolean> getEnabledTypes()
      Whether the conversion specified by defaultMutationNotifyEventTypes should be enabled for the given arbitrary subject name. Default is true if not specified.

    • setAutoStartup

      public void setAutoStartup(boolean autoStartup)
      Whether audit processing should begin automatically during application startup. Default is true.

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether audit processing is enabled. Default is false.

    • setHandlerMaxThreadCount

      public void setHandlerMaxThreadCount(int handlerMaxThreadCount)
      The number of threads ChangeAuditHandler uses to process incoming DeployCompletedEvent instances. The default is 20.

    • setHandlerQueueCapacity

      public void setHandlerQueueCapacity(int handlerQueueCapacity)
      Queue capacity for the ThreadPoolTaskExecutor backing the handler thread pool. The default is 10.

    • setHandlerCoreThreadCount

      public void setHandlerCoreThreadCount(int handlerCoreThreadCount)
      Core thread count for the ThreadPoolTaskExecutor backing the handler thread pool. The default is 5.

    • setEventRecorderBatchFileMaxRecordCount

      public void setEventRecorderBatchFileMaxRecordCount(int eventRecorderBatchFileMaxRecordCount)
      Max number of AuditEvent records to include in a single batch file for subsequent ingestion. Default is 100.

    • setEventRecorderBatchFileCompletionTimeout

      public void setEventRecorderBatchFileCompletionTimeout(long eventRecorderBatchFileCompletionTimeout)
      Duration of time (milliseconds) that should not be exceeded for a batch file to be considered complete. Normally, batch files must contain eventRecorderBatchFileMaxRecordCount records for completion. However, if left incomplete long enough (#eventRecorderBatchFileCompletionTimeout), then the partial file will be moved to the next phase for ingestion. Default is 60000.

    • setEventRecorderMaxThreadCount

      public void setEventRecorderMaxThreadCount(int eventRecorderMaxThreadCount)
      The number of threads AuditEventRecorder uses to process incoming AuditEvent instances. The default is 10.

    • setEventRecorderQueueCapacity

      public void setEventRecorderQueueCapacity(int eventRecorderQueueCapacity)
      Queue capacity for the ThreadPoolTaskExecutor backing the event recorder thread pool. The default is 50.

    • setEventRecorderCoreThreadCount

      public void setEventRecorderCoreThreadCount(int eventRecorderCoreThreadCount)
      Core thread count for the ThreadPoolTaskExecutor backing the event recorder thread pool. The default is 3.

    • setDefaultMutationNotifyEventTypes

      public void setDefaultMutationNotifyEventTypes(Map<String,List<Class<?>>> defaultMutationNotifyEventTypes)
      List of Trackable domain types by arbitrary subject name that should be audited according to the default converter behavior provided by DefaultAbstractMutationNotifyEventConverter. Additional implementations of this abstract converter may be supplied for more complex audit conversion cases.

    • setEnabledTypes

      public void setEnabledTypes(Map<String,Boolean> enabledTypes)
      Whether the conversion specified by defaultMutationNotifyEventTypes should be enabled for the given arbitrary subject name. Default is true if not specified.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object