org.statefulj.persistence.mongo

Class MongoPersister<T>

java.lang.Object

org.statefulj.persistence.common.AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

org.statefulj.persistence.mongo.MongoPersister<T>

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.config.BeanFactoryPostProcessor, org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor, org.springframework.context.ApplicationContextAware, Persister<T>

public class MongoPersister<T>
extends AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>
implements Persister<T>, org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor, org.springframework.context.ApplicationContextAware

Constructor Summary

Constructors

Constructor and Description
MongoPersister(List<State<T>> states, State<T> startState, Class<T> clazz, org.springframework.data.mongodb.core.MongoTemplate mongoTemplate) Instantiate the MongoPersister with a specified template.
MongoPersister(List<State<T>> states, State<T> startState, Class<T> clazz, String repoId) Instantiate the MongoPersister with the id of the MongoRepository bean for the Managed Entity.
MongoPersister(List<State<T>> states, String stateFieldName, State<T> startState, Class<T> clazz, org.springframework.data.mongodb.core.MongoTemplate mongoTemplate) Instantiate the MongoPersister with a specified template.
MongoPersister(List<State<T>> states, String stateFieldName, State<T> startState, Class<T> clazz, String repoId) Instantiate the MongoPersister with the id of the MongoRepository bean for the Managed Entity.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.data.mongodb.core.query.Query	buildQuery(org.statefulj.persistence.mongo.StateDocumentImpl state, State<T> current)
protected org.springframework.data.mongodb.core.query.Update	buildUpdate(State<T> current, State<T> next)
protected org.statefulj.persistence.mongo.StateDocumentImpl	createStateDocument(T stateful)
protected Field	findIdField(Class<?> clazz)
protected org.statefulj.persistence.mongo.StateDocumentImpl	findStateDoc(String id)
protected org.springframework.data.mongodb.core.MongoTemplate	getMongoTemplate()
protected String	getState(T stateful)
protected org.statefulj.persistence.mongo.StateDocumentImpl	getStateDocument(T stateful)
protected Class<?>	getStateFieldType()
void	postProcessBeanDefinitionRegistry(org.springframework.beans.factory.support.BeanDefinitionRegistry registry)
void	postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCurrent(T stateful, State<T> current, State<T> next) Set the current State.
protected void	setState(T stateful, String state)
protected void	setStateDocument(T stateful, StateDocument stateDoc)
protected void	throwStaleState(String current, String next)
protected void	updateInMemory(T stateful, org.statefulj.persistence.mongo.StateDocumentImpl stateDoc, String current, String next)
protected org.statefulj.persistence.mongo.StateDocumentImpl	updateStateDoc(org.springframework.data.mongodb.core.query.Query query, org.springframework.data.mongodb.core.query.Update update)
protected boolean	validStateField(Field stateField)

Methods inherited from class org.statefulj.persistence.common.AbstractPersister

buildIdFieldAccessor, buildStateFieldAccessor, findStateField, getClazz, getCurrent, getId, getIdField, getIdFieldAccessor, getStartState, getStateField, getStateFieldAccessor, setStartState, setStates, throwStaleState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.statefulj.fsm.Persister

getCurrent, setStartState, setStates

Constructor Detail

MongoPersister

public MongoPersister(List<State<T>> states,
                      State<T> startState,
                      Class<T> clazz,
                      org.springframework.data.mongodb.core.MongoTemplate mongoTemplate)

Instantiate the MongoPersister with a specified template. The State field on the Entity will be determined by inspection of Entity for the @State annotation

Parameters:

states - List of the States

startState - The Start State

clazz - The Managed Entity class

mongoTemplate - MongoTemplate to use to persist the Managed Entity

MongoPersister

public MongoPersister(List<State<T>> states,
                      String stateFieldName,
                      State<T> startState,
                      Class<T> clazz,
                      org.springframework.data.mongodb.core.MongoTemplate mongoTemplate)

Instantiate the MongoPersister with a specified template. The MongoPersister will use the stateFieldName to determine the State field.

Parameters:

states - List of the States

stateFieldName - The name of the State Field

startState - The Start State

clazz - The Managed Entity class

mongoTemplate - MongoTemplate to use to persist the Managed Entity

MongoPersister

public MongoPersister(List<State<T>> states,
                      State<T> startState,
                      Class<T> clazz,
                      String repoId)

Instantiate the MongoPersister with the id of the MongoRepository bean for the Managed Entity. The State field on the Entity will be determined by inspection of Entity for the @State annotation

Parameters:

states - List of the States

startState - The Start State

clazz - The Managed Entity class

repoId - Bean Id of the Managed Entity's MongoRepository

MongoPersister

public MongoPersister(List<State<T>> states,
                      String stateFieldName,
                      State<T> startState,
                      Class<T> clazz,
                      String repoId)

Instantiate the MongoPersister with the id of the MongoRepository bean for the Managed Entity. The MongoPersister will use the stateFieldName to determine the State field.

Parameters:

states - List of States

stateFieldName - The name of the State Field

startState - The Start State

clazz - The Managed Entity class

repoId - Bean Id of the Managed Entity's MongoRepository

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setCurrent

public void setCurrent(T stateful,
                       State<T> current,
                       State<T> next)
                throws StaleStateException

Set the current State. This method will ensure that the state in the db matches the expected current state. If not, it will throw a StateStateException

Specified by:

setCurrent in interface Persister<T>

Specified by:

setCurrent in class AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

Parameters:

stateful - Stateful Entity

current - Expected current State

next - The value of the next State

Throws:

StaleStateException - thrown if the value of the State does not equal to the provided current State

postProcessBeanFactory

public void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
                            throws org.springframework.beans.BeansException

Specified by:

postProcessBeanFactory in interface org.springframework.beans.factory.config.BeanFactoryPostProcessor

Throws:

org.springframework.beans.BeansException

postProcessBeanDefinitionRegistry

public void postProcessBeanDefinitionRegistry(org.springframework.beans.factory.support.BeanDefinitionRegistry registry)
                                       throws org.springframework.beans.BeansException

Specified by:

postProcessBeanDefinitionRegistry in interface org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor

Throws:

org.springframework.beans.BeansException

validStateField

protected boolean validStateField(Field stateField)

Specified by:

validStateField in class AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

findIdField

protected Field findIdField(Class<?> clazz)

Specified by:

findIdField in class AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

getStateFieldType

protected Class<?> getStateFieldType()

Specified by:

getStateFieldType in class AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

buildQuery

protected org.springframework.data.mongodb.core.query.Query buildQuery(org.statefulj.persistence.mongo.StateDocumentImpl state,
                                                                       State<T> current)

buildUpdate

protected org.springframework.data.mongodb.core.query.Update buildUpdate(State<T> current,
                                                                         State<T> next)

getState

protected String getState(T stateful)
                   throws NoSuchFieldException,
                          SecurityException,
                          IllegalArgumentException,
                          IllegalAccessException

Overrides:

getState in class AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

Throws:

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException

setState

protected void setState(T stateful,
                        String state)
                 throws IllegalArgumentException,
                        IllegalAccessException,
                        NoSuchFieldException,
                        SecurityException

Overrides:

setState in class AbstractPersister<T,org.statefulj.persistence.mongo.StateDocumentImpl>

Throws:

IllegalArgumentException

IllegalAccessException

NoSuchFieldException

SecurityException

getStateDocument

protected org.statefulj.persistence.mongo.StateDocumentImpl getStateDocument(T stateful)
                                                                      throws IllegalArgumentException,
                                                                             IllegalAccessException

Throws:

IllegalArgumentException

IllegalAccessException

createStateDocument

protected org.statefulj.persistence.mongo.StateDocumentImpl createStateDocument(T stateful)
                                                                         throws IllegalArgumentException,
                                                                                IllegalAccessException,
                                                                                SecurityException,
                                                                                NoSuchFieldException

Throws:

IllegalArgumentException

IllegalAccessException

SecurityException

NoSuchFieldException

setStateDocument

protected void setStateDocument(T stateful,
                                StateDocument stateDoc)
                         throws IllegalArgumentException,
                                IllegalAccessException

Throws:

IllegalArgumentException

IllegalAccessException

updateInMemory

protected void updateInMemory(T stateful,
                              org.statefulj.persistence.mongo.StateDocumentImpl stateDoc,
                              String current,
                              String next)
                       throws IllegalArgumentException,
                              IllegalAccessException,
                              NoSuchFieldException,
                              SecurityException,
                              StaleStateException

Throws:

IllegalArgumentException

IllegalAccessException

NoSuchFieldException

SecurityException

StaleStateException

throwStaleState

protected void throwStaleState(String current,
                               String next)
                        throws StaleStateException

Throws:

StaleStateException

getMongoTemplate

protected org.springframework.data.mongodb.core.MongoTemplate getMongoTemplate()

updateStateDoc

protected org.statefulj.persistence.mongo.StateDocumentImpl updateStateDoc(org.springframework.data.mongodb.core.query.Query query,
                                                                           org.springframework.data.mongodb.core.query.Update update)

findStateDoc

protected org.statefulj.persistence.mongo.StateDocumentImpl findStateDoc(String id)