Package com.broadleafcommerce.common.audit.env

Class FileSystemStorageProviderProperties

java.lang.Object
com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties
@ConfigurationProperties(prefix="broadleaf.audit.processing.storage.filesystem") public class FileSystemStorageProviderProperties extends Object
Config related to the FileSystemStorageProvider. Assumes the target directories provided exist on a shared filesystem across the entire application cluster. This allows many microservices to contribute to audit recording with final ingestion into the audit service and its bounded context of audit data.

  • Constructor Details

    • FileSystemStorageProviderProperties

      public FileSystemStorageProviderProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Whether audit file system storage is enabled. Default is false.

    • getWorkingDirectory

      public String getWorkingDirectory()
      The directory where in-process batch files containing serialized AuditEvent instances are stored. Presumably this is a shared filesystem across the application cluster. Defaults to a temporary directory suitable for local testing.

    • getCompletionDirectory

      public String getCompletionDirectory()
      The directory where completed batch files containing serialized AuditEvent instances are stored. Presumably this is a shared filesystem across the application cluster. Defaults to a temporary directory suitable for local testing.

    • getIngestionDirectory

      public String getIngestionDirectory()
      The directory where completed batch files undergoing ingestion are stored. This is the final step before audit data is uploaded to the database. After ingestion is complete, the file is deleted. Presumably this is a shared filesystem across the application cluster. Defaults to a temporary directory suitable for local testing.

    • getMaxFilesPerWorkingPartition

      public long getMaxFilesPerWorkingPartition()
      Batch files are placed into partitioned directories inside of workingDirectory and completionDirectory in order to avoid OS filesystem limitations regarding max file count per directory. This value determines the maximum number of files per partition. Default is 20000.

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether audit file system storage is enabled. Default is false.

    • setWorkingDirectory

      public void setWorkingDirectory(String workingDirectory)
      The directory where in-process batch files containing serialized AuditEvent instances are stored. Presumably this is a shared filesystem across the application cluster. Defaults to a temporary directory suitable for local testing.

    • setCompletionDirectory

      public void setCompletionDirectory(String completionDirectory)
      The directory where completed batch files containing serialized AuditEvent instances are stored. Presumably this is a shared filesystem across the application cluster. Defaults to a temporary directory suitable for local testing.

    • setIngestionDirectory

      public void setIngestionDirectory(String ingestionDirectory)
      The directory where completed batch files undergoing ingestion are stored. This is the final step before audit data is uploaded to the database. After ingestion is complete, the file is deleted. Presumably this is a shared filesystem across the application cluster. Defaults to a temporary directory suitable for local testing.

    • setMaxFilesPerWorkingPartition

      public void setMaxFilesPerWorkingPartition(long maxFilesPerWorkingPartition)
      Batch files are placed into partitioned directories inside of workingDirectory and completionDirectory in order to avoid OS filesystem limitations regarding max file count per directory. This value determines the maximum number of files per partition. Default is 20000.

    • 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