org.rvpf.store.server.the

Interface BackEnd

All Known Implementing Classes:

BDBBackEnd, MemoryBackEnd, SQLBackEnd

public interface BackEnd

Back-end.

Method Summary

Modifier and Type	Method and Description
void	beginUpdates() Begins updates.
void	close() Closes.
void	commit() Commits.
StoreValues	createResponse(StoreValuesQuery query, Optional<Identity> identity) Creates store values for a store query.
int	delete(VersionedValue versionedValue) Deletes a point value.
void	endUpdates() Ends updates.
default Archiver	newArchiver() Returns a new archiver.
void	open() Opens.
default int	purge(UUID[] pointUUIDs, TimeInterval timeInterval) Purges points values.
void	rollback() Rolls back.
boolean	setUp(TheStoreServiceAppImpl theStoreAppImpl) Sets up the back end.
boolean	supportsCount() Asks if the back end supports count.
default boolean	supportsPurge() Asks if the back end supports purge.
void	tearDown() Tears down what has been set up.
void	update(VersionedValue versionedValue) Updates a point value.

Method Detail

beginUpdates

void beginUpdates()

Begins updates.

close

void close()

Closes.

commit

void commit()

Commits.

createResponse

@Nonnull
 @CheckReturnValue
StoreValues createResponse(@Nonnull
                                                         StoreValuesQuery query,
                                                         @Nonnull
                                                         Optional<Identity> identity)

Creates store values for a store query.

Parameters:

query - The store query.

identity - The optional requesting identity.

Returns:

The store values.

delete

@CheckReturnValue
int delete(@Nonnull
                              VersionedValue versionedValue)

Deletes a point value.

Parameters:

versionedValue - The point value to delete.

Returns:

The number of deleted values (0 .. 2).

endUpdates

void endUpdates()

Ends updates.

newArchiver

@Nonnull
 @CheckReturnValue
default Archiver newArchiver()

Returns a new archiver.

Returns:

The new archiver.

open

void open()
   throws ServiceNotAvailableException

Opens.

Throws:

ServiceNotAvailableException - On failure.

purge

@CheckReturnValue
default int purge(@Nonnull
                                     UUID[] pointUUIDs,
                                     @Nonnull
                                     TimeInterval timeInterval)

Purges points values.

Parameters:

pointUUIDs - The UUID of the points to purge.

timeInterval - A time interval.

Returns:

The number of values purged.

rollback

void rollback()

Rolls back.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 TheStoreServiceAppImpl theStoreAppImpl)

Sets up the back end.

Parameters:

theStoreAppImpl - The TheStore application instance.

Returns:

True on success.

supportsCount

@CheckReturnValue
boolean supportsCount()

Asks if the back end supports count.

Returns:

True if count is supported.

supportsPurge

@CheckReturnValue
default boolean supportsPurge()

Asks if the back end supports purge.

Returns:

True if purge is supported.

tearDown

void tearDown()

Tears down what has been set up.

update

void update(@Nonnull
            VersionedValue versionedValue)

Updates a point value.

Parameters:

versionedValue - The point value to update.