com.mozilla.secops.state

Class StateCursor<T>

java.lang.Object

com.mozilla.secops.state.StateCursor<T>

Direct Known Subclasses:

DatastoreStateCursor, MemcachedStateCursor

public abstract class StateCursor<T>
extends Object

Generic state cursor implementation

Constructor Summary

Constructors

Constructor and Description
StateCursor(Class<T> stateClass) Allocate new StateCursor

Method Summary

Modifier and Type	Method and Description
abstract void	commit() Commit transaction
void	execute() Execute all operations in cursor
T	get(String key) Get a value from state
ArrayList<T>	getAll() Get all values from state
T	getResultValueForId(UUID id) Fetch a result value from a completed operation
ArrayList<T>	getResultValuesForId(UUID id) Fetch a set of result values from a completed operation
void	set(String key, T value) Set a value in state
StateCursor<T>	withOperation(StateOperation<T> operation) Add an operation for execution in the cursor

Methods inherited from class java.lang.Object

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

Constructor Detail

StateCursor

public StateCursor(Class<T> stateClass)

Allocate new StateCursor

Parameters:

stateClass - Class for state storage

Method Detail

withOperation

public StateCursor<T> withOperation(StateOperation<T> operation)
                             throws StateException

Add an operation for execution in the cursor

Parameters:

operation - StateOperation

Returns:

This for chaining

Throws:

StateException - StateException

getResultValueForId

public T getResultValueForId(UUID id)
                      throws StateException

Fetch a result value from a completed operation

Only applicable for GET related operations.

Parameters:

id - Operation ID

Returns:

T

Throws:

StateException - StateException

getResultValuesForId

public ArrayList<T> getResultValuesForId(UUID id)
                                  throws StateException

Fetch a set of result values from a completed operation

Only applicable for GET_ALL related operations.

Parameters:

id - Operation ID

Returns:

ArrayList

Throws:

StateException - StateException

commit

public abstract void commit()
                     throws StateException

Commit transaction

If the cursor was created as a transaction, calling this method on the cursor will commit the transaction. If this method is called on a cursor that is not configured as a transaction, an exception will be thrown.

Throws:

StateException - StateException

execute

public void execute()
             throws StateException

Execute all operations in cursor

Throws:

StateException

set

public void set(String key,
                T value)
         throws StateException

Set a value in state

This is a convenience method that will add a single SET operation and call execute.

Parameters:

key - Key

value - Value

Throws:

StateException - StateException

get

public T get(String key)
      throws StateException

Get a value from state

This is a convenience method that will add a single GET operation and call execute.

Parameters:

key - Key

Returns:

T

Throws:

StateException - StateException

getAll

public ArrayList<T> getAll()
                    throws StateException

Get all values from state

This is a convenience method that will add a single GET_ALL operation and call execute.

Returns:

ArrayList

Throws:

StateException - StateException