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

Class StartController

java.lang.Object

com.aquima.web.api.controller.v2.AbstractBaseController

com.aquima.web.api.controller.v2.StartControllerBase

com.aquima.web.api.controller.v2.StartController

@RestController("v2ApiStartController")
@RequestMapping(path="/api/v2",
                produces="application/json")
@ServerContext
public class StartController
extends StartControllerBase

This controller is used specifically for clients that only accept JSON instead of HTML and have their own login screen. This is the use case of the Blueriq mobile app.

Since:

11.0

Author:

v.jansen, g.graat

Constructor Summary

Constructors

Constructor	Description
StartController(com.blueriq.component.api.IAquimaEngineConfiguration config, com.blueriq.component.api.security.IAuthorisationManager authorisationManager, com.blueriq.component.api.IAquimaSessionsMap sessionManager, FlowStarter flowStarter, com.blueriq.component.api.shortcut.IShortcutManager shortcutsManager, ProductionProperties productionProperties)

Method Summary

Modifier and Type	Method	Description
BqConfiguration	startDefaultShortcut(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletRequest httpRequest)
BqConfiguration	startProject(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletRequest httpRequest, String projectName, String flow, String version, String languageCode, String aquimaUi, String theme, String channel, String testPath)
BqConfiguration	startShortcut(String shortcutName, org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletRequest httpRequest, String testPath)

Methods inherited from class com.aquima.web.api.controller.v2.StartControllerBase

handleForbiddenException, setOpenIdConnectSettings

Methods inherited from class com.aquima.web.api.controller.v2.AbstractBaseController

clientParametersException, handleConversionException, handleDecisionTreeNotExposedException, handleEmptySymptomException, handleFlowEndedException, handleFunctionParameterException, handleFunctionValidationException, handleFunctionValidationException, handleMethodArgumentTypeMismatchException, handleRequestWardException, handleStartApplicationForbiddenException, handleStartShortcutForbiddenException, handleUnauthorizedException, handleUnknownApplicationException, handleUnknownDecisionTreeException, handleUnknownFlowException, handleUnknownFunctionFlowException, handleUnknownLanguageException, handleUnknownModuleException, handleUnknownSessionException, handleUnknownShortcutException, handleUnknownSubscriptionException, handleUnsupportedOpenApiSpecException, isAuthenticated

Methods inherited from class java.lang.Object

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

Constructor Details

StartController

@Autowired
public StartController(com.blueriq.component.api.IAquimaEngineConfiguration config,
 com.blueriq.component.api.security.IAuthorisationManager authorisationManager,
 com.blueriq.component.api.IAquimaSessionsMap sessionManager,
 FlowStarter flowStarter,
 com.blueriq.component.api.shortcut.IShortcutManager shortcutsManager,
 ProductionProperties productionProperties)

Parameters:

authorisationManager - the authorisation manager

sessionManager - the session manager

shortcutsManager - the shortcut manager

productionProperties - holds production properties

config - aquima engine configuration

Method Details

startDefaultShortcut

@PostMapping(path="/start",
             params="!project")
public BqConfiguration startDefaultShortcut(org.springframework.web.context.request.WebRequest request,
 javax.servlet.http.HttpServletRequest httpRequest)

startShortcut

@PostMapping(path="/start/{shortcutName}",
             params="!project")
public BqConfiguration startShortcut(@PathVariable(required=false)
 String shortcutName,
 org.springframework.web.context.request.WebRequest request,
 javax.servlet.http.HttpServletRequest httpRequest,
 @RequestParam(value="testPath",required=false)
 String testPath)

startProject

@PostMapping(path="/start",
             params="project")
public BqConfiguration startProject(org.springframework.web.context.request.WebRequest request,
 javax.servlet.http.HttpServletRequest httpRequest,
 @RequestParam("project")
 String projectName,
 @RequestParam(value="flow",required=false)
 String flow,
 @RequestParam(value="version",required=false)
 String version,
 @RequestParam(value="languageCode",required=false)
 String languageCode,
 @RequestParam(value="ui",required=false)
 String aquimaUi,
 @RequestParam(value="theme",required=false)
 String theme,
 @RequestParam(value="channel",required=false)
 String channel,
 @RequestParam(value="testPath",required=false)
 String testPath)
                             throws Exception

Throws:

Exception