com.mozilla.secops.state

Class DatastoreStateInterface

java.lang.Object

com.mozilla.secops.state.DatastoreStateInterface

All Implemented Interfaces:

StateInterface

public class DatastoreStateInterface
extends Object
implements StateInterface

Utilize GCP Datastore for centralized state storage

Constructor Summary

Constructors

Constructor and Description
DatastoreStateInterface(String kind, String namespace) Initialize a Datastore state interface
DatastoreStateInterface(String kind, String namespace, com.google.cloud.http.HttpTransportOptions opts) Initialize a Datastore state interface with transport options
DatastoreStateInterface(String kind, String namespace, String project) Initialize a Datastore state interface using datastore in another project
DatastoreStateInterface(String kind, String namespace, String project, com.google.cloud.http.HttpTransportOptions opts) Initialize a Datastore state interface using datastore in another project with transport options

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DatastoreStateInterface

public DatastoreStateInterface(String kind,
                               String namespace)

Initialize a Datastore state interface

Parameters:

kind - kind value to use for stored objects

namespace - Datastore namespace

DatastoreStateInterface

public DatastoreStateInterface(String kind,
                               String namespace,
                               com.google.cloud.http.HttpTransportOptions opts)

Initialize a Datastore state interface with transport options

Parameters:

kind - kind value to use for stored objects

namespace - Datastore namespace

opts - HttpTransportOptions for datastore client

DatastoreStateInterface

public DatastoreStateInterface(String kind,
                               String namespace,
                               String project)

Initialize a Datastore state interface using datastore in another project

Parameters:

kind - kind value to use for stored objects

namespace - Datastore namespace

project - Project identifier

DatastoreStateInterface

public DatastoreStateInterface(String kind,
                               String namespace,
                               String project,
                               com.google.cloud.http.HttpTransportOptions opts)

Initialize a Datastore state interface using datastore in another project with transport options

Parameters:

kind - kind value to use for stored objects

namespace - Datastore namespace

project - Project identifier

opts - HttpTransportOptions for datastore client

Method Detail

newCursor

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

Allocate new state cursor

Specified by:

newCursor in interface StateInterface

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

done

public void done()

Notify state implementation no further processing will occur

noop for datastore

Specified by:

done in interface StateInterface

initialize

public void initialize()
                throws StateException

Perform any setup required to read and write state

Specified by:

initialize in interface StateInterface

Throws:

StateException - StateException

deleteAll

public void deleteAll()
               throws StateException

Flush all keys in the state implementation

Specified by:

deleteAll in interface StateInterface

Throws:

StateException - StateException