org.n52.javaps.rest

Interface ProcessesApi

All Known Implementing Classes:

ProcessesApiImpl

public interface ProcessesApi

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<?>	execute(Execute body, String processId)
String	getExecuteForm(String processId, org.springframework.ui.Model model)
org.springframework.http.ResponseEntity<?>	getJobList(String processId)
Process	getProcessDescription(String id)
ProcessCollection	getProcesses()
org.springframework.http.ResponseEntity<?>	getResult(String id, String jobId)
StatusInfo	getStatus(String processId, String jobId)

Field Detail

BASE_URL

static final String BASE_URL

See Also:

Constant Field Values

Method Detail

execute

@PostMapping(value="/rest/processes/{processId}/jobs",
             produces="application/json",
             consumes="application/json")
org.springframework.http.ResponseEntity<?> execute(@RequestBody
                                                                                                                                                                                              Execute body,
                                                                                                                                                                                              @PathVariable(value="processId")
                                                                                                                                                                                              String processId)
                                                                                                                                                                                       throws EngineException,
                                                                                                                                                                                              ExecutionException

Throws:

EngineException

ExecutionException

getJobList

@GetMapping(value="/rest/processes/{processId}/jobs",
            produces="application/json")
org.springframework.http.ResponseEntity<?> getJobList(@PathVariable(value="processId")
                                                                                                                                                     String processId)

getExecuteForm

@GetMapping(value="/rest/processes/{processId}/jobs",
            produces="text/html")
String getExecuteForm(@PathVariable(value="processId")
                                                                                                              String processId,
                                                                                                              org.springframework.ui.Model model)

getProcessDescription

@GetMapping(value="/rest/processes/{processId:.+}",
            produces="application/json")
 @ResponseBody
Process getProcessDescription(@PathVariable(value="processId")
                                                                                                                                          String id)
                                                                                                                                   throws ProcessNotFoundException

Throws:

ProcessNotFoundException

getProcesses

@GetMapping(value="/rest/processes",
            produces="application/json")
 @ResponseBody
ProcessCollection getProcesses()

getResult

@GetMapping(value="/rest/processes/{processId}/jobs/{jobId}/results",
            produces="application/json")
org.springframework.http.ResponseEntity<?> getResult(@PathVariable(value="processId")
                                                                                                                                                                    String id,
                                                                                                                                                                    @PathVariable(value="jobId")
                                                                                                                                                                    String jobId)
                                                                                                                                                             throws EngineException,
                                                                                                                                                                    ExecutionException

Throws:

EngineException

ExecutionException

getStatus

@GetMapping(value="/rest/processes/{processId}/jobs/{jobId}",
            produces="application/json")
 @ResponseBody
StatusInfo getStatus(@PathVariable(value="processId")
                                                                                                                                           String processId,
                                                                                                                                           @PathVariable(value="jobId")
                                                                                                                                           String jobId)
                                                                                                                                    throws EngineException

Throws:

EngineException