com.sdl.delivery.deployer.api.processing.pipeline

Interface StateStore

public interface StateStore

It represents a 'State Store' used by the 'Processing Service' to keep the status of executions/pipelines/steps being or to be processed.

Method Summary

Modifier and Type	Method and Description
void	deleteBinaries(List<String> binariesForRemove) Remove binaries in binary storage.
List<String>	deleteExecution(String executionId) Deletes an Execution and all dependent entities excep binaries in storage (moved out to decrease transaction duration).
boolean	executionStateExists(String executionId) Check if exists the 'Deployment State' by the given id.
Optional<ExecutionState>	findExecutionState(String executionId) Find the 'Deployment State' by the given id as an optional.
List<ExecutionState>	findTopExecutionStates(Integer limitSize) Find top execution states with specific limit size.
void	setExecutionState(String executionId, Status status, String message) Set the status of overall 'Deployment Execution'.
void	setPipelineState(String executionId, String pipelineId, Status status, String message) Set the status for the given pipeline in the scope of the referenced 'Deployment Execution'.
void	setStepState(String executionId, String pipelineId, String stepId, Status status, String message) Set the status for the given step in the scope of the referenced 'Deployment Execution'.

Method Detail

setExecutionState

void setExecutionState(String executionId,
                       Status status,
                       String message)

Set the status of overall 'Deployment Execution'.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

status - The status to set.

message - The status message.

setPipelineState

void setPipelineState(String executionId,
                      String pipelineId,
                      Status status,
                      String message)

Set the status for the given pipeline in the scope of the referenced 'Deployment Execution'.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

pipelineId - The id of the pipeline to set the status for.

status - The status to set.

message - The status message.

setStepState

void setStepState(String executionId,
                  String pipelineId,
                  String stepId,
                  Status status,
                  String message)

Set the status for the given step in the scope of the referenced 'Deployment Execution'.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

pipelineId - The id of the pipeline containing the step to set the status for.

stepId - The id of the step to set the status for.

status - The status to set.

message - The status message.

findExecutionState

Optional<ExecutionState> findExecutionState(String executionId)

Find the 'Deployment State' by the given id as an optional.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

Returns:

The found 'Deployment Execution' state as an optional.

executionStateExists

boolean executionStateExists(String executionId)

Check if exists the 'Deployment State' by the given id.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

Returns:

If found 'Deployment Execution' - true.

deleteExecution

List<String> deleteExecution(String executionId)

Deletes an Execution and all dependent entities excep binaries in storage (moved out to decrease transaction duration).

Parameters:

executionId - executionId

deleteBinaries

void deleteBinaries(List<String> binariesForRemove)

Remove binaries in binary storage.

Parameters:

binariesForRemove - - list of binaries for remove

findTopExecutionStates

List<ExecutionState> findTopExecutionStates(Integer limitSize)

Find top execution states with specific limit size.

Parameters:

limitSize - limit size

Returns:

list of execution states