org.guvnor.ala.ui.service

Interface RuntimeService

public interface RuntimeService

Method Summary

Modifier and Type	Method and Description
PipelineExecutionTraceKey	createRuntime(ProviderKey providerKey, String runtimeName, PipelineKey pipelineKey, Map<String,String> params) Creates a runtime by associating it with a given provider.
void	deletePipelineExecution(PipelineExecutionTraceKey pipelineExecutionTraceKey) Deletes a pipeline execution trace from the system.
void	deleteRuntime(RuntimeKey runtimeKey, boolean forced) Deletes a runtime.
Collection<PipelineKey>	getPipelines(ProviderTypeKey providerTypeKey) Gests the pipeline names for the pipelines associated to a given provider type.
RuntimeListItem	getRuntimeItem(PipelineExecutionTraceKey pipelineExecutionTraceKey) Gets the runtime information for a given pipeline execution.
RuntimeListItem	getRuntimeItem(RuntimeKey runtimeKey) Gets the runtime information for a given runtime.
Collection<RuntimeListItem>	getRuntimeItems(ProviderKey providerKey) Gets the information about the runtimes associated to a given provider.
void	startRuntime(RuntimeKey runtimeKey) Starts a runtime.
void	stopPipelineExecution(PipelineExecutionTraceKey pipelineExecutionTraceKey) Stops a running pipeline execution.
void	stopRuntime(RuntimeKey runtimeKey) Stops a runtime.

Method Detail

getRuntimeItems

Collection<RuntimeListItem> getRuntimeItems(ProviderKey providerKey)

Gets the information about the runtimes associated to a given provider.

Parameters:

providerKey - a provider que for getting the runtimes.

Returns:

a list of RuntimeListItem.

getRuntimeItem

RuntimeListItem getRuntimeItem(PipelineExecutionTraceKey pipelineExecutionTraceKey)

Gets the runtime information for a given pipeline execution.

Parameters:

pipelineExecutionTraceKey - the identifier for a pipeline execution.

Returns:

the RuntimeListItem associated to the pipeline execution when exists, false in any other case.

getRuntimeItem

RuntimeListItem getRuntimeItem(RuntimeKey runtimeKey)

Gets the runtime information for a given runtime.

Parameters:

runtimeKey - the identifier for a runtime.

Returns:

the RuntimeListItem associated to the runtime when exists, false in any other case.

getPipelines

Collection<PipelineKey> getPipelines(ProviderTypeKey providerTypeKey)

Gests the pipeline names for the pipelines associated to a given provider type.

Parameters:

providerTypeKey - a provider type key.

Returns:

a list with the keys of the associated pipelines.

createRuntime

PipelineExecutionTraceKey createRuntime(ProviderKey providerKey,
                                        String runtimeName,
                                        PipelineKey pipelineKey,
                                        Map<String,String> params)

Creates a runtime by associating it with a given provider. A provider may have multiple runtimes associated.

Parameters:

providerKey - the provider key for creating the runtime.

runtimeName - a name for the runtime to be created.

pipelineKey - the key of a pipeline to use for performing all the required operations for building the runtime.

Returns:

returns the pipeline execution id.

stopPipelineExecution

void stopPipelineExecution(PipelineExecutionTraceKey pipelineExecutionTraceKey)

Stops a running pipeline execution.

Parameters:

pipelineExecutionTraceKey - identifier for the pipeline execution.

deletePipelineExecution

void deletePipelineExecution(PipelineExecutionTraceKey pipelineExecutionTraceKey)

Deletes a pipeline execution trace from the system.

Parameters:

pipelineExecutionTraceKey - identifier of the pipeline execution.

stopRuntime

void stopRuntime(RuntimeKey runtimeKey)

Stops a runtime.

Parameters:

runtimeKey - the key of the runtime to stop.

startRuntime

void startRuntime(RuntimeKey runtimeKey)

Starts a runtime.

Parameters:

runtimeKey - the key of the runtime to start.

deleteRuntime

void deleteRuntime(RuntimeKey runtimeKey,
                   boolean forced)

Deletes a runtime.

Parameters:

runtimeKey - the key of the runtime to delete.

forced - indicates if the runtime must be deleted from the guvnor-ala registries independently of the connectivity with the external provider. e.g. if it was not possible to connect an external WF where the runtime is running.