org.n52.javaps.transactional.rest

Interface TransactionalApi

All Known Implementing Classes:

TransactionalApiImpl

public interface TransactionalApi

Extension of ProcessesApi for transactional operations.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<?>	deployProcess(com.fasterxml.jackson.databind.JsonNode request) Adds a new process to this service.
void	undeployProcess(String id) Deletes the process with the specified id.
void	updateProcess(String id, com.fasterxml.jackson.databind.JsonNode request) Updates the process with the specified id.

Method Detail

undeployProcess

@ResponseBody
 @ResponseStatus(value=NO_CONTENT)
 @DeleteMapping(path="/rest/processes/{id:.+}")
void undeployProcess(@PathVariable(value="id")
                                                                                                                      String id)
                                                                                                               throws ProcessNotFoundException,
                                                                                                                      UndeletableProcessException

Deletes the process with the specified id.

Parameters:

id - The identifier of the process.

Throws:

ProcessNotFoundException - If the process could not be found.

UndeletableProcessException - If the process is not deletable.

deployProcess

@ResponseStatus(value=CREATED)
 @PostMapping(path="/rest/processes",
             consumes="application/json")
org.springframework.http.ResponseEntity<?> deployProcess(@RequestBody
                                                                                                                                                                        com.fasterxml.jackson.databind.JsonNode request)
                                                                                                                                                                 throws DuplicateProcessException,
                                                                                                                                                                        UnsupportedProcessException

Adds a new process to this service.

Parameters:

request - The description of the new process, a ApplicationPackage.

Returns:

The ResponseEntity containing the Location of the new process.

Throws:

DuplicateProcessException - If a process with the same identifier already exists.

UnsupportedProcessException - If the process is not supported.

updateProcess

@ResponseStatus(value=NO_CONTENT)
 @PutMapping(path="/rest/processes/{id:.+}",
            consumes="application/json")
void updateProcess(@PathVariable(value="id")
                                                                                                                                           String id,
                                                                                                                                           @RequestBody
                                                                                                                                           com.fasterxml.jackson.databind.JsonNode request)
                                                                                                                                    throws ProcessNotFoundException,
                                                                                                                                           UnsupportedProcessException,
                                                                                                                                           UndeletableProcessException

Updates the process with the specified id.

Parameters:

id - The identifier of the process.

request - The description of the new process, a ApplicationPackage

Throws:

ProcessNotFoundException - If the process could not be found.

UnsupportedProcessException - If the process is not supported.

UndeletableProcessException - If the process cannot be updated.