com.cordys.mdm.statemachine.sminterface.persistor

Class AbstractMDMStateMachinePersistor

java.lang.Object

com.cordys.mdm.statemachine.sminterface.persistor.AbstractMDMStateMachinePersistor

public abstract class AbstractMDMStateMachinePersistor
extends java.lang.Object

Extend this class to implement a persister which can handle hierarchical/complex schemas as the default persister provided out of box by MDM supports only flat schema and cannot handle parent-child relationship as well as complex schemas.

Author:

avasudev

Field Summary

Fields

Modifier and Type	Field and Description
protected CodDefinition	codDefinition
static java.lang.String	DB_EVENT
static java.lang.String	DEFAULT_PERSISTER
static java.lang.String	DESTINATION_STATE_ID
static java.lang.String	HISTORY_ID
static java.lang.String	HISTORYPOINTERS_XML
static java.lang.String	SEBUSINESSOBJECTXML
static java.lang.String	SEINSTANCEID
static java.lang.String	SEMETADATA
static java.lang.String	SEMODIFIEDDATE
static java.lang.String	SEOPERATION
static java.lang.String	SEORGANIZATION
static java.lang.String	SESOURCE
static java.lang.String	SESTATENAME

Constructor Summary

Constructors

Constructor and Description
AbstractMDMStateMachinePersistor(CodDefinition codDefinition) Constructs an AbstractMDMStateMachinePersistor with the specified CodDefinition

Method Summary

Modifier and Type	Method and Description
void	audit(Instance instance, java.lang.String eventName) This method will be used to record/audit the changes happening on a state instance and is invoked in the following cases.
void	audit(Instance instance, java.lang.String eventName, java.lang.Throwable executionException) This method will be used to record/audit the changes happening on a state instance and is invoked in the following cases.
abstract Instance	getInstance(BusinessObject bizzObject) This method should return state instance for the given input from the underlying persistent store.
abstract Instance	getInstance(java.lang.String instanceID) This method should return state instance for the given input from the underlying persistent store.
abstract void	removeInstance(java.lang.String instanceID) This method is invoked when a state instance enters the final state.
abstract void	saveInstance(Instance instance, boolean insert) This method is invoked when a state instance has successfully entered the state i.e.

Methods inherited from class java.lang.Object

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

Field Detail

SEINSTANCEID

public static final java.lang.String SEINSTANCEID

See Also:

Constant Field Values

SEBUSINESSOBJECTXML

public static final java.lang.String SEBUSINESSOBJECTXML

See Also:

Constant Field Values

SEMETADATA

public static final java.lang.String SEMETADATA

See Also:

Constant Field Values

SESTATENAME

public static final java.lang.String SESTATENAME

See Also:

Constant Field Values

SEMODIFIEDDATE

public static final java.lang.String SEMODIFIEDDATE

See Also:

Constant Field Values

SEOPERATION

public static final java.lang.String SEOPERATION

See Also:

Constant Field Values

SESOURCE

public static final java.lang.String SESOURCE

See Also:

Constant Field Values

SEORGANIZATION

public static final java.lang.String SEORGANIZATION

See Also:

Constant Field Values

HISTORYPOINTERS_XML

public static final java.lang.String HISTORYPOINTERS_XML

See Also:

Constant Field Values

HISTORY_ID

public static final java.lang.String HISTORY_ID

See Also:

Constant Field Values

DESTINATION_STATE_ID

public static final java.lang.String DESTINATION_STATE_ID

See Also:

Constant Field Values

DB_EVENT

public static final java.lang.String DB_EVENT

See Also:

Constant Field Values

DEFAULT_PERSISTER

public static final java.lang.String DEFAULT_PERSISTER

codDefinition

protected CodDefinition codDefinition

Constructor Detail

AbstractMDMStateMachinePersistor

public AbstractMDMStateMachinePersistor(CodDefinition codDefinition)
                                 throws MDMStateMachinePersistorException

Constructs an AbstractMDMStateMachinePersistor with the specified CodDefinition

Parameters:

codDefinition -

Throws:

MDMStateMachinePersistorException

Method Detail

saveInstance

public abstract void saveInstance(Instance instance,
                                  boolean insert)
                           throws MDMStateMachinePersistorException

This method is invoked when a state instance has successfully entered the state i.e. completed the state entry. Any updates to the business object and/or to the metadata have to be persisted here so that the state instance can be retrieved later by invoking getInstance(BusinessObject) or getInstance(String) methods.

Parameters:

instance - state instance to be saved

insert - true if state is initial state

Throws:

MDMStateMachinePersistorException

removeInstance

public abstract void removeInstance(java.lang.String instanceID)
                             throws MDMStateMachinePersistorException

This method is invoked when a state instance enters the final state. The code to remove the instance from the persistent store should go here.

Parameters:

instanceID - unique id of the state instance

Throws:

MDMStateMachinePersistorException

getInstance

public abstract Instance getInstance(BusinessObject bizzObject)
                              throws MDMStateMachinePersistorException

This method should return state instance for the given input from the underlying persistent store.

Parameters:

bizzObject - BusinessObject wrapper around the state machine instance payload

Returns:

Instance returns the state instance or null if state instance doesn't exist for the given input

Throws:

MDMStateMachinePersistorException

getInstance

public abstract Instance getInstance(java.lang.String instanceID)
                              throws MDMStateMachinePersistorException

This method should return state instance for the given input from the underlying persistent store.

Parameters:

instanceID - unique id of the state instance

Returns:

Instance returns the state instance or null if state instance doesn't exist for the given input

Throws:

MDMStateMachinePersistorException

audit

public final void audit(Instance instance,
                        java.lang.String eventName)

This method will be used to record/audit the changes happening on a state instance and is invoked in the following cases.

• An instance has successfully completed the state entry
• An exception occurred while executing any of the activities in entry/do/exit

Parameters:

instance - state instance to be audited

eventName - event name associated with the transition. null if no event is defined on the transition.

audit

public final void audit(Instance instance,
                        java.lang.String eventName,
                        java.lang.Throwable executionException)

This method will be used to record/audit the changes happening on a state instance and is invoked in the following cases.

• An instance has successfully completed the state entry
• An exception occurred while executing any of the activities in entry/do/exit

Parameters:

instance - state instance to be audited

eventName - event name associated with the transition. null if no event is defined on the transition.

executionException - exception thrown during activity execution. null otherwise.