Package com.broadleafcommerce.common.audit.batch

Class FileSystemStorageProvider

java.lang.Object

com.broadleafcommerce.common.audit.batch.FileSystemStorageProvider

All Implemented Interfaces:

StorageProvider

public class FileSystemStorageProvider
extends Object
implements StorageProvider

File system version of StorageProvider

Constructor Summary

Constructors

Constructor	Description
FileSystemStorageProvider(FileSystemStorageProviderProperties properties)

Method Summary

Modifier and Type	Method	Description
Batch	completeBatch(Batch batch)	Complete a Batch to its completion state
Batch	newBatch()	Create a new Batch storage representation
Batch	nextIngestionBatch()	Grab the next available completed batch from storage for ingestion.
void	review(Consumer<Stream<Batch>> consumer)	Preview all completed batches as a stream of Batch instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileSystemStorageProvider

public FileSystemStorageProvider(FileSystemStorageProviderProperties properties)

Method Details

newBatch

public Batch newBatch()

Description copied from interface: StorageProvider

Create a new Batch storage representation

Specified by:

newBatch in interface StorageProvider

Returns:

new Batch storage representation

completeBatch

public Batch completeBatch(Batch batch)

Description copied from interface: StorageProvider

Complete a Batch to its completion state

Specified by:

completeBatch in interface StorageProvider

Parameters:

batch - The Batch storage representation to complete

Returns:

The completed Batch representation

review

public void review(Consumer<Stream<Batch>> consumer)

Description copied from interface: StorageProvider

Preview all completed batches as a stream of Batch instances. The stream is automatically closed once the consumer exits.

Specified by:

review in interface StorageProvider

Parameters:

consumer - A consumer receiving a stream of paths for review

nextIngestionBatch

@Nullable
public Batch nextIngestionBatch()

Description copied from interface: StorageProvider

Grab the next available completed batch from storage for ingestion.

Specified by:

nextIngestionBatch in interface StorageProvider

Returns:

The next available completed batch from storage. Null if none available.