com.mozilla.secops.state

Interface StateInterface

All Known Implementing Classes:

DatastoreStateInterface, MemcachedStateInterface

public interface StateInterface

Interface for state implementations

Method Summary

Modifier and Type	Method and Description
void	deleteAll() Flush all keys in the state implementation
void	done() Notify state implementation no further processing will occur
void	initialize() Perform any setup required to read and write state
<T> StateCursor<T>	newCursor(Class<T> stateClass, boolean transaction) Allocate new state cursor

Method Detail

done

void done()

Notify state implementation no further processing will occur

deleteAll

void deleteAll()
        throws StateException

Flush all keys in the state implementation

Throws:

StateException - StateException

initialize

void initialize()
         throws StateException

Perform any setup required to read and write state

Throws:

StateException - StateException

newCursor

<T> StateCursor<T> newCursor(Class<T> stateClass,
                             boolean transaction)
                      throws StateException

Allocate new state cursor

Type Parameters:

T - Class used in state storage

Parameters:

stateClass - Class used in state storage

transaction - If true, allocate cursor as a transaction

Returns:

StateCursor

Throws:

StateException - StateException