Package com.omarigrant.budget.controller.api

Class BudgetController

java.lang.Object

com.omarigrant.budget.controller.api.BudgetController

@RestController
public class BudgetController
extends Object

Rest Controller for handling the api for Budgets

Author:

Omari Grant

Constructor Summary

Constructors

Constructor	Description
BudgetController()

Method Summary

Modifier and Type	Method	Description
List<BudgetDTO>	getAllBudgets(org.springframework.security.oauth2.jwt.Jwt jwt)	Get a list of Budgets for a authenicated user
BudgetDTO	getBudget(Long id, org.springframework.security.oauth2.jwt.Jwt jwt)	Get a single budget
BudgetDTO	postCalculateBudget(BudgetInputDTO budgetInputDTO)	Show the results of a calculation from a given input, without authentication or saving.
void	postDeleteBudget(Long id, org.springframework.security.oauth2.jwt.Jwt jwt)	Delete budget
BudgetDTO	postSaveBudget(BudgetInputDTO budgetInputDTO, org.springframework.security.oauth2.jwt.Jwt jwt)	Show the results of a calculation from a given input and save it
BudgetDTO	postUpdateBudget(Long id, BudgetInputDTO budgetInputDTO, org.springframework.security.oauth2.jwt.Jwt jwt)	Update the budget from a given input and save it

Methods inherited from class java.lang.Object

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

Constructor Details

BudgetController

public BudgetController()

Method Details

postCalculateBudget

@PostMapping("/budget/calculate")
public BudgetDTO postCalculateBudget(@RequestBody
 BudgetInputDTO budgetInputDTO)

Show the results of a calculation from a given input, without authentication or saving.

Parameters:

budgetInputDTO - The model used to retrieve input

Returns:

BudgetDTO to api in JSON

postSaveBudget

@PostMapping("/budget/create")
public BudgetDTO postSaveBudget(@RequestBody
 BudgetInputDTO budgetInputDTO,
 @AuthenticationPrincipal
 org.springframework.security.oauth2.jwt.Jwt jwt)

Show the results of a calculation from a given input and save it

Parameters:

budgetInputDTO - The model used to retrieve input

jwt - JWT token used to authenticate

Returns:

BudgetDTO to api in JSON

getAllBudgets

@GetMapping("/budget/all")
public List<BudgetDTO> getAllBudgets(@AuthenticationPrincipal
 org.springframework.security.oauth2.jwt.Jwt jwt)

Get a list of Budgets for a authenicated user

Parameters:

jwt - JWT token used to authenticate

Returns:

all BudgetDTOs

postDeleteBudget

@GetMapping("/budget/delete/{id}")
public void postDeleteBudget(@PathVariable(name="id")
 Long id,
 @AuthenticationPrincipal
 org.springframework.security.oauth2.jwt.Jwt jwt)

Delete budget

Parameters:

id - The budget id to be deleted

jwt - JWT token used to authenticate

getBudget

@GetMapping("/budget/{id}")
public BudgetDTO getBudget(@PathVariable(name="id")
 Long id,
 @AuthenticationPrincipal
 org.springframework.security.oauth2.jwt.Jwt jwt)

Get a single budget

Parameters:

id - id of budget

jwt - JWT token used to authenticate

Returns:

postUpdateBudget

@PostMapping("/budget/update/{id}")
public BudgetDTO postUpdateBudget(@PathVariable(name="id")
 Long id,
 @RequestBody
 BudgetInputDTO budgetInputDTO,
 @AuthenticationPrincipal
 org.springframework.security.oauth2.jwt.Jwt jwt)

Update the budget from a given input and save it

Parameters:

id - id of budget

budgetInputDTO - The model used to retrieve input

jwt - JWT token used to authenticate

Returns:

BudgetDTO to api in JSON