org.infobip.lib.popout.backend

Class FileSystemBackend

java.lang.Object

org.infobip.lib.popout.backend.FileSystemBackend

All Implemented Interfaces:

AutoCloseable, Iterable<WalContent>

public class FileSystemBackend
extends Object
implements Iterable<WalContent>, AutoCloseable

The umbrella class for WAL and compressed files, for effective working with them.

Since:

2.0.1

Author:

Artem Labazin

Constructor Summary

Constructors

Constructor and Description
FileSystemBackend(@NonNull String queueName, @NonNull WalFilesConfig walConfig, @NonNull CompressedFilesConfig compressedConfig, Boolean restoreFromDisk, Function<CorruptedDataException,Boolean> corruptionHandler) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
void	compress() Merges all WAL files into one big compressed file.
long	diskSize() Returns the size, which is occupied by files related to this backend (WAL and compressed fiels).
Iterator<WalContent>	iterator()
int	peakTo(@NonNull io.appulse.utils.Bytes buffer) Retrieves, but does not remove the next WAL content into the buffer.
int	pollTo(@NonNull io.appulse.utils.Bytes buffer) Retrieves and removes the head of the next WAL content into the buffer.
void	write(@NonNull io.appulse.utils.Bytes buffer) Writes the buffer content to the next WAL file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FileSystemBackend

public FileSystemBackend(@NonNull
                         @NonNull String queueName,
                         @NonNull
                         @NonNull WalFilesConfig walConfig,
                         @NonNull
                         @NonNull CompressedFilesConfig compressedConfig,
                         Boolean restoreFromDisk,
                         Function<CorruptedDataException,Boolean> corruptionHandler)

Constructor.

Parameters:

queueName - the queue name for file names pattern

walConfig - the configuration for WAL files

compressedConfig - the configuration for compressed files

restoreFromDisk - the flag which tells should it restores from disk or not

Method Detail

write

public void write(@NonNull
                  @NonNull io.appulse.utils.Bytes buffer)

Writes the buffer content to the next WAL file. If the wal files limit exceeded - merge them into a new compress file and remove.

Parameters:

buffer - byte array source to write

compress

public void compress()

Merges all WAL files into one big compressed file.

pollTo

public int pollTo(@NonNull
                  @NonNull io.appulse.utils.Bytes buffer)

Retrieves and removes the head of the next WAL content into the buffer.

Parameters:

buffer - the destination bytes buffer, where content writes

Returns:

number of written bytes into buffer

peakTo

public int peakTo(@NonNull
                  @NonNull io.appulse.utils.Bytes buffer)

Retrieves, but does not remove the next WAL content into the buffer.

Parameters:

buffer - the destination bytes buffer

Returns:

number of written bytes into buffer

diskSize

public long diskSize()

Returns the size, which is occupied by files related to this backend (WAL and compressed fiels).

Returns:

number of bytes, the backend takes on the disk

iterator

public Iterator<WalContent> iterator()

Specified by:

iterator in interface Iterable<WalContent>

close

public void close()

Specified by:

close in interface AutoCloseable