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

Class AbstractBaseController

java.lang.Object

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

Direct Known Subclasses:

AuthenticationController, DocumentController, FileDownloadController, FileUploadController, ImageBaseController, LanguageController, SessionController, StartControllerBase

public abstract class AbstractBaseController
extends Object

Provides Exception handling for all API controllers in the ServerContext. Normally, all exceptions in this context are resolved through DefaultAquimaExceptionResolverController and that behavior is not changed for backwards compatibility. By extending this class, aforementioned global exception resolver is no longer considered.

Since:

11.0

Author:

j.koehoorn

Constructor Summary

Constructors

Constructor	Description
AbstractBaseController()

Method Summary

Modifier and Type	Method	Description
JsonError	clientParametersException(ClientParameterException exception)
JsonError	handleConversionException(org.springframework.core.convert.ConversionException exception)
JsonError	handleDecisionTreeNotExposedException(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeNotExposedException exception)
JsonError	handleEmptySymptomException(com.aquima.interactions.foundation.exception.EmptySymptomException exception)
JsonError	handleFlowEndedException(FlowEndedException exception)
JsonError	handleForbiddenException(ForbiddenException exception)
com.aquima.web.api.controller.v2.JsonValidationError	handleFunctionValidationException(com.aquima.interactions.portal.function.FunctionValidationException exception)
JsonError	handleFunctionValidationException(org.springframework.http.converter.HttpMessageNotReadableException exception)
JsonError	handleMethodArgumentTypeMismatchException(org.springframework.web.method.annotation.MethodArgumentTypeMismatchException exception, jakarta.servlet.http.HttpServletResponse response)
JsonError	handleRequestWardException(RequestWardException ex)
JsonError	handleStartApplicationForbiddenException(StartApplicationForbiddenException exception)
JsonError	handleStartShortcutForbiddenException(StartShortcutForbiddenException exception)
JsonError	handleUnauthorizedException()
JsonError	handleUnknownApplicationException(com.aquima.interactions.portal.exception.UnknownApplicationException exception)
JsonError	handleUnknownFlowException(com.aquima.interactions.flow.exception.UnknownFlowException exception)
JsonError	handleUnknownFunctionFlowException(com.aquima.interactions.flow.exception.UnknownFunctionFlowException exception)
JsonError	handleUnknownLanguageException(com.aquima.interactions.metamodel.exception.UnknownLanguageException ex)
JsonError	handleUnknownModuleException(com.aquima.interactions.portal.exception.UnknownModuleException exception)
JsonError	handleUnknownSessionException(com.blueriq.component.api.exception.UnknownSessionException exception)
JsonError	handleUnknownShortcutException(UnknownShortcutException exception)
JsonError	handleUnsupportedOpenApiSpecException(UnsupportedOpenApiSpecException exception)
protected final boolean	isAuthenticated(com.aquima.interactions.project.IUserData user)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBaseController

public AbstractBaseController()

Method Details

handleUnknownApplicationException

@ExceptionHandler(com.aquima.interactions.portal.exception.UnknownApplicationException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownApplicationException(com.aquima.interactions.portal.exception.UnknownApplicationException exception)

handleUnknownModuleException

@ExceptionHandler(com.aquima.interactions.portal.exception.UnknownModuleException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownModuleException(com.aquima.interactions.portal.exception.UnknownModuleException exception)

handleUnknownFlowException

@ExceptionHandler(com.aquima.interactions.flow.exception.UnknownFlowException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownFlowException(com.aquima.interactions.flow.exception.UnknownFlowException exception)

handleUnknownFunctionFlowException

@ExceptionHandler(com.aquima.interactions.flow.exception.UnknownFunctionFlowException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownFunctionFlowException(com.aquima.interactions.flow.exception.UnknownFunctionFlowException exception)

handleUnsupportedOpenApiSpecException

@ExceptionHandler(UnsupportedOpenApiSpecException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnsupportedOpenApiSpecException(UnsupportedOpenApiSpecException exception)

handleFlowEndedException

@ExceptionHandler(FlowEndedException.class)
@ResponseStatus(INTERNAL_SERVER_ERROR)
@ResponseBody
public JsonError handleFlowEndedException(FlowEndedException exception)

handleFunctionValidationException

@ExceptionHandler(org.springframework.http.converter.HttpMessageNotReadableException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError handleFunctionValidationException(org.springframework.http.converter.HttpMessageNotReadableException 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)

handleConversionException

@ExceptionHandler(org.springframework.core.convert.ConversionException.class)
@ResponseStatus(INTERNAL_SERVER_ERROR)
@ResponseBody
public JsonError handleConversionException(org.springframework.core.convert.ConversionException exception)

handleForbiddenException

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

handleUnknownSessionException

@ExceptionHandler(com.blueriq.component.api.exception.UnknownSessionException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownSessionException(com.blueriq.component.api.exception.UnknownSessionException exception)

handleRequestWardException

@ExceptionHandler(RequestWardException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError handleRequestWardException(RequestWardException ex)

handleMethodArgumentTypeMismatchException

@ExceptionHandler(org.springframework.web.method.annotation.MethodArgumentTypeMismatchException.class)
public JsonError handleMethodArgumentTypeMismatchException(org.springframework.web.method.annotation.MethodArgumentTypeMismatchException exception,
 jakarta.servlet.http.HttpServletResponse response)

handleUnknownLanguageException

@ExceptionHandler(com.aquima.interactions.metamodel.exception.UnknownLanguageException.class)
@ResponseStatus(NOT_FOUND)
@ResponseBody
public JsonError handleUnknownLanguageException(com.aquima.interactions.metamodel.exception.UnknownLanguageException ex)

handleUnknownShortcutException

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

handleEmptySymptomException

@ExceptionHandler(com.aquima.interactions.foundation.exception.EmptySymptomException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError handleEmptySymptomException(com.aquima.interactions.foundation.exception.EmptySymptomException exception)

handleDecisionTreeNotExposedException

@ExceptionHandler(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeNotExposedException.class)
@ResponseStatus(BAD_REQUEST)
@ResponseBody
public JsonError handleDecisionTreeNotExposedException(com.aquima.interactions.framework.handler.dtree.exceptions.DecisionTreeNotExposedException exception)

handleUnauthorizedException

@ExceptionHandler(UnauthorizedException.class)
@ResponseStatus(UNAUTHORIZED)
@ResponseBody
public JsonError handleUnauthorizedException()

clientParametersException

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

handleStartApplicationForbiddenException

@ExceptionHandler(StartApplicationForbiddenException.class)
@ResponseStatus(FORBIDDEN)
@ResponseBody
public JsonError handleStartApplicationForbiddenException(StartApplicationForbiddenException exception)

handleStartShortcutForbiddenException

@ExceptionHandler(StartShortcutForbiddenException.class)
@ResponseStatus(FORBIDDEN)
@ResponseBody
public JsonError handleStartShortcutForbiddenException(StartShortcutForbiddenException exception)

isAuthenticated

protected final boolean isAuthenticated(com.aquima.interactions.project.IUserData user)