org.rvpf.store.server.archiver

Class Archiver.Abstract

Object

Archiver.Abstract

All Implemented Interfaces:

Archiver

Direct Known Subclasses:

CleanUpArchiver, JiTArchiver, ScheduledArchiver

Enclosing interface:

Archiver

public abstract static class Archiver.Abstract
extends Object
implements Archiver

Abstract.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Archiver.Abstract.PointReference Point reference.

Nested classes/interfaces inherited from interface Archiver

Archiver.Abstract, Archiver.Attic

Field Summary

Fields inherited from interface Archiver

ARCHIVER_PROPERTIES, ATTIC_IMPLEMENTATION_CLASS_PROPERTY, ATTIC_PROPERTIES, DEFAULT_ATTIC_IMPLEMENTATION_CLASS, DISABLED_PROPERTY, STORE_REMOVED_EVENT

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
protected void	archive(Archiver.Abstract.PointReference pointReference, DateTime scanTime) Archives a point.
void	archive(Point point) Archives a point.
void	commit() Commits.
protected void	commitAttic() Commits the attic.
Optional<Archiver.Attic>	getAttic() Gets the attic.
protected Optional<Archiver.Abstract.PointReference>	getPointReference(Point point) Gets a point reference.
protected Collection<Archiver.Abstract.PointReference>	getPointReferences() Gets the point references.
protected KeyedGroups	getProperties() Gets the properties.
protected StoreServiceAppImpl	getStoreAppImpl() Gets the storeAppImpl.
protected Logger	getThisLogger() Gets this logger.
protected boolean	isDisabled() Asks if disabled.
boolean	setUp(StoreServiceAppImpl storeAppImpl) Sets up this.
protected boolean	setUpAttic(KeyedGroups atticProperties, Config config, File dataDir) Sets up the attic.
boolean	setUpPoints() Sets up points.
void	tearDown() Tears down what has been set up.
protected void	updateStats() Updates the stats.

Methods inherited from class Object

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

Methods inherited from interface Archiver

start, stop, supports

Constructor Detail

Abstract

public Abstract()

Method Detail

archive

public void archive(Point point)
             throws ServiceNotAvailableException

Archives a point.

Specified by:

archive in interface Archiver

Parameters:

point - The point.

Throws:

ServiceNotAvailableException - When service not available.

commit

public void commit()

Commits.

Specified by:

commit in interface Archiver

getAttic

public Optional<Archiver.Attic> getAttic()

Gets the attic.

Specified by:

getAttic in interface Archiver

Returns:

The optional attic.

setUp

public boolean setUp(StoreServiceAppImpl storeAppImpl)

Sets up this.

Specified by:

setUp in interface Archiver

Parameters:

storeAppImpl - The calling store application implementation.

Returns:

True on success.

setUpPoints

public boolean setUpPoints()

Sets up points.

Specified by:

setUpPoints in interface Archiver

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Archiver

archive

protected void archive(@Nonnull
                       Archiver.Abstract.PointReference pointReference,
                       @Nonnull
                       DateTime scanTime)
                throws ServiceNotAvailableException

Archives a point.

Parameters:

pointReference - The point reference.

scanTime - The scan time.

Throws:

ServiceNotAvailableException - When service is not available.

commitAttic

protected void commitAttic()

Commits the attic.

getPointReference

@Nonnull
 @CheckReturnValue
protected Optional<Archiver.Abstract.PointReference> getPointReference(@Nonnull
                                                                                                     Point point)

Gets a point reference.

Parameters:

point - The point.

Returns:

The point reference (empty if unknown).

getPointReferences

@Nonnull
 @CheckReturnValue
protected Collection<Archiver.Abstract.PointReference> getPointReferences()

Gets the point references.

Returns:

The point references.

getProperties

@Nonnull
 @CheckReturnValue
protected KeyedGroups getProperties()

Gets the properties.

Returns:

The properties.

getStoreAppImpl

@Nonnull
 @CheckReturnValue
protected StoreServiceAppImpl getStoreAppImpl()

Gets the storeAppImpl.

Returns:

The storeAppImpl.

getThisLogger

@Nonnull
 @CheckReturnValue
protected Logger getThisLogger()

Gets this logger.

Returns:

The logger.

isDisabled

@CheckReturnValue
protected boolean isDisabled()

Asks if disabled.

Returns:

True if disabled.

setUpAttic

protected boolean setUpAttic(@Nonnull
                             KeyedGroups atticProperties,
                             @Nonnull
                             Config config,
                             @Nonnull
                             File dataDir)

Sets up the attic.

Parameters:

atticProperties - The attic properties.

config - The config.

dataDir - The data directory.

Returns:

True on success.

updateStats

protected void updateStats()

Updates the stats.