org.guvnor.ala.services.api.backend

Interface PipelineServiceBackend

public interface PipelineServiceBackend

Pipeline Service Backend interface. It allows the creation and execution of pipelines. Backend @Remote implementation to be used in CDI environments with Errai

Method Summary

Modifier and Type	Method and Description
void	deletePipelineExecution(String executionId) Deletes a pipeline execution
List<PipelineConfig>	getPipelineConfigs(Integer page, Integer pageSize, String sort, boolean sortOrder) Get all the Pipeline Configurations registered in the service
List<PipelineConfig>	getPipelineConfigs(ProviderType providerType, Integer page, Integer pageSize, String sort, boolean sortOrder) Gets the Pipeline Configurations registered in the service and associated with the given provider type.
List<String>	getPipelineNames(ProviderType providerType, Integer page, Integer pageSize, String sort, boolean sortOrder) Gets the names of the Pipelines associated to the given provider type.
String	newPipeline(PipelineConfig pipelineConfig) Registers a new Pipeline with the provided configuration
String	newPipeline(PipelineConfig pipelineConfig, ProviderType providerType) Registers a new Pipeline with the provided configuration and associates it to a provider type.
String	runPipeline(String id, Input input, boolean async) Execute a registered Pipeline
void	stopPipelineExecution(String executionId) Stops a running pipeline execution.

Method Detail

getPipelineConfigs

List<PipelineConfig> getPipelineConfigs(Integer page,
                                        Integer pageSize,
                                        String sort,
                                        boolean sortOrder)
                                 throws BusinessException

Get all the Pipeline Configurations registered in the service

Returns:

a list with all the pipeline configurations

Throws:

BusinessException

getPipelineConfigs

List<PipelineConfig> getPipelineConfigs(ProviderType providerType,
                                        Integer page,
                                        Integer pageSize,
                                        String sort,
                                        boolean sortOrder)
                                 throws BusinessException

Gets the Pipeline Configurations registered in the service and associated with the given provider type.

Parameters:

providerType - a provider type registered in the system.

Returns:

a list with the pipeline configurations associated with the provider type.

Throws:

BusinessException

getPipelineNames

List<String> getPipelineNames(ProviderType providerType,
                              Integer page,
                              Integer pageSize,
                              String sort,
                              boolean sortOrder)
                       throws BusinessException

Gets the names of the Pipelines associated to the given provider type.

Parameters:

providerType - a provider type registered in the system.

Returns:

a list with the names of the Pipelines associated with the provider type.

Throws:

BusinessException

newPipeline

String newPipeline(PipelineConfig pipelineConfig)
            throws BusinessException

Registers a new Pipeline with the provided configuration

Parameters:

pipelineConfig - the pipeline configuration.

Returns:

String with the pipeline id

Throws:

BusinessException

See Also:

PipelineConfig

newPipeline

String newPipeline(PipelineConfig pipelineConfig,
                   ProviderType providerType)
            throws BusinessException

Registers a new Pipeline with the provided configuration and associates it to a provider type.

Parameters:

pipelineConfig - the pipeline configuration.

providerType - the provider type for associating the pipeline with.

Returns:

String with the pipeline id.

Throws:

BusinessException

See Also:

PipelineConfig

runPipeline

String runPipeline(String id,
                   Input input,
                   boolean async)
            throws BusinessException

Execute a registered Pipeline

Parameters:

id - of the pipeline to be executed

input - to be used for the pipeline execution

async - establishes the execution mode. true for asynchronous execution, false for synchronous execution.

Returns:

the pipeline execution id.

Throws:

BusinessException

stopPipelineExecution

void stopPipelineExecution(String executionId)
                    throws BusinessException

Stops a running pipeline execution.

Parameters:

executionId - A pipeline execution id to stop. The pipeline execution id is typically returned by the runPipeline method.

Throws:

BusinessException

deletePipelineExecution

void deletePipelineExecution(String executionId)
                      throws BusinessException

Deletes a pipeline execution

Parameters:

executionId - A pipeline execution id to delete. The pipeline execution id is typically returned by the runPipeline method.

Throws:

BusinessException