org.guvnor.ala.services.api.backend

Interface RuntimeProvisioningServiceBackend

public interface RuntimeProvisioningServiceBackend

Runtime Provisioning Service Backend interface. It allows the registering and interaction with different Provisioning Providers and the creation of new Runtimes on these providers. Backend @Remote implementation to be used in CDI environments with Errai

Method Summary

Modifier and Type	Method and Description
void	destroyRuntime(String runtimeId, boolean forced) Destroy an existing Runtime
List<RuntimeQueryResultItem>	executeQuery(RuntimeQuery query) Executes a query against the runtime system.
List<Provider>	getProviders(Integer page, Integer pageSize, String sort, boolean sortOrder) Get all the registered Providers
List<ProviderType>	getProviderTypes(Integer page, Integer pageSize, String sort, boolean sortOrder) Get all the registered ProviderTypes
List<Runtime>	getRuntimes(Integer page, Integer pageSize, String sort, boolean sortOrder) Get All Runtimes
String	newRuntime(RuntimeConfig conf) Create a new Runtime
void	registerProvider(ProviderConfig conf) Register a new Provider
void	restartRuntime(String runtimeId) Restart a given Runtime
void	startRuntime(String runtimeId) Start a given Runtime
void	stopRuntime(String runtimeId) Stop a given Runtime
void	unregisterProvider(String name) Unregister an existing Provider

Method Detail

getProviderTypes

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

Get all the registered ProviderTypes

Returns:

a list containing all the registered provider types

Throws:

BusinessException

getProviders

List<Provider> getProviders(Integer page,
                            Integer pageSize,
                            String sort,
                            boolean sortOrder)
                     throws BusinessException

Get all the registered Providers

Returns:

a list containing all the registered providers

Throws:

BusinessException

registerProvider

void registerProvider(ProviderConfig conf)
               throws BusinessException

Register a new Provider

Parameters:

conf - a ProviderConfig to use for creating the Provider

Throws:

BusinessException

unregisterProvider

void unregisterProvider(String name)
                 throws BusinessException

Unregister an existing Provider

Parameters:

name - a provider name

Throws:

BusinessException

newRuntime

String newRuntime(RuntimeConfig conf)
           throws BusinessException

Create a new Runtime

Parameters:

conf - a RuntimeConfig containing the configuration used to create the new Runtime

Throws:

BusinessException

destroyRuntime

void destroyRuntime(String runtimeId,
                    boolean forced)
             throws BusinessException

Destroy an existing Runtime

Parameters:

runtimeId - the identifier of the runtime to destroy

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.

Throws:

BusinessException

getRuntimes

List<Runtime> getRuntimes(Integer page,
                          Integer pageSize,
                          String sort,
                          boolean sortOrder)
                   throws BusinessException

Get All Runtimes

Returns:

a list containing all the registered Runtimes

Throws:

BusinessException

startRuntime

void startRuntime(String runtimeId)
           throws BusinessException

Start a given Runtime

Parameters:

runtimeId - the identifier of the runtime to be started

Throws:

BusinessException

stopRuntime

void stopRuntime(String runtimeId)
          throws BusinessException

Stop a given Runtime

Parameters:

runtimeId - the identifier of the runtime to be stopped

Throws:

BusinessException

restartRuntime

void restartRuntime(String runtimeId)
             throws BusinessException

Restart a given Runtime

Parameters:

runtimeId - the identifier of the runtime to be restarted

Throws:

BusinessException

executeQuery

List<RuntimeQueryResultItem> executeQuery(RuntimeQuery query)
                                   throws BusinessException

Executes a query against the runtime system.

Parameters:

query - a runtime query to execute.

Returns:

a list of runtime query result items that fulfils the query parameters.

Throws:

BusinessException - in case of an internal exception