Package com.aquima.web.api.controller.v2

Class WebFunctionController

java.lang.Object

com.aquima.web.api.controller.v2.WebFunctionController

@ServerContext
@RestController("v2ApiWebFunctionController")
@RequestMapping(produces="application/json")
public class WebFunctionController
extends Object

Constructor Summary

Constructors

Constructor	Description
WebFunctionController(FunctionService functionService, com.blueriq.component.api.shortcut.function.IFunctionShortcutManager functionShortcutManager, com.blueriq.component.api.IAquimaEngineConfiguration config, ProductionProperties productionProperties, FunctionOpenApiPathService openApiPathService, SessionHeadersProperties sessionHeadersProperties)

Method Summary

Modifier and Type	Method	Description
JsonError	handleForbiddenException(ForbiddenException exception)
JsonError	handleFunctionParameterException(com.aquima.interactions.portal.function.FunctionParameterException exception)
com.aquima.web.api.controller.v2.JsonValidationError	handleFunctionValidationException(com.aquima.interactions.portal.function.FunctionValidationException exception)
org.springframework.http.ResponseEntity<String>	projectOpenApiFeed(String project, String version, String spec, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<String>	shortcutOpenApiFeed(String shortcutName, String spec, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<String>	startFunctionFromPath(String project, String version, String module, String function, String jsonBody, org.springframework.http.HttpHeaders headers)
org.springframework.http.ResponseEntity<String>	startFunctionFromRequestParams(String project, String version, String module, String function, String jsonBody, org.springframework.http.HttpHeaders headers)
org.springframework.http.ResponseEntity<String>	startFunctionFromShortcut(String shortcutName, String jsonBody, String testPath, org.springframework.http.HttpHeaders headers)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebFunctionController

@Autowired
public WebFunctionController(FunctionService functionService,
 com.blueriq.component.api.shortcut.function.IFunctionShortcutManager functionShortcutManager,
 com.blueriq.component.api.IAquimaEngineConfiguration config,
 ProductionProperties productionProperties,
 FunctionOpenApiPathService openApiPathService,
 SessionHeadersProperties sessionHeadersProperties)

Method Details

startFunctionFromRequestParams

@PostMapping(path="/api/v2/function",
             consumes="application/json")
public org.springframework.http.ResponseEntity<String> startFunctionFromRequestParams(@RequestParam
 String project,
 @RequestParam
 String version,
 @RequestParam
 String module,
 @RequestParam
 String function,
 @RequestBody
 String jsonBody,
 @RequestHeader
 org.springframework.http.HttpHeaders headers)
                                                                               throws Exception

Throws:

Exception

startFunctionFromPath

@PostMapping(path="/api/v2/function/start/{project}/{version}/{module}/{function}",
             consumes="application/json")
public org.springframework.http.ResponseEntity<String> startFunctionFromPath(@PathVariable
 String project,
 @PathVariable
 String version,
 @PathVariable
 String module,
 @PathVariable
 String function,
 @RequestBody
 String jsonBody,
 @RequestHeader
 org.springframework.http.HttpHeaders headers)
                                                                      throws Exception

Throws:

Exception

startFunctionFromShortcut

@PostMapping(path="/api/v2/function/shortcut/{shortcutName}",
             consumes="application/json")
public org.springframework.http.ResponseEntity<String> startFunctionFromShortcut(@PathVariable
 String shortcutName,
 @RequestBody
 String jsonBody,
 @RequestHeader(name="X-Blueriq-Test-Path",defaultValue="")
 String testPath,
 @RequestHeader
 org.springframework.http.HttpHeaders headers)
                                                                          throws Exception

Throws:

Exception

shortcutOpenApiFeed

@GetMapping(value="/api/v2/function/docs",
            params="shortcut")
public org.springframework.http.ResponseEntity<String> shortcutOpenApiFeed(@RequestParam("shortcut")
 String shortcutName,
 @RequestParam(name="spec",defaultValue="3")
 String spec,
 jakarta.servlet.http.HttpServletRequest request)
                                                                    throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

projectOpenApiFeed

@GetMapping(value="/api/v2/function/docs",
            params="project")
public org.springframework.http.ResponseEntity<String> projectOpenApiFeed(@RequestParam("project")
 String project,
 @RequestParam("version")
 String version,
 @RequestParam(name="spec",defaultValue="3")
 String spec,
 jakarta.servlet.http.HttpServletRequest request)
                                                                   throws Exception

Throws:

Exception

handleFunctionParameterException

@ExceptionHandler(com.aquima.interactions.portal.function.FunctionParameterException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError handleFunctionParameterException(com.aquima.interactions.portal.function.FunctionParameterException exception)

handleFunctionValidationException

@ExceptionHandler(com.aquima.interactions.portal.function.FunctionValidationException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public com.aquima.web.api.controller.v2.JsonValidationError handleFunctionValidationException(com.aquima.interactions.portal.function.FunctionValidationException exception)

handleForbiddenException

@ExceptionHandler(ForbiddenException.class)
@ResponseStatus(FORBIDDEN)
@ResponseBody
public JsonError handleForbiddenException(ForbiddenException exception)