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

Interface StepDataProvider

public interface StepDataProvider

StepDataProvider which helps in accessing step data within scope of a 'Deployment Execution'.

Method Summary

Modifier and Type	Method and Description
default <T extends StepData> T	findMandatorySingleStepData(String executionId, String key, Class<T> stepDataClass) Search for mandatory single step data.
default List<StepData>	findMandatoryStepDataStartsWith(String executionId, String keyPrefix) Find a list 'Step Data' identified by execution id and key which starts as provided one.
default <T extends StepData> Optional<T>	findSingleStepData(String executionId, String key, Class<T> stepDataClass) Search for a single step data stored in the state store.
List<StepData>	findStepData(String executionId, String key) Find a list of 'Step Data' identified by the supplied key for the given execution id.
Optional<StepData>	findStepData(String executionId, String pipelineId, String stepId, String key) Find a 'Step Data' identified by the supplied key for the given step in the scope of the referenced 'Deployment Execution'.
List<String>	findStepDataKeys(String executionId, String keyPrefix) Find a list of 'Step Data' keys for execution id which key starts with provided prefix.
List<StepData>	findStepDataStartsWith(String executionId, String keyPrefix) Find a list of 'Step Data' for execution id which key starts with provided prefix.
BinaryStorage	getBinaryStorage() Returns the reference for BinaryStorage to be used in Steps.
Optional<ExecutionState>	getCurrentExecutionState(String executionId) Returns execution state identified by execution id.
List<StepData>	getStepDatas(String executionId, String pipelineId, String stepId) Find a list of 'Step Data' for the given step in the scope of the referenced 'Deployment Execution'.
void	removeData(String executionId, String key) Remove 'Step Data' identified by given key for a particular execution id.
void	removeDataStartsWith(String executionId, String keyPrefix) Remove 'Step Data' identified by given key prefix for a particular execution id.

Method Detail

getStepDatas

List<StepData> getStepDatas(String executionId,
                            String pipelineId,
                            String stepId)

Find a list of 'Step Data' 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.

Returns:

List of 'Step Data'.

findStepData

Optional<StepData> findStepData(String executionId,
                                String pipelineId,
                                String stepId,
                                String key)

Find a 'Step Data' identified by the supplied key 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.

key - The given property key.

Returns:

Optional of 'Step Data'.

findMandatorySingleStepData

default <T extends StepData> T findMandatorySingleStepData(String executionId,
                                                           String key,
                                                           Class<T> stepDataClass)
                                                    throws ProcessingException

Search for mandatory single step data. The step data MUST be present in state store. Otherwise exception is thrown. The found step data MUST also be of provided step data type.

Type Parameters:

T - The type of step data

Parameters:

executionId - The execution id

key - The key of the step data

stepDataClass - The class type of step data

Returns:

The found step data. Throws exception if step data is not found.

Throws:

ProcessingException - In case if step data is not found in state store.

findSingleStepData

default <T extends StepData> Optional<T> findSingleStepData(String executionId,
                                                            String key,
                                                            Class<T> stepDataClass)
                                                     throws ProcessingException

Search for a single step data stored in the state store. Incase of more than one step data present in the state store, exception will be thrown. Also if found step data is not of provided class, exception will be thrown.

Type Parameters:

T - The type of step data

Parameters:

executionId - The execution id

key - The key of the step data

stepDataClass - The class type of step data

Returns:

Optionally found step data of provided step data class.

Throws:

ProcessingException - in case when there is more than one step data present or the step data is not of provided class type.

findStepData

List<StepData> findStepData(String executionId,
                            String key)

Find a list of 'Step Data' identified by the supplied key for the given execution id.

Parameters:

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

key - The given property key.

Returns:

List of 'Step Data'.

findMandatoryStepDataStartsWith

default List<StepData> findMandatoryStepDataStartsWith(String executionId,
                                                       String keyPrefix)
                                                throws ProcessingException

Find a list 'Step Data' identified by execution id and key which starts as provided one.

Parameters:

executionId - The id of referenced 'Deployment Execution'.

keyPrefix - The key prefix.

Returns:

Found at least on step data with provided criteria. Otherwise will throw processing exception.

Throws:

ProcessingException - in case of no step data is found.

findStepDataStartsWith

List<StepData> findStepDataStartsWith(String executionId,
                                      String keyPrefix)

Find a list of 'Step Data' for execution id which key starts with provided prefix.

Parameters:

executionId - The id of referenced 'Deployment Execution'.

keyPrefix - The key prefix.

Returns:

Found step data with provided criteria.

findStepDataKeys

List<String> findStepDataKeys(String executionId,
                              String keyPrefix)

Find a list of 'Step Data' keys for execution id which key starts with provided prefix.

Parameters:

executionId - The id of referenced 'Deployment Execution'.

keyPrefix - The key prefix.

Returns:

Found step data keys with provided criteria.

getBinaryStorage

BinaryStorage getBinaryStorage()

Returns the reference for BinaryStorage to be used in Steps.

Returns:

BinaryStorage reference.

removeData

void removeData(String executionId,
                String key)

Remove 'Step Data' identified by given key for a particular execution id.

Parameters:

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

key - The given property key.

removeDataStartsWith

void removeDataStartsWith(String executionId,
                          String keyPrefix)

Remove 'Step Data' identified by given key prefix for a particular execution id.

Parameters:

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

keyPrefix - The given property key prefix.

getCurrentExecutionState

Optional<ExecutionState> getCurrentExecutionState(String executionId)

Returns execution state identified by execution id.

Parameters:

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

Returns:

Optional of Execution State