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

Interface ProcessingContextProvider

public interface ProcessingContextProvider

This provider is used to provide ProcessingContext used in deployment execution.

Method Summary

Modifier and Type	Method and Description
ProcessingContext	addProcessingException(ProcessingContext processingContext, Throwable exception) Add the provided exception to the list of exceptions in provided processing context.
ProcessingContext	evaluateStepResults(ProcessingContext processingContext, ExecutableStepResult stepResults) Inspect the step results and check if there are any results of interest for the processing context.
ProcessingContext	provideFinalizeProcessingContext(ProcessingContext processingContext) Provide new finalizing processing context created from the existing one.
ProcessingContext	provideProcessingContext(Command command) Provide initial processing context.
ProcessingContext	provideProcessingContext(ProcessingContext processingContext) Provide new processing context created from the existing one.
ProcessingContext	provideRetryProcessingContext(ProcessingContext processingContext, RetryPoint retryPoint) Create new retry processing context which will have new pipeline and step to continue from.

Method Detail

provideProcessingContext

ProcessingContext provideProcessingContext(Command command)
                                    throws ProcessingException

Provide initial processing context. Should contain the first pipeline and the first step when deployment execution start.

Parameters:

command - The command from which the execution id, and verbs should be used.

Returns:

the initial processing context to bootstrap the deployment start.

Throws:

ProcessingException - in case when the processing context cannot be initialized.

provideProcessingContext

ProcessingContext provideProcessingContext(ProcessingContext processingContext)

Provide new processing context created from the existing one. It will update current pipeline/step with next one.

Parameters:

processingContext - The previously used processing context.

Returns:

the processing context created from previous processing context

provideFinalizeProcessingContext

ProcessingContext provideFinalizeProcessingContext(ProcessingContext processingContext)

Provide new finalizing processing context created from the existing one. It will update current pipeline with latest finalizing pipeline.

Parameters:

processingContext - The previously used processing context.

Returns:

the processing context created from previous processing context

addProcessingException

ProcessingContext addProcessingException(ProcessingContext processingContext,
                                         Throwable exception)

Add the provided exception to the list of exceptions in provided processing context. The result is new processing context which contains the old exceptions plus the newly provided exception.

Parameters:

processingContext - The old processing context

exception - The exception that has to be added.

Returns:

new processing context which contains set of all exceptions

evaluateStepResults

ProcessingContext evaluateStepResults(ProcessingContext processingContext,
                                      ExecutableStepResult stepResults)

Inspect the step results and check if there are any results of interest for the processing context. In such situation, new processing context is generated with step results attached to it.

Parameters:

processingContext - The old processing context

stepResults - The results from execution of step

Returns:

new processing context if there are step results of interest for the processing context (like verbs and actions), otherwise the old one will be returned

provideRetryProcessingContext

ProcessingContext provideRetryProcessingContext(ProcessingContext processingContext,
                                                RetryPoint retryPoint)
                                         throws ProcessingException

Create new retry processing context which will have new pipeline and step to continue from.

Parameters:

processingContext - The old processing context.

retryPoint - The retry point which contains info about pipeline id and step id to continue from.

Returns:

The new processing context with pipeline/step already preset from the new retry point

Throws:

ProcessingException