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

Class DecisionTreeController

java.lang.Object

com.aquima.web.api.controller.v2.DecisionTreeController

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCS_PATH
static final String	DTREE_FULL_EXECUTOR_PATH
static final String	DTREE_FULL_SEARCH_PATH
static final String	DTREE_SHORTCUT_EXECUTOR_PATH
static final String	DTREE_SHORTCUT_SEARCH_PATH
static final String	EXECUTOR_BASE_PATH
static final String	SEARCH_BASE_PATH

Constructor Summary

Constructors

Constructor	Description
DecisionTreeController(com.blueriq.component.api.IAquimaEngineFacade engine, com.blueriq.component.api.IAquimaEngineConfiguration config, com.blueriq.component.api.security.IAuthorisationManager authorisationManager, com.blueriq.component.api.shortcut.IShortcutManager shortcutsManager, ProductionProperties productionProperties)

Method Summary

Modifier and Type	Method	Description
JsonError	clientParametersException(ClientParameterException exception)
com.aquima.interactions.framework.handler.dtree.DTreeResult	execute(String shortcut, String name, com.aquima.interactions.framework.handler.dtree.DTreeAnswer treeAnswer, String acceptLanguage)
com.aquima.interactions.framework.handler.dtree.DTreeResult	execute(String project, String version, String name, com.aquima.interactions.framework.handler.dtree.DTreeAnswer treeAnswer, String acceptLanguage)
JsonError	handleDecisionTreeUnauthenticatedException(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeUnauthenticatedException exception)
JsonError	handleDecisionTreeUnauthorizedException(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeUnauthorizedException exception)
JsonError	handleFunctionValidationException(org.springframework.http.converter.HttpMessageNotReadableException exception)
JsonError	handleUnknownDecisionTreeException(com.aquima.interactions.dtree.exception.DecisionTreeFinderException exception)
JsonError	handleUnknownShortcutException(UnknownShortcutException exception)
String	openApiFeed(String spec, jakarta.servlet.http.HttpServletRequest request)
DTreeSearchResult	search(String shortcut, com.aquima.interactions.framework.handler.dtree.DTreeSearch treeSearch, String acceptLanguage)
DTreeSearchResult	search(String project, String version, com.aquima.interactions.framework.handler.dtree.DTreeSearch treeSearch, String acceptLanguage)

Methods inherited from class java.lang.Object

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

Field Details

SEARCH_BASE_PATH

public static final String SEARCH_BASE_PATH

See Also:

• Constant Field Values

DTREE_SHORTCUT_SEARCH_PATH

public static final String DTREE_SHORTCUT_SEARCH_PATH

See Also:

• Constant Field Values

DTREE_FULL_SEARCH_PATH

public static final String DTREE_FULL_SEARCH_PATH

See Also:

• Constant Field Values

EXECUTOR_BASE_PATH

public static final String EXECUTOR_BASE_PATH

See Also:

• Constant Field Values

DTREE_SHORTCUT_EXECUTOR_PATH

public static final String DTREE_SHORTCUT_EXECUTOR_PATH

See Also:

• Constant Field Values

DTREE_FULL_EXECUTOR_PATH

public static final String DTREE_FULL_EXECUTOR_PATH

See Also:

• Constant Field Values

DOCS_PATH

public static final String DOCS_PATH

See Also:

• Constant Field Values

Constructor Details

DecisionTreeController

@Autowired
public DecisionTreeController(com.blueriq.component.api.IAquimaEngineFacade engine,
 com.blueriq.component.api.IAquimaEngineConfiguration config,
 com.blueriq.component.api.security.IAuthorisationManager authorisationManager,
 com.blueriq.component.api.shortcut.IShortcutManager shortcutsManager,
 ProductionProperties productionProperties)

Method Details

search

@PostMapping(path="/api/v2/dtree/search/{shortcut}",
             consumes="application/json")
public DTreeSearchResult search(@PathVariable("shortcut")
 String shortcut,
 @RequestBody
 com.aquima.interactions.framework.handler.dtree.DTreeSearch treeSearch,
 @RequestHeader(value="Accept-Language",required=false)
 String acceptLanguage)

search

@PostMapping(path="/api/v2/dtree/search/{project}/{version}",
             consumes="application/json")
public DTreeSearchResult search(@PathVariable("project")
 String project,
 @PathVariable("version")
 String version,
 @RequestBody
 com.aquima.interactions.framework.handler.dtree.DTreeSearch treeSearch,
 @RequestHeader(value="Accept-Language",required=false)
 String acceptLanguage)

execute

@PostMapping(path="/api/v2/dtree/execute/{shortcut}/{name}",
             consumes="application/json")
public com.aquima.interactions.framework.handler.dtree.DTreeResult execute(@PathVariable("shortcut")
 String shortcut,
 @PathVariable("name")
 String name,
 @RequestBody(required=false)
 com.aquima.interactions.framework.handler.dtree.DTreeAnswer treeAnswer,
 @RequestHeader(value="Accept-Language",required=false)
 String acceptLanguage)

execute

@PostMapping(path="/api/v2/dtree/execute/{project}/{version}/{name}",
             consumes="application/json")
public com.aquima.interactions.framework.handler.dtree.DTreeResult execute(@PathVariable("project")
 String project,
 @PathVariable("version")
 String version,
 @PathVariable("name")
 String name,
 @RequestBody(required=false)
 com.aquima.interactions.framework.handler.dtree.DTreeAnswer treeAnswer,
 @RequestHeader(value="Accept-Language",required=false)
 String acceptLanguage)

openApiFeed

@GetMapping("/api/v2/dtree/docs")
public String openApiFeed(@RequestParam(name="spec",defaultValue="3")
 String spec,
 jakarta.servlet.http.HttpServletRequest request)
                   throws Exception

Throws:

Exception

handleUnknownDecisionTreeException

@ExceptionHandler(com.aquima.interactions.dtree.exception.DecisionTreeFinderException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownDecisionTreeException(com.aquima.interactions.dtree.exception.DecisionTreeFinderException exception)

clientParametersException

@ExceptionHandler(ClientParameterException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError clientParametersException(ClientParameterException exception)

handleDecisionTreeUnauthenticatedException

@ExceptionHandler(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeUnauthenticatedException.class)
@ResponseStatus(UNAUTHORIZED)
@ResponseBody
public JsonError handleDecisionTreeUnauthenticatedException(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeUnauthenticatedException exception)

handleDecisionTreeUnauthorizedException

@ExceptionHandler(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeUnauthorizedException.class)
@ResponseStatus(FORBIDDEN)
@ResponseBody
public JsonError handleDecisionTreeUnauthorizedException(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeUnauthorizedException exception)

handleUnknownShortcutException

@ExceptionHandler(UnknownShortcutException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownShortcutException(UnknownShortcutException exception)

handleFunctionValidationException

@ExceptionHandler(org.springframework.http.converter.HttpMessageNotReadableException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError handleFunctionValidationException(org.springframework.http.converter.HttpMessageNotReadableException exception)