org.guvnor.ala.services.api

Interface RuntimeProvisioningService

@Path(value="runtime")
public interface RuntimeProvisioningService

Runtime Provisioning Service interface. It allows us to register and interact with different Provisioning Providers and to create new Runtimes on these providers. URL: {app-context}/runtime/

Method Summary

Modifier and Type	Method and Description
void	deregisterProvider(String name) Unregister an existing Provider
void	destroyRuntime(String runtimeId, boolean forced) Destroy an existing Runtime.
RuntimeQueryResultItemList	executeQuery(RuntimeQuery query) Executes a query against the runtime system.
ProviderList	getProviders(Integer page, Integer pageSize, String sort, boolean sortOrder) Get all the registered Providers
ProviderTypeList	getProviderTypes(Integer page, Integer pageSize, String sort, boolean sortOrder) Get all the registered ProviderTypes
RuntimeList	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

Method Detail

getProviderTypes

@GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="providertypes")
ProviderTypeList getProviderTypes(@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

Get all the registered ProviderTypes

Returns:

ProviderTypeList containing all the registered provider types

Throws:

BusinessException

See Also:

ProviderTypeList

getProviders

@GET
 @Produces(value="application/json")
 @Path(value="providers")
ProviderList getProviders(@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

Get all the registered Providers

Returns:

ProviderList containing all the registered providers

Throws:

BusinessException

See Also:

ProviderList

registerProvider

@POST
 @Consumes(value="application/json")
 @Path(value="providers")
void registerProvider(@NotNull
                                                                                           ProviderConfig conf)
                                                                                    throws BusinessException

Register a new Provider

Parameters:

conf - the ProviderConfig used to create the new Provider

Throws:

BusinessException

deregisterProvider

@DELETE
 @Path(value="providers")
void deregisterProvider(@FormParam(value="name")
                                                          String name)
                                                   throws BusinessException

Unregister an existing Provider

Parameters:

name - a provider name

Throws:

BusinessException

newRuntime

@POST
 @Path(value="runtimes")
 @Consumes(value="application/json")
 @Produces(value="application/json")
String newRuntime(@NotNull
                                                                                                                           RuntimeConfig conf)
                                                                                                                    throws BusinessException

Create a new Runtime

Parameters:

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

Throws:

BusinessException

destroyRuntime

@DELETE
 @Consumes(value="application/json")
 @Path(value="runtimes/{id}/destroy")
void destroyRuntime(@PathParam(value="id")
                                                                                                       String runtimeId,
                                                                                                       @QueryParam(value="forced") @DefaultValue(value="false")
                                                                                                       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

@GET
 @Produces(value="application/json")
 @Path(value="runtimes")
RuntimeList getRuntimes(@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

Get All Runtimes

Returns:

RuntimeList containing all the registered Runtimes

Throws:

BusinessException

startRuntime

@PUT
 @Path(value="runtimes/{id}/start")
void startRuntime(@PathParam(value="id")
                                                           String runtimeId)
                                                    throws BusinessException

Start a given Runtime

Parameters:

runtimeId - the identifier of the runtime to be started

Throws:

BusinessException

stopRuntime

@PUT
 @Path(value="runtimes/{id}/stop")
void stopRuntime(@PathParam(value="id")
                                                         String runtimeId)
                                                  throws BusinessException

Stop a given Runtime

Parameters:

runtimeId - the identifier of the runtime to be stopped

Throws:

BusinessException

restartRuntime

@PUT
 @Path(value="runtimes/{id}/restart")
void restartRuntime(@PathParam(value="id")
                                                               String runtimeId)
                                                        throws BusinessException

Restart a given Runtime

Parameters:

runtimeId - the identifier of the runtime to be restarted

Throws:

BusinessException

executeQuery

@GET
 @Path(value="runtimes/query")
 @Produces(value="application/json")
 @Consumes(value="application/json")
RuntimeQueryResultItemList executeQuery(@NotNull
                                                                                                                                                      RuntimeQuery query)
                                                                                                                                               throws BusinessException

Executes a query against the runtime system.

Parameters:

query - a runtime query to execute.

Returns:

a RuntimeQueryResultItemList with the items that fulfils the query parameters.

Throws:

BusinessException - in case of an internal exception