Package edu.ucsb.cs.scaffold.controller

Class ApiController

java.lang.Object

edu.ucsb.cs.scaffold.controller.ApiController

Direct Known Subclasses:

AdminsController, AssessmentController, ConceptsController, ConceptsYamlController, CourseOptionsController, CoursesController, CourseStaffController, CourseStaffCSVController, InstructorsController, JobsController, PatCredentialController, PLAssessmentController, PLAssessmentQuestionController, PLInstanceController, PLQuestionController, PLRepoController, PLScaffoldAssessmentController, RosterStudentsController, RosterStudentsCSVController, UserInfoController

public abstract class ApiController
extends Object

Constructor Summary

Constructors

Constructor	Description
ApiController()

Method Summary

Modifier and Type	Method	Description
protected Object	genericMessage(String message)
protected CurrentUser	getCurrentUser()
Object	handleEntityNotFoundException(Throwable e)
Object	handleForbiddenException(Throwable e)
Object	handleIllegalArgument(Throwable e)	This method handles the IllegalArgumentException.
org.springframework.http.ResponseEntity<Map<String,String>>	handleUnsupportedOperation(UnsupportedOperationException ex)

Methods inherited from class java.lang.Object

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

Constructor Details

ApiController

public ApiController()

Method Details

getCurrentUser

protected CurrentUser getCurrentUser()

genericMessage

protected Object genericMessage(String message)

handleEntityNotFoundException

@ExceptionHandler(EntityNotFoundException.class)
@ResponseStatus(NOT_FOUND)
public Object handleEntityNotFoundException(Throwable e)

handleForbiddenException

@ExceptionHandler(ForbiddenException.class)
@ResponseStatus(FORBIDDEN)
public Object handleForbiddenException(Throwable e)

handleUnsupportedOperation

@ExceptionHandler(java.lang.UnsupportedOperationException.class)
public org.springframework.http.ResponseEntity<Map<String,String>> handleUnsupportedOperation(UnsupportedOperationException ex)

handleIllegalArgument

@ExceptionHandler(java.lang.IllegalArgumentException.class)
@ResponseStatus(BAD_REQUEST)
public Object handleIllegalArgument(Throwable e)

This method handles the IllegalArgumentException. This maps to a 400/Bad Request.

Parameters:

e - the exception

Returns:

a map with the type and message of the exception