Package org.openmuc.jeebus.ship.state.machine

Class StateMachine

java.lang.Object

org.openmuc.jeebus.ship.state.machine.StateMachine

All Implemented Interfaces:

StateHandlerContext

public class StateMachine
extends java.lang.Object
implements StateHandlerContext

SHIP state machine, handles connection setup until Connection Data Exchange is reached.

Field Summary

Fields

Modifier and Type	Field	Description
protected StateHandler	actions
protected java.lang.Class<?>	extraDataType
protected ShipConnection	shipConnection
protected State	state
protected java.lang.Object	stateExtraData
protected java.util.concurrent.ScheduledExecutorService	timeoutExecutor

Constructor Summary

Constructors

Constructor	Description
StateMachine(ShipConnection shipConnection, UserInterface userInterface, Configuration config)
StateMachine(ShipConnection shipConnection, UserInterface userInterface, Configuration config, State initial, java.lang.Object extraData)

Method Summary

Modifier and Type	Method	Description
void	begin()
void	closeConnection()	Close the SPINE connection with no further messaging.
void	enableConnectionDataExchange()	Enable Connection Data Exchange (it cannot be disabled afterward)
Configuration	getConfig()
int	getDefaultTimeoutSeconds(SpecifiedTimeout which)
<T> T	getExtraData(java.lang.Class<T> dataClass)	Retrieve data previously stored with StateHandlerContext.setExtraData(Object).
State	getState()
java.lang.Integer	getTimeoutStatus(SpecifiedTimeout which)	Query the status of a specific timeout.
int	getTrustLevel()
UserInterface	getUserInterface()
void	increaseTimeout(SpecifiedTimeout which)	Prolong a specific timeout by the initial value.
void	increaseTimeout(SpecifiedTimeout which, int secondsDelta)	Prolong a specific timeout.
boolean	isServerSide()
void	messageReceived(byte[] msg)
void	processMessage()	Indicate that the handler is ready to process a waiting message from the communication partner.
boolean	requireTrust(int minimumTrust)
void	sendMessage(byte[] msg)	Send a message to the communication partner.
void	setCommPartnerTrusted()
void	setExtraData(java.lang.Object stateExtraData)	Store some arbitrary extra data.
void	setPeerSkiAuthenticated()
void	setTimeoutExecutor(java.util.concurrent.ScheduledExecutorService executor)	Replace the executor used for scheduling timeouts (this is mainly useful for testing).
void	startTimeout(SpecifiedTimeout which)	Start a specific timeout with the default duration.
void	startTimeout(SpecifiedTimeout which, int fixedDelay)	Start a specific timeout with the given duration.
void	startTimeout(SpecifiedTimeout which, int amount, java.util.concurrent.TimeUnit unit)	Start a specific timeout with the given duration.
void	stopTimeouts(SpecifiedTimeout... which)	Stop one or more timeouts.
protected State	swapState(State newState)
void	transitionTo(State newState)	Transition the state machine.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmuc.jeebus.ship.state.machine.StateHandlerContext

stopAllTimeouts

Field Detail

state

protected State state

actions

protected StateHandler actions

extraDataType

protected java.lang.Class<?> extraDataType

stateExtraData

protected java.lang.Object stateExtraData

shipConnection

protected final ShipConnection shipConnection

timeoutExecutor

protected java.util.concurrent.ScheduledExecutorService timeoutExecutor

Constructor Detail

StateMachine

public StateMachine(ShipConnection shipConnection,
                    UserInterface userInterface,
                    Configuration config,
                    State initial,
                    java.lang.Object extraData)

StateMachine

public StateMachine(ShipConnection shipConnection,
                    UserInterface userInterface,
                    Configuration config)

Method Detail

begin

public void begin()

transitionTo

public void transitionTo(State newState)

Description copied from interface: StateHandlerContext

Transition the state machine.

Specified by:

transitionTo in interface StateHandlerContext

Parameters:

newState - which state to enter now

swapState

protected State swapState(State newState)

sendMessage

public void sendMessage(byte[] msg)

Description copied from interface: StateHandlerContext

Send a message to the communication partner.

Specified by:

sendMessage in interface StateHandlerContext

Parameters:

msg - the message to send

messageReceived

public void messageReceived(byte[] msg)

processMessage

public void processMessage()

Description copied from interface: StateHandlerContext

Indicate that the handler is ready to process a waiting message from the communication partner.

Specified by:

processMessage in interface StateHandlerContext

getState

public State getState()

Specified by:

getState in interface StateHandlerContext

Returns:

the current state. Mostly useful for handlers that handle multiple states.

closeConnection

public void closeConnection()

Description copied from interface: StateHandlerContext

Close the SPINE connection with no further messaging.

Specified by:

closeConnection in interface StateHandlerContext

getConfig

public Configuration getConfig()

Specified by:

getConfig in interface StateHandlerContext

Returns:

the configuration for this node

getDefaultTimeoutSeconds

public int getDefaultTimeoutSeconds(SpecifiedTimeout which)

setTimeoutExecutor

public void setTimeoutExecutor(java.util.concurrent.ScheduledExecutorService executor)

Replace the executor used for scheduling timeouts (this is mainly useful for testing). Cannot be called while there are already timeouts scheduled.

Parameters:

executor - the new executor to use

stopTimeouts

public void stopTimeouts(SpecifiedTimeout... which)

Description copied from interface: StateHandlerContext

Stop one or more timeouts.

Specified by:

stopTimeouts in interface StateHandlerContext

Parameters:

which - which timeout(s) to stop.

startTimeout

public void startTimeout(SpecifiedTimeout which)

Description copied from interface: StateHandlerContext

Start a specific timeout with the default duration.

Specified by:

startTimeout in interface StateHandlerContext

Parameters:

which - which timeout to start.

startTimeout

public void startTimeout(SpecifiedTimeout which,
                         int fixedDelay)

Description copied from interface: StateHandlerContext

Start a specific timeout with the given duration.

Specified by:

startTimeout in interface StateHandlerContext

Parameters:

which - which timeout to start

fixedDelay - how long it should run

startTimeout

public void startTimeout(SpecifiedTimeout which,
                         int amount,
                         java.util.concurrent.TimeUnit unit)

Description copied from interface: StateHandlerContext

Start a specific timeout with the given duration.

Specified by:

startTimeout in interface StateHandlerContext

Parameters:

which - which timeout to start

amount - how long it should run

unit - the unit for amount

getTimeoutStatus

public java.lang.Integer getTimeoutStatus(SpecifiedTimeout which)

Description copied from interface: StateHandlerContext

Query the status of a specific timeout.

Specified by:

getTimeoutStatus in interface StateHandlerContext

Parameters:

which - which timeout to get the status of

Returns:

time remaining (in seconds), or null if not active.

isServerSide

public boolean isServerSide()

Specified by:

isServerSide in interface StateHandlerContext

Returns:

whether the caller is on the server side of a connection.

requireTrust

public boolean requireTrust(int minimumTrust)

Specified by:

requireTrust in interface StateHandlerContext

Parameters:

minimumTrust - required trust level

Returns:

whether the communication partner is trusted at least this much

getTrustLevel

public int getTrustLevel()

increaseTimeout

public void increaseTimeout(SpecifiedTimeout which)

Description copied from interface: StateHandlerContext

Prolong a specific timeout by the initial value.

Specified by:

increaseTimeout in interface StateHandlerContext

Parameters:

which - which timeout to prolong

increaseTimeout

public void increaseTimeout(SpecifiedTimeout which,
                            int secondsDelta)

Description copied from interface: StateHandlerContext

Prolong a specific timeout.

Specified by:

increaseTimeout in interface StateHandlerContext

Parameters:

which - which timeout to prolong

secondsDelta - how many seconds to add

setExtraData

public void setExtraData(java.lang.Object stateExtraData)

Description copied from interface: StateHandlerContext

Store some arbitrary extra data.

The handler must be marked with a StateHandler.UsesExtraData annotation indicating the type of the extra data it uses.

Specified by:

setExtraData in interface StateHandlerContext

Parameters:

stateExtraData - the data to store.

getExtraData

public <T> T getExtraData(java.lang.Class<T> dataClass)

Description copied from interface: StateHandlerContext

Retrieve data previously stored with StateHandlerContext.setExtraData(Object).

The handler must be marked with a StateHandler.UsesExtraData annotation indicating the type of the extra data it uses.

Specified by:

getExtraData in interface StateHandlerContext

Type Parameters:

T - type of the data to retrieve

Parameters:

dataClass - class of the data to retrieve

Returns:

stored data, or null if not present.

getUserInterface

public UserInterface getUserInterface()

Specified by:

getUserInterface in interface StateHandlerContext

Returns:

the interface to prompt the user about some action

enableConnectionDataExchange

public void enableConnectionDataExchange()

Description copied from interface: StateHandlerContext

Enable Connection Data Exchange (it cannot be disabled afterward)

Specified by:

enableConnectionDataExchange in interface StateHandlerContext

setPeerSkiAuthenticated

public void setPeerSkiAuthenticated()

Specified by:

setPeerSkiAuthenticated in interface StateHandlerContext

setCommPartnerTrusted

public void setCommPartnerTrusted()