com.netflix.genie.agent.execution.statemachine

Class StateMachineAutoConfiguration

java.lang.Object

com.netflix.genie.agent.execution.statemachine.StateMachineAutoConfiguration

@Configuration
public class StateMachineAutoConfiguration
extends java.lang.Object

Spring auto configuration of JobExecutionStateMachine state machine for the agent process.

Since:

4.0.0

Constructor Summary

Constructors

Constructor and Description
StateMachineAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<org.apache.commons.lang3.tuple.Triple<States,Events,States>>	eventDrivenTransitions() Provide a lazy bean definition for the event driven transitions within the state machine.
JobExecutionStateMachine	jobExecutionStateMachine(org.springframework.statemachine.StateMachine<States,Events> stateMachine) Provide a lazy JobExecutionStateMachine bean if one hasn't already been defined.
LoggingListener	loggingListener() Provide a lazy LoggingListener bean.
org.springframework.statemachine.StateMachine<States,Events>	stateMachine(java.util.Collection<org.apache.commons.lang3.tuple.Pair<States,StateAction>> statesWithActions, java.util.Collection<org.apache.commons.lang3.tuple.Triple<States,Events,States>> eventDrivenTransitions, java.util.Collection<States> statesWithErrorTransition, java.util.Collection<JobExecutionListener> listeners) Provide a lazy StateMachine instance configured with the current model expected for job execution.
java.util.Collection<org.apache.commons.lang3.tuple.Pair<States,StateAction>>	statesWithActions(StateAction.Initialize initializeAction, StateAction.ConfigureAgent configureAgentAction, StateAction.ResolveJobSpecification resolveJobSpecificationAction, StateAction.SetUpJob setUpJobAction, StateAction.LaunchJob launchJobAction, StateAction.MonitorJob monitorJobAction, StateAction.CleanupJob cleanupJobAction, StateAction.Shutdown shutdownAction, StateAction.HandleError handleErrorAction) Provide a lazy bean which is a collection of all the states the state machine should contain which have an associated action.
java.util.Collection<States>	statesWithErrorTransition() Provide a bean with a collection of states which should have transitions to an error action when an error occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateMachineAutoConfiguration

public StateMachineAutoConfiguration()

Method Detail

loggingListener

@Bean
 @Lazy
public LoggingListener loggingListener()

Provide a lazy LoggingListener bean.

Returns:

A LoggingListener instance

jobExecutionStateMachine

@Bean
 @Lazy
 @ConditionalOnMissingBean(value=JobExecutionStateMachine.class)
public JobExecutionStateMachine jobExecutionStateMachine(org.springframework.statemachine.StateMachine<States,Events> stateMachine)

Provide a lazy JobExecutionStateMachine bean if one hasn't already been defined.

Parameters:

stateMachine - The state machine to use for job execution

Returns:

A JobExecutionStateMachineImpl instance

stateMachine

@Bean
 @Lazy
public org.springframework.statemachine.StateMachine<States,Events> stateMachine(java.util.Collection<org.apache.commons.lang3.tuple.Pair<States,StateAction>> statesWithActions,
                                                                                              java.util.Collection<org.apache.commons.lang3.tuple.Triple<States,Events,States>> eventDrivenTransitions,
                                                                                              java.util.Collection<States> statesWithErrorTransition,
                                                                                              java.util.Collection<JobExecutionListener> listeners)
                                                                                       throws java.lang.Exception

Provide a lazy StateMachine instance configured with the current model expected for job execution.

Parameters:

statesWithActions - The states to use that have actions associated with them available in the Spring context

eventDrivenTransitions - The event driven transitions available in the Spring context

statesWithErrorTransition - The states that have error transitions associated with them available in the Spring context

listeners - Any JobExecutionListener implementations available in the Spring context

Returns:

A StateMachine instance configured with the available options from the application context

Throws:

java.lang.Exception - On any error configuring the state machine

statesWithActions

@Bean
 @Lazy
public java.util.Collection<org.apache.commons.lang3.tuple.Pair<States,StateAction>> statesWithActions(StateAction.Initialize initializeAction,
                                                                                                                    StateAction.ConfigureAgent configureAgentAction,
                                                                                                                    StateAction.ResolveJobSpecification resolveJobSpecificationAction,
                                                                                                                    StateAction.SetUpJob setUpJobAction,
                                                                                                                    StateAction.LaunchJob launchJobAction,
                                                                                                                    StateAction.MonitorJob monitorJobAction,
                                                                                                                    StateAction.CleanupJob cleanupJobAction,
                                                                                                                    StateAction.Shutdown shutdownAction,
                                                                                                                    StateAction.HandleError handleErrorAction)

Provide a lazy bean which is a collection of all the states the state machine should contain which have an associated action. All should implement StateAction.

Parameters:

initializeAction - The initialization action

configureAgentAction - The configure agent action

resolveJobSpecificationAction - The resolve job specification action

setUpJobAction - The setup job action

launchJobAction - The launch job action

monitorJobAction - The monitor job action

cleanupJobAction - The cleanup job action

shutdownAction - The shut down action

handleErrorAction - The handle error action

Returns:

A collection of all the actions

eventDrivenTransitions

@Bean
 @Lazy
public java.util.Collection<org.apache.commons.lang3.tuple.Triple<States,Events,States>> eventDrivenTransitions()

Provide a lazy bean definition for the event driven transitions within the state machine.

Returns:

A collection of transitions based on source state, event, destination state

statesWithErrorTransition

@Bean
 @Lazy
public java.util.Collection<States> statesWithErrorTransition()

Provide a bean with a collection of states which should have transitions to an error action when an error occurs.

Returns:

The collection of States