de.fhg.aisec.ids.comm.ws.protocol.fsm

Class FSM

java.lang.Object

de.fhg.aisec.ids.comm.ws.protocol.fsm.FSM

Direct Known Subclasses:

ClientProtocolMachine, ServerProtocolMachine

public class FSM
extends java.lang.Object

Implementation of a finite state machine (FSM).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentState
protected java.util.HashSet<ChangeListener>	failChangeListeners
protected java.util.Map<java.lang.String,de.fhg.aisec.ids.comm.ws.protocol.fsm.State>	states
protected java.util.HashSet<ChangeListener>	successChangeListeners

Constructor Summary

Constructors

Constructor and Description
FSM()

Method Summary

Modifier and Type	Method and Description
void	addFailChangeListener(ChangeListener cl)
void	addState(ProtocolState state)
void	addState(java.lang.String state, java.lang.Runnable entryCode, java.lang.Runnable exitCode, java.lang.Runnable alwaysRunCode) Defines an additional state.
void	addSuccessChangeListener(ChangeListener cl)
void	addTransition(Transition trans) Add a new transition to this FSM.
void	feedEvent(Event event)
java.lang.String	getMetaData()
de.fhg.aisec.ids.api.conm.RatResult	getRatResult()
java.lang.String	getState()
void	handleRatResult(de.fhg.aisec.ids.api.conm.RatResult attestationResult)
void	reset() Resets FSM to it initial state
void	setInitialState(ProtocolState state) Defines initial state of this FSM.
void	setMetaData(java.lang.String metaData)
java.lang.String	toDot()

Methods inherited from class java.lang.Object

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

Field Detail

currentState

protected java.lang.String currentState

states

protected java.util.Map<java.lang.String,de.fhg.aisec.ids.comm.ws.protocol.fsm.State> states

successChangeListeners

protected java.util.HashSet<ChangeListener> successChangeListeners

failChangeListeners

protected java.util.HashSet<ChangeListener> failChangeListeners

Constructor Detail

FSM

public FSM()

Method Detail

getState

public java.lang.String getState()

addState

public void addState(ProtocolState state)

addState

public void addState(java.lang.String state,
                     java.lang.Runnable entryCode,
                     java.lang.Runnable exitCode,
                     java.lang.Runnable alwaysRunCode)

Defines an additional state. A state is identified by a name and has three blocks of code assigned to it:

1) entryCode is executed when the state is entered from another state (after the transition's code has been executed)

2) exitCode is executed when the state is left for another state (before the transition's code is executed)

3) alwaysRunCode is always executed when the FSM enters this state (even if it has been in that state before)

All three Runnables may be null. Their result has no impact on the FSM's state, Exceptions thrown are ignored.

Parameters:

state -

entryCode -

exitCode -

alwaysRunCode -

setInitialState

public void setInitialState(ProtocolState state)

Defines initial state of this FSM. If no initial state is defined explicitly, the first added state is the initial state.

Parameters:

state - The initial state of this FSM

reset

public void reset()

Resets FSM to it initial state

addTransition

public void addTransition(Transition trans)

Add a new transition to this FSM.

Parameters:

trans - The transition to be added to this FSM

addSuccessChangeListener

public void addSuccessChangeListener(ChangeListener cl)

addFailChangeListener

public void addFailChangeListener(ChangeListener cl)

feedEvent

public void feedEvent(Event event)

toDot

public java.lang.String toDot()

handleRatResult

public void handleRatResult(de.fhg.aisec.ids.api.conm.RatResult attestationResult)

getRatResult

public de.fhg.aisec.ids.api.conm.RatResult getRatResult()

setMetaData

public void setMetaData(java.lang.String metaData)

getMetaData

public java.lang.String getMetaData()