org.guvnor.ala.services.api

Interface PipelineService

@Path(value="pipelines")
public interface PipelineService

Pipeline Service interface. It allows us to create and run new Pipelines URL: {app-context}/pipelines/

Method Summary

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

Method Detail

getPipelineConfigs

@GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
PipelineConfigsList getPipelineConfigs(@QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                      Integer page,
                                                                                                                      @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                      Integer pageSize,
                                                                                                                      @QueryParam(value="sort")
                                                                                                                      String sort,
                                                                                                                      @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                      boolean sortOrder)
                                                                                                               throws BusinessException

Gets all the Pipeline Configurations registered in the service.

Returns:

a PipelineConfigsList with the list of pipeline configurations.

Throws:

BusinessException

See Also:

PipelineConfigsList

getPipelineConfigs

@GET
 @Path(value="providertype")
 @Produces(value="application/json")
 @Consumes(value="application/json")
PipelineConfigsList getPipelineConfigs(@QueryParam(value="providerTypeName")
                                                                                                                                                   String providerTypeName,
                                                                                                                                                   @QueryParam(value="providerTypeVersion")
                                                                                                                                                   String providerTypeVersion,
                                                                                                                                                   @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                   Integer page,
                                                                                                                                                   @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                   Integer pageSize,
                                                                                                                                                   @QueryParam(value="sort")
                                                                                                                                                   String sort,
                                                                                                                                                   @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                                                   boolean sortOrder)
                                                                                                                                            throws BusinessException

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

Parameters:

providerTypeName - a provider type name registered in the system.

providerTypeVersion - the provider type version corresponding to the provider type.

Returns:

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

Throws:

BusinessException

See Also:

PipelineConfigsList

getPipelineNames

@GET
 @Path(value="providertype/names")
 @Produces(value="application/json")
 @Consumes(value="application/json")
List<String> getPipelineNames(@QueryParam(value="providerTypeName")
                                                                                                                                                String providerTypeName,
                                                                                                                                                @QueryParam(value="providerTypeVersion")
                                                                                                                                                String providerTypeVersion,
                                                                                                                                                @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                Integer page,
                                                                                                                                                @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                Integer pageSize,
                                                                                                                                                @QueryParam(value="sort")
                                                                                                                                                String sort,
                                                                                                                                                @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                                                boolean sortOrder)
                                                                                                                                         throws BusinessException

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

Parameters:

providerTypeName - a provider type name registered in the system.

providerTypeVersion - the provider type version corresponding to the provider type.

Returns:

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

Throws:

BusinessException

newPipeline

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
String newPipeline(@NotNull
                                                                                                   PipelineConfig config)
                                                                                            throws BusinessException

Registers a new Pipeline with the provided configuration.

Parameters:

config - the pipeline configuration.

Returns:

the pipeline id.

Throws:

BusinessException

See Also:

PipelineConfig

newPipeline

@POST
 @Path(value="providertype")
 @Consumes(value="application/json")
 @Produces(value="application/json")
String newPipeline(@NotNull
                                                                                                                                PipelineConfig config,
                                                                                                                                @NotNull
                                                                                                                                ProviderType providerType)
                                                                                                                         throws BusinessException

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

Parameters:

config - the pipeline configuration.

providerType - A provider type for associating the pipeline.

Returns:

String with the pipeline id

Throws:

BusinessException

See Also:

PipelineConfig

runPipeline

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="execution/{pipelineId}/run")
String runPipeline(@PathParam(value="pipelineId")
                                                                                                                                              String pipelineId,
                                                                                                                                              @NotNull
                                                                                                                                              Input input,
                                                                                                                                              @NotNull
                                                                                                                                              boolean async)
                                                                                                                                       throws BusinessException

Run/Execute a registered Pipeline.

Parameters:

pipelineId - of the pipeline to be executed.

input - Input values 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

@PUT
 @Path(value="execution/{executionId}/stop")
void stopPipelineExecution(@PathParam(value="executionId")
                                                                             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

@DELETE
 @Path(value="execution/{executionId}")
void deletePipelineExecution(@PathParam(value="executionId")
                                                                             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