org.springframework.cloud.skipper.server.statemachine

Class SkipperStateMachineService

java.lang.Object

org.springframework.cloud.skipper.server.statemachine.SkipperStateMachineService

public class SkipperStateMachineService
extends Object

Service class for state machine hiding its operational logic.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SkipperStateMachineService.SkipperEventHeaders Definitions of possible event headers used by a machine.
static class	SkipperStateMachineService.SkipperEvents Enumeration of all possible events used by a machine.
static class	SkipperStateMachineService.SkipperStates Enumeration of all possible states used by a machine.
static class	SkipperStateMachineService.SkipperVariables Extended state variable names for skipper statemachine.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATEMACHINE_FACTORY_BEAN_NAME

Constructor Summary

Constructors

Constructor and Description
SkipperStateMachineService(org.springframework.statemachine.service.StateMachineService<SkipperStateMachineService.SkipperStates,SkipperStateMachineService.SkipperEvents> stateMachineService) Instantiates a new skipper state machine service.

Method Summary

Modifier and Type	Method and Description
boolean	cancelRelease(String releaseName) Send an event to attempt a cancellation of an existing operation.
org.springframework.cloud.skipper.domain.Release	deleteRelease(String releaseName, org.springframework.cloud.skipper.domain.DeleteProperties deleteProperties) Delete release.
org.springframework.cloud.skipper.domain.Release	installRelease(org.springframework.cloud.skipper.domain.InstallRequest installRequest) Install release.
org.springframework.cloud.skipper.domain.Release	installRelease(Long id, org.springframework.cloud.skipper.domain.InstallProperties installProperties) Install release.
org.springframework.cloud.skipper.domain.Release	rollbackRelease(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest) Rollback release.
org.springframework.cloud.skipper.domain.Release	scaleRelease(String releaseName, org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest) Scale release.
org.springframework.cloud.skipper.domain.Release	upgradeRelease(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest) Upgrade release.

Methods inherited from class java.lang.Object

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

Field Detail

STATEMACHINE_FACTORY_BEAN_NAME

public static final String STATEMACHINE_FACTORY_BEAN_NAME

See Also:

Constant Field Values

Constructor Detail

SkipperStateMachineService

public SkipperStateMachineService(org.springframework.statemachine.service.StateMachineService<SkipperStateMachineService.SkipperStates,SkipperStateMachineService.SkipperEvents> stateMachineService)

Instantiates a new skipper state machine service.

Parameters:

stateMachineService - the state machine service

Method Detail

installRelease

public org.springframework.cloud.skipper.domain.Release installRelease(org.springframework.cloud.skipper.domain.InstallRequest installRequest)

Install release.

Parameters:

installRequest - the install request

Returns:

the release

installRelease

public org.springframework.cloud.skipper.domain.Release installRelease(Long id,
                                                                       org.springframework.cloud.skipper.domain.InstallProperties installProperties)

Install release.

Parameters:

id - the id

installProperties - the install properties

Returns:

the release

upgradeRelease

public org.springframework.cloud.skipper.domain.Release upgradeRelease(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)

Upgrade release.

Parameters:

upgradeRequest - the upgrade request

Returns:

the release

scaleRelease

public org.springframework.cloud.skipper.domain.Release scaleRelease(String releaseName,
                                                                     org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest)

Scale release.

Parameters:

releaseName - the release name

scaleRequest - the scale request

Returns:

the release

deleteRelease

public org.springframework.cloud.skipper.domain.Release deleteRelease(String releaseName,
                                                                      org.springframework.cloud.skipper.domain.DeleteProperties deleteProperties)

Delete release.

Parameters:

releaseName - the release name

Returns:

the release

rollbackRelease

public org.springframework.cloud.skipper.domain.Release rollbackRelease(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest)

Rollback release.

Parameters:

rollbackRequest - the rollback request

Returns:

the release

cancelRelease

public boolean cancelRelease(String releaseName)

Send an event to attempt a cancellation of an existing operation.

Parameters:

releaseName - the release name

Returns:

true if event were sent