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

Interface ExecutableStep

All Known Implementing Classes:

TridionCleanupStep, TridionCommitStep, TridionConceptSchemeSyncStep, TridionContentDataStep, TridionDeployerStepAdapter, TridionPreCommitStep, TridionRollbackStep, TridionSearchIndexDeployStep, TridionSearchIndexUnDeployStep, TridionTransactionalExecutableStep, TridionUnzipStep, TridionWaitStep

public interface ExecutableStep

Interface with lifecycle methods to provide support for executing logic in the scope of a generic pipeline step.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RETRY_POINT_ELEMENT Retry point configuration element.

Method Summary

Modifier and Type	Method and Description
void	configure(com.sdl.delivery.configuration.Configuration configuration) Configure the 'Executable Step' with the given configuration.
ExecutableStepResult	process(ProcessingContext context, StepDataProvider stepDataProvider) Actual processing logic to execute in the scope of the 'pipeline step'.
default Optional<RetryPoint>	retryPoint(ProcessingContext processingContext) In case where a step can retry, then should return the retry point.

Field Detail

RETRY_POINT_ELEMENT

static final String RETRY_POINT_ELEMENT

Retry point configuration element.

See Also:

Constant Field Values

Method Detail

configure

void configure(com.sdl.delivery.configuration.Configuration configuration)
        throws com.sdl.delivery.configuration.ConfigurationException

Configure the 'Executable Step' with the given configuration.

Parameters:

configuration - The given configuration.

Throws:

com.sdl.delivery.configuration.ConfigurationException

process

ExecutableStepResult process(ProcessingContext context,
                             StepDataProvider stepDataProvider)
                      throws ProcessingException

Actual processing logic to execute in the scope of the 'pipeline step'.

Parameters:

context - Contains information about current execution.

stepDataProvider - Provides access to get step data for a specific deployment execution.

Returns:

The result after executing the processing logic.

Throws:

ProcessingException - When something went wrong executing the processing logic.

retryPoint

default Optional<RetryPoint> retryPoint(ProcessingContext processingContext)

In case where a step can retry, then should return the retry point. In case if the step is not retryable than empty retry point is returned.

Parameters:

processingContext - The processing context on which decision is made

Returns:

The retry point if a step can retry, otherwise empty optional