Package com.illumon.iris.controller.pqstorage

Interface PqStorage

All Known Implementing Classes:

PqStorageEtcdImpl, PqStorageEtcdV2Impl, PqStorageKvBase, PqStoragePhtImpl

public interface PqStorage

Interface for storage of persistent query configurations. Implementations must provide a no-arg constructor as they will be created reflectively.

Method Summary

Modifier and Type	Method	Description
boolean	addPersistentQueryConfiguration(PersistentQueryConfiguration config)	Add the specified persistent query configuration.
void	commitCheckPoint()	Commit a checkpoint.
boolean	deletePersistentQueryConfiguration(PersistentQueryConfiguration config)	Delete the specified persistent query configuration.
void	disconnect(boolean forceCheckpoint)	Disconnect from the storage mechanism.
PersistentQueryConfiguration	getPersistentQueryConfiguration(long serial)	Return the PersistentQueryConfiguration for the specified serial.
default void	initialize()	Do any initialization work required.
Set<Long>	keySet()	Return the Set of persisted serials.
boolean	updatePersistentQueryConfiguration(PersistentQueryConfiguration config)	Update the specified persistent query configuration.
Collection<PersistentQueryConfiguration>	values()	Return a Collection containing all the persisted PersistentQueryConfiguration instances.

Method Details

initialize

default void initialize()
                 throws PqStorageException

Do any initialization work required.

Throws:

PqStorageException

getPersistentQueryConfiguration

@Nullable
PersistentQueryConfiguration getPersistentQueryConfiguration(long serial)
                                                      throws PqStorageException

Return the PersistentQueryConfiguration for the specified serial.

Parameters:

serial - the serial for the query

Returns:

the query, or null if it does not exist

Throws:

PqStorageException

addPersistentQueryConfiguration

boolean addPersistentQueryConfiguration(@NotNull
 PersistentQueryConfiguration config)
                                 throws IOException,
PqStorageException

Add the specified persistent query configuration. If the configuration already exists, it will not be updated.

Parameters:

config - the configuration to add

Returns:

true if the configuration was added, false if it already existed

Throws:

IOException - if an error occurs during the persistence operation

PqStorageException

updatePersistentQueryConfiguration

boolean updatePersistentQueryConfiguration(@NotNull
 PersistentQueryConfiguration config)
                                    throws IOException,
PqStorageException

Update the specified persistent query configuration. If the configuration does not exist, it will not be created.

Parameters:

config - the configuration to update

Returns:

true if the (existing) configuration was updated, false if it did not exist

Throws:

IOException - if an error occurs during the persistence operation

PqStorageException

deletePersistentQueryConfiguration

boolean deletePersistentQueryConfiguration(@NotNull
 PersistentQueryConfiguration config)
                                    throws IOException,
PqStorageException

Delete the specified persistent query configuration.

Parameters:

config - the configuration to update

Returns:

true if the configuration was deleted, false if it did not exist

Throws:

IOException - if an error occurs during the persistence operation

PqStorageException

commitCheckPoint

void commitCheckPoint()
               throws IOException

Commit a checkpoint. This may be a no-op.

Throws:

IOException - if an error occurs committing the checkpoint

disconnect

void disconnect(boolean forceCheckpoint)

Disconnect from the storage mechanism.

Parameters:

forceCheckpoint - if true, perform a checkpoint

keySet

Set<Long> keySet()
          throws PqStorageException

Return the Set of persisted serials. There are no guarantees on the type, mutability, serializability, or thread-safety of the Set returned.

Returns:

a Set of the serials

Throws:

PqStorageException

values

Collection<PersistentQueryConfiguration> values()
                                         throws PqStorageException

Return a Collection containing all the persisted PersistentQueryConfiguration instances. Updates to these PersistentQueryConfiguration instances should be persisted via updatePersistentQueryConfiguration(com.illumon.iris.controller.PersistentQueryConfiguration). There are no guarantees on the type, mutability, serializability, or thread-safety of the Collection returned, or of the objects contained within the Collection.

Returns:

a Collection of persistent query configurations

Throws:

PqStorageException