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

Interface PipelineProvider

public interface PipelineProvider

Contains configuration and provides it to ExecutableStepFactory.

Method Summary

Modifier and Type	Method and Description
Optional<Pipeline>	getFinalizePipeline(String action, Set<String> verbs, String pipelineId) Resolve the pipeline which is last in the execution chain and marked as a finalizing pipeline.
Optional<Pipeline>	getNextPipeline(String action, Set<String> verbs, String pipelineId) Resolve the pipeline which comes after the provided pipeline id from the list of pipelines with given action and verbs.
Optional<Step>	getNextStep(String pipelineId, String stepId) Resolve the step which comes after the provided step id from the list of steps which are contained within pipeline with provided id.
Optional<Pipeline>	getPipeline(String pipelineId) Search for a pipeline with provided id.
List<Pipeline>	getPipelines() Get all Pipelines.
List<Pipeline>	getPipelines(String action, Set<String> verbs) Get all pipelines which belongs to given action and verbs.
Optional<Step>	getStep(String pipelineId, String stepId) Return Step based on pipeline id and step id.
Optional<List<Step>>	getSteps(String pipelineId) Get Step by pipeline id.

Method Detail

getPipelines

List<Pipeline> getPipelines()

Get all Pipelines.

Returns:

list of pipelines.

getPipelines

List<Pipeline> getPipelines(String action,
                            Set<String> verbs)

Get all pipelines which belongs to given action and verbs.

Parameters:

action - The action filter.

verbs - The verbs filter.

Returns:

list of pipelines which have given action and verbs.

getPipeline

Optional<Pipeline> getPipeline(String pipelineId)

Search for a pipeline with provided id.

Parameters:

pipelineId - The pipeline id

Returns:

The found pipeline if present, otherwise empty optional.

getNextPipeline

Optional<Pipeline> getNextPipeline(String action,
                                   Set<String> verbs,
                                   String pipelineId)

Resolve the pipeline which comes after the provided pipeline id from the list of pipelines with given action and verbs.

Parameters:

action - The action filter.

verbs - The verbs filter.

pipelineId - The current pipeline id.

Returns:

return the next pipeline which comes after the pipeline id or empty optional if the pipeline with provided id is last pipeline.

getFinalizePipeline

Optional<Pipeline> getFinalizePipeline(String action,
                                       Set<String> verbs,
                                       String pipelineId)

Resolve the pipeline which is last in the execution chain and marked as a finalizing pipeline. Finalizing pipeline is ought to execute even if failure was occurred.

Parameters:

action - The action filter.

verbs - The verbs filter.

pipelineId - The current pipeline id.

Returns:

return the finalizing pipeline which comes after the pipeline id or empty optional if the pipeline with provided id is last pipeline.

getNextStep

Optional<Step> getNextStep(String pipelineId,
                           String stepId)

Resolve the step which comes after the provided step id from the list of steps which are contained within pipeline with provided id.

Parameters:

pipelineId - The pipeline filter.

stepId - The current step.

Returns:

the next step within one pipeline which comes after the step with provided id. If the provided step is last step, return empty optional.

getSteps

Optional<List<Step>> getSteps(String pipelineId)

Get Step by pipeline id.

Parameters:

pipelineId - pipeline identifier.

Returns:

steps if any for pipeline.

getStep

Optional<Step> getStep(String pipelineId,
                       String stepId)

Return Step based on pipeline id and step id.

Parameters:

pipelineId - pipeline identifier.

stepId - step identifier.

Returns:

Step if any for pipeline id and step id.