com.mozilla.secops.state

Class State

java.lang.Object

com.mozilla.secops.state.State

public class State
extends Object

Represents a generic state interface that can be used to store and load state from or to a persistent storage source

Constructor Summary

Constructors

Constructor and Description
State(StateInterface in) Construct a new state instance using the specified StateInterface

Method Summary

Modifier and Type	Method and Description
void	deleteAll() Flush all keys in the underlying state storage
void	done() Inidicate state object will no longer be used
void	initialize() Initialize state instance
<T> StateCursor<T>	newCursor(Class<T> stateClass, boolean transaction) Allocate new state cursor for a set of operations

Methods inherited from class java.lang.Object

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

Constructor Detail

State

public State(StateInterface in)

Construct a new state instance using the specified StateInterface

Parameters:

in - StateInterface to use for state storage

Method Detail

deleteAll

public void deleteAll()
               throws StateException

Flush all keys in the underlying state storage

Throws:

StateException - StateException

newCursor

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

Allocate new state cursor for a set of operations

If the transaction flag is true, the new cursor will be allocated as a transaction. In this case be sure to properly commit the transaction in the cursor when complete.

Type Parameters:

T - Class used in state storage

Parameters:

stateClass - Class used in stage storage

transaction - If true, allocate cursor as a transaction

Returns:

StateCursor

Throws:

StateException - StateException

initialize

public void initialize()
                throws StateException

Initialize state instance

The initialize function should be called prior to reading or writing any state using the State object.

Throws:

StateException - StateException

done

public void done()

Inidicate state object will no longer be used

The done function must be called to ensure any background threads and resources are released.