es.uvigo.esei.dgss.teamc.microstories.rest

Class UserResource

java.lang.Object

es.uvigo.esei.dgss.teamc.microstories.rest.UserResource

@Path(value="user/{login}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class UserResource
extends Object

REST resource for users.

Author:

Manuel Vázquez Augusto

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
UserResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createStory(String login, StoryDTO storyData) Creates a Story
javax.ws.rs.core.Response	getUserStories(String login, int pageIndex) Retrieves the stories created by a given user
protected es.uvigo.esei.dgss.teamc.microstories.entities.Story	storyDTOToStory(StoryDTO storyData) Convert a StoryDTO into a Story
javax.ws.rs.core.Response	updateStory(String login, Long id, StoryDTO story)

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_SIZE

public static int PAGE_SIZE

Constructor Detail

UserResource

public UserResource()

Method Detail

getUserStories

@GET
 @Path(value="microstory")
public javax.ws.rs.core.Response getUserStories(@PathParam(value="login")
                                                                                String login,
                                                                                @QueryParam(value="page")
                                                                                int pageIndex)

Retrieves the stories created by a given user

Parameters:

login - of the user to retrieve the stories

pageIndex - page index to show the stories

Returns:

an OK response containing the list of stories created by the given user

Throws:

SecurityException - when the user is not logged or the logged user is different from the list author

IllegalArgumentException - when the given login is null

createStory

@Path(value="microstory")
 @POST
public javax.ws.rs.core.Response createStory(@PathParam(value="login")
                                                                              String login,
                                                                              StoryDTO storyData)
                                                                       throws SecurityException

Creates a Story

Parameters:

login - author of the Story

storyData - data of the story

Returns:

an CREATED response containing the uri to the story

Throws:

SecurityException - then user is not logged or the logged user is different from the story author

IllegalArgumentException - when the story is null or already exists

storyDTOToStory

protected es.uvigo.esei.dgss.teamc.microstories.entities.Story storyDTOToStory(StoryDTO storyData)

Convert a StoryDTO into a Story

Parameters:

storyData - storyDTO to convert a Story

Returns:

a Story with the data of the storyDTO

updateStory

@PUT
 @Path(value="microstory/{id}")
public javax.ws.rs.core.Response updateStory(@PathParam(value="login")
                                                                                  String login,
                                                                                  @PathParam(value="id")
                                                                                  Long id,
                                                                                  StoryDTO story)