org.apache.tephra.persist

Class NoOpTransactionStateStorage

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.apache.tephra.persist.NoOpTransactionStateStorage

All Implemented Interfaces:

com.google.common.util.concurrent.Service, TransactionStateStorage

public class NoOpTransactionStateStorage
extends com.google.common.util.concurrent.AbstractIdleService
implements TransactionStateStorage

Minimal TransactionStateStorage implementation that does nothing, i.e. does not maintain any actual state.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Constructor and Description
NoOpTransactionStateStorage(SnapshotCodecProvider codecProvider)

Method Summary

Methods

Modifier and Type	Method and Description
TransactionLog	createLog(long timestamp) Creates a new TransactionLog.
void	deleteLogsOlderThan(long timestamp) Removes any transaction logs with a timestamp older than the given value.
long	deleteOldSnapshots(int numberToKeep) Removes any snapshots prior to the numberToKeep most recent.
TransactionSnapshot	getLatestSnapshot() Returns the most recent snapshot that has been successfully written.
TransactionVisibilityState	getLatestTransactionVisibilityState() Returns the most recent transaction visibility state that has been successfully written.
String	getLocation() Returns a string representation of the location used for persistence.
List<TransactionLog>	getLogsSince(long timestamp) Returns all TransactionLogs with a timestamp greater than or equal to the given timestamp.
List<String>	listLogs() Returns the (non-qualified) names of available logs.
List<String>	listSnapshots() Returns the (non-qualified) names of available snapshots.
void	setupStorage() Create the directories required for the transaction state stage.
protected void	shutDown()
protected void	startUp()
void	writeSnapshot(OutputStream out, TransactionSnapshot snapshot) Persists a snapshot of transaction state to an output stream.
void	writeSnapshot(TransactionSnapshot snapshot) Persists a snapshot of transaction state.

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, executor, isRunning, start, startAndWait, state, stop, stopAndWait, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, isRunning, start, startAndWait, state, stop, stopAndWait

Constructor Detail

NoOpTransactionStateStorage

@Inject
public NoOpTransactionStateStorage(SnapshotCodecProvider codecProvider)

Method Detail

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

writeSnapshot

public void writeSnapshot(OutputStream out,
                 TransactionSnapshot snapshot)
                   throws IOException

Description copied from interface: TransactionStateStorage

Persists a snapshot of transaction state to an output stream.

Specified by:

writeSnapshot in interface TransactionStateStorage

Throws:

IOException

writeSnapshot

public void writeSnapshot(TransactionSnapshot snapshot)
                   throws IOException

Description copied from interface: TransactionStateStorage

Persists a snapshot of transaction state.

Specified by:

writeSnapshot in interface TransactionStateStorage

Throws:

IOException

getLatestSnapshot

public TransactionSnapshot getLatestSnapshot()
                                      throws IOException

Description copied from interface: TransactionStateStorage

Returns the most recent snapshot that has been successfully written. Note that this may return null if no completed snapshot files are found.

Specified by:

getLatestSnapshot in interface TransactionStateStorage

Throws:

IOException

getLatestTransactionVisibilityState

public TransactionVisibilityState getLatestTransactionVisibilityState()
                                                               throws IOException

Description copied from interface: TransactionStateStorage

Returns the most recent transaction visibility state that has been successfully written. Note that this may return null if no completed snapshot files are found.

Specified by:

getLatestTransactionVisibilityState in interface TransactionStateStorage

Returns:

TransactionVisibilityState

Throws:

IOException

deleteOldSnapshots

public long deleteOldSnapshots(int numberToKeep)
                        throws IOException

Description copied from interface: TransactionStateStorage

Removes any snapshots prior to the numberToKeep most recent.

Specified by:

deleteOldSnapshots in interface TransactionStateStorage

Parameters:

numberToKeep - The number of most recent snapshots to keep.

Returns:

The timestamp of the oldest snapshot kept.

Throws:

IOException - If an error occurs while deleting old snapshots.

listSnapshots

public List<String> listSnapshots()
                           throws IOException

Description copied from interface: TransactionStateStorage

Returns the (non-qualified) names of available snapshots.

Specified by:

listSnapshots in interface TransactionStateStorage

Throws:

IOException

getLogsSince

public List<TransactionLog> getLogsSince(long timestamp)
                                  throws IOException

Description copied from interface: TransactionStateStorage

Returns all TransactionLogs with a timestamp greater than or equal to the given timestamp. Note that the returned list is guaranteed to be sorted in ascending timestamp order.

Specified by:

getLogsSince in interface TransactionStateStorage

Throws:

IOException

createLog

public TransactionLog createLog(long timestamp)
                         throws IOException

Description copied from interface: TransactionStateStorage

Creates a new TransactionLog.

Specified by:

createLog in interface TransactionStateStorage

Throws:

IOException

deleteLogsOlderThan

public void deleteLogsOlderThan(long timestamp)
                         throws IOException

Description copied from interface: TransactionStateStorage

Removes any transaction logs with a timestamp older than the given value. Logs must be removed based on timestamp to ensure we can fully recover state based on a given snapshot.

Specified by:

deleteLogsOlderThan in interface TransactionStateStorage

Parameters:

timestamp - The timestamp to delete up to. Logs with a timestamp less than this value will be removed.

Throws:

IOException - If an error occurs while removing logs.

setupStorage

public void setupStorage()
                  throws IOException

Description copied from interface: TransactionStateStorage

Create the directories required for the transaction state stage.

Specified by:

setupStorage in interface TransactionStateStorage

Throws:

IOException - If an error occurred during the creation of required directories for transaction state storage.

listLogs

public List<String> listLogs()
                      throws IOException

Description copied from interface: TransactionStateStorage

Returns the (non-qualified) names of available logs.

Specified by:

listLogs in interface TransactionStateStorage

Throws:

IOException

getLocation

public String getLocation()

Description copied from interface: TransactionStateStorage

Returns a string representation of the location used for persistence.

Specified by:

getLocation in interface TransactionStateStorage