Package edu.ucsb.cs156.dining.controllers

Class ApiController

java.lang.Object

edu.ucsb.cs156.dining.controllers.ApiController

Direct Known Subclasses:

AdminController, DiningCommonsController, ModeratorController, ReviewController, SystemInfoController, UCSBDiningMenuController, UCSBDiningMenuItemsController, UserInfoController, UsersController

public abstract class ApiController
extends Object

This is an abstract class that provides common functionality for all API controllers.

Constructor Summary

Constructors

Constructor	Description
ApiController()

Method Summary

Modifier and Type	Method	Description
protected Object	genericMessage(String message)	This method returns a generic message.
protected CurrentUser	getCurrentUser()	This method returns the current user.
Object	handleGenericException(Throwable e)	This method handles the EntityNotFoundException.
org.springframework.http.ResponseEntity<Map<String,String>>	handleUnsupportedOperation(UnsupportedOperationException e)	This method handles the UnsupportedOperationException.

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()

This method returns the current user.

Returns:

the current user

genericMessage

protected Object genericMessage(String message)

This method returns a generic message.

Parameters:

message - the message

Returns:

a map with the message

handleGenericException

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

This method handles the EntityNotFoundException.

Parameters:

e - the exception

Returns:

a map with the type and message of the exception

handleUnsupportedOperation

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

This method handles the UnsupportedOperationException. This maps to a 403/Forbidden.

Parameters:

e - the exception

Returns:

a map with the type and message of the exception