org.rvpf.store.server.archiver

Interface Archiver

All Known Implementing Classes:

Archiver.Abstract, CleanUpArchiver, JiTArchiver, ScheduledArchiver

public interface Archiver

Archiver.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Archiver.Abstract Abstract.
static interface	Archiver.Attic Attic.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARCHIVER_PROPERTIES Archiver properties.
static String	ATTIC_IMPLEMENTATION_CLASS_PROPERTY Attic implementation class property.
static String	ATTIC_PROPERTIES Attic properties.
static ClassDef	DEFAULT_ATTIC_IMPLEMENTATION_CLASS Default attic implementation class.
static String	DISABLED_PROPERTY Disables the attic.
static String	STORE_REMOVED_EVENT Store removed event.

Method Summary

Modifier and Type	Method and Description
void	archive(Point point) Archives a point.
void	commit() Commits.
Optional<Archiver.Attic>	getAttic() Gets the attic.
boolean	setUp(StoreServiceAppImpl storeAppImpl) Sets up this.
boolean	setUpPoints() Sets up points.
void	start() Starts.
void	stop() Stops.
static boolean	supports(StoreServer storeServer) Asks if the archiver supports a store server.
void	tearDown() Tears down what has been set up.

Field Detail

ARCHIVER_PROPERTIES

static final String ARCHIVER_PROPERTIES

Archiver properties.

See Also:

Constant Field Values

ATTIC_IMPLEMENTATION_CLASS_PROPERTY

static final String ATTIC_IMPLEMENTATION_CLASS_PROPERTY

Attic implementation class property.

See Also:

Constant Field Values

ATTIC_PROPERTIES

static final String ATTIC_PROPERTIES

Attic properties.

See Also:

Constant Field Values

DEFAULT_ATTIC_IMPLEMENTATION_CLASS

static final ClassDef DEFAULT_ATTIC_IMPLEMENTATION_CLASS

Default attic implementation class.

DISABLED_PROPERTY

static final String DISABLED_PROPERTY

Disables the attic.

See Also:

Constant Field Values

STORE_REMOVED_EVENT

static final String STORE_REMOVED_EVENT

Store removed event.

See Also:

Constant Field Values

Method Detail

supports

@CheckReturnValue
static boolean supports(@Nonnull
                                           StoreServer storeServer)

Asks if the archiver supports a store server.

Parameters:

storeServer - The store server.

Returns:

True if the store server is supported.

archive

void archive(Point point)
      throws ServiceNotAvailableException

Archives a point.

Parameters:

point - The point.

Throws:

ServiceNotAvailableException - When service not available.

commit

void commit()

Commits.

getAttic

@Nonnull
 @CheckReturnValue
Optional<Archiver.Attic> getAttic()

Gets the attic.

Returns:

The optional attic.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 StoreServiceAppImpl storeAppImpl)

Sets up this.

Parameters:

storeAppImpl - The calling store application implementation.

Returns:

True on success.

setUpPoints

@CheckReturnValue
boolean setUpPoints()

Sets up points.

Returns:

True on success.

start

void start()

Starts.

stop

void stop()

Stops.

tearDown

void tearDown()

Tears down what has been set up.