@Path(value="runtime")
public interface RuntimeProvisioningService
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
|
@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
BusinessException
ProviderTypeList
@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
BusinessException
ProviderList
@POST @Consumes(value="application/json") @Path(value="providers") void registerProvider(@NotNull ProviderConfig conf) throws BusinessException
conf
- the ProviderConfig used to create the new ProviderBusinessException
@DELETE @Path(value="providers") void deregisterProvider(@FormParam(value="name") String name) throws BusinessException
name
- a provider nameBusinessException
@POST @Path(value="runtimes") @Consumes(value="application/json") @Produces(value="application/json") String newRuntime(@NotNull RuntimeConfig conf) throws BusinessException
conf
- a RuntimeConfig containing the configuration used to create the new RuntimeBusinessException
@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
runtimeId
- the identifier of the runtime to destroyforced
- 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.BusinessException
@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
BusinessException
@PUT @Path(value="runtimes/{id}/start") void startRuntime(@PathParam(value="id") String runtimeId) throws BusinessException
runtimeId
- the identifier of the runtime to be startedBusinessException
@PUT @Path(value="runtimes/{id}/stop") void stopRuntime(@PathParam(value="id") String runtimeId) throws BusinessException
runtimeId
- the identifier of the runtime to be stoppedBusinessException
@PUT @Path(value="runtimes/{id}/restart") void restartRuntime(@PathParam(value="id") String runtimeId) throws BusinessException
runtimeId
- the identifier of the runtime to be restartedBusinessException
@GET @Path(value="runtimes/query") @Produces(value="application/json") @Consumes(value="application/json") RuntimeQueryResultItemList executeQuery(@NotNull RuntimeQuery query) throws BusinessException
query
- a runtime query to execute.BusinessException
- in case of an internal exceptionCopyright © 2001–2020 JBoss by Red Hat. All rights reserved.