Package edu.ucsb.cs156.example.controllers

Class ArticlesController

java.lang.Object

edu.ucsb.cs156.example.controllers.ApiController

edu.ucsb.cs156.example.controllers.ArticlesController

@RequestMapping("/api/articles")
@RestController
public class ArticlesController
extends ApiController

This is a REST controller for Articles

Constructor Summary

Constructors

Constructor	Description
ArticlesController()

Method Summary

Modifier and Type	Method	Description
Iterable<Article>	allArticles()	List all Articles
Object	deleteArticle(Long id)	Delete an Article
Article	getById(Long id)	Get a single article by id
Article	postArticle(String title, String url, String explanation, String email, LocalDateTime dateAdded)	Create a new article
Article	updateArticle(Long id, @Valid Article incoming)	Update a single article

Methods inherited from class edu.ucsb.cs156.example.controllers.ApiController

genericMessage, getCurrentUser, handleGenericException

Methods inherited from class java.lang.Object

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

Constructor Details

ArticlesController

public ArticlesController()

Method Details

allArticles

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/all")
public Iterable<Article> allArticles()

List all Articles

Returns:

an iterable of Article

getById

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("")
public Article getById(@RequestParam
 Long id)

Get a single article by id

Parameters:

id - the id of the article

Returns:

an Article

postArticle

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PostMapping("/post")
public Article postArticle(@RequestParam
 String title,
 @RequestParam
 String url,
 @RequestParam
 String explanation,
 @RequestParam
 String email,
 @RequestParam("dateAdded") @DateTimeFormat(iso=DATE_TIME)
 LocalDateTime dateAdded)
                    throws com.fasterxml.jackson.core.JsonProcessingException

Create a new article

Parameters:

title - title of the article

url - url of the article

explanation - content of the article

email - email of the author

dateAdded - date of creation

Returns:

the saved article

Throws:

com.fasterxml.jackson.core.JsonProcessingException

updateArticle

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PutMapping("")
public Article updateArticle(@RequestParam
 Long id,
 @RequestBody @Valid
 @Valid Article incoming)

Update a single article

Parameters:

id - id of the article to update

incoming - the new article

Returns:

the updated article object

deleteArticle

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@DeleteMapping("")
public Object deleteArticle(@RequestParam
 Long id)

Delete an Article

Parameters:

id - of the article to delete

Returns:

a message indicating the article was deleted