org.rvpf.base.util

Class StorageMonitor

Object

StorageMonitor

public final class StorageMonitor
extends Object

Storage monitor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageMonitor.State State.
static interface	StorageMonitor.StateTransitionHandler State transition handler.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FREE_ALERT_PROPERTY Free alert property.
static String	FREE_WARN_PROPERTY Free warn property.
static String	ROOT_DIR_PROPERTY Root dir property.

Constructor Summary

Constructors

Constructor and Description
StorageMonitor(Logger logger) Constructs an instance.
StorageMonitor(Logger logger, Optional<StorageMonitor.StateTransitionHandler> onWarn, Optional<StorageMonitor.StateTransitionHandler> onAlert) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	check() Checks.
long	getAvailable() Gets the available space size in bytes from the last check.
int	getFree() Gets the free space size in million bytes from the last check.
StorageMonitor.State	getState() Gets the state.
boolean	setUp(KeyedValues storageProperties, File defaultRootDir) Sets up this.
void	setUsableSpaceSupplier(LongSupplier usableSpaceSupplier) Sets the usable space supplier.
void	tearDown() Tears down what as been set up.

Methods inherited from class Object

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

Field Detail

FREE_ALERT_PROPERTY

public static final String FREE_ALERT_PROPERTY

Free alert property.

See Also:

Constant Field Values

FREE_WARN_PROPERTY

public static final String FREE_WARN_PROPERTY

Free warn property.

See Also:

Constant Field Values

ROOT_DIR_PROPERTY

public static final String ROOT_DIR_PROPERTY

Root dir property.

See Also:

Constant Field Values

Constructor Detail

StorageMonitor

public StorageMonitor(@Nonnull
                      Logger logger)

Constructs an instance.

Parameters:

logger - A logger.

StorageMonitor

public StorageMonitor(@Nonnull
                      Logger logger,
                      @Nonnull
                      Optional<StorageMonitor.StateTransitionHandler> onWarn,
                      @Nonnull
                      Optional<StorageMonitor.StateTransitionHandler> onAlert)

Constructs an instance.

When the transition handler predicate is called, it returns false to let the storage monitor log a message (also logged if the handler is null).

Parameters:

logger - A logger.

onWarn - Called on 'warn' transition.

onAlert - Called on 'alert' transition.

Method Detail

check

@CheckReturnValue
public boolean check()

Checks.

Returns:

True unless on alert.

getAvailable

@CheckReturnValue
public long getAvailable()

Gets the available space size in bytes from the last check.

Returns:

The available space size in bytes.

getFree

@CheckReturnValue
public int getFree()

Gets the free space size in million bytes from the last check.

Returns:

The free space size in million bytes.

getState

@CheckReturnValue
public StorageMonitor.State getState()

Gets the state.

Returns:

The state.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        KeyedValues storageProperties,
                                        @Nonnull
                                        File defaultRootDir)

Sets up this.

Parameters:

storageProperties - The storage properties.

defaultRootDir - The default root directory.

Returns:

True on success.

setUsableSpaceSupplier

public void setUsableSpaceSupplier(@Nonnull
                                   LongSupplier usableSpaceSupplier)

Sets the usable space supplier.

Used by storage monitor tests.

Parameters:

usableSpaceSupplier - The usable space supplier.

tearDown

public void tearDown()

Tears down what as been set up.