es.uvigo.esei.dgss.teama.microstories.rest

Class UserResource

java.lang.Object

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

@Path(value="user")
public class UserResource
extends Object

Resource that represents the users in the application.

Constructor Summary

Constructors

Constructor and Description
UserResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteStoryById(String login, int id) Deletes an story specified by an id.
javax.ws.rs.core.Response	findStoriesByAuthor(String login, int page, int limit) Returns a List<Story> written by a specified Author.
javax.ws.rs.core.Response	findStoryById(String login, int id) Returns the story identified by the id.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserResource

public UserResource()

Method Detail

findStoriesByAuthor

@Path(value="/{login}/microstory")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findStoriesByAuthor(@PathParam(value="login")
                                                                                                                                   String login,
                                                                                                                                   @QueryParam(value="page")
                                                                                                                                   int page,
                                                                                                                                   @QueryParam(value="limit")
                                                                                                                                   int limit)
                                                                                                                            throws SecurityException,
                                                                                                                                   IllegalArgumentException

Returns a List<Story> written by a specified Author.

Parameters:

login - the Author that wants to retrieve his stories.

page - the number of page.

limit - the number of stories in the page.

Returns:

an OK response containing the List<Story> with the provided author login.

Throws:

SecurityException

IllegalArgumentException

findStoryById

@Path(value="/{login}/microstory/{id}")
 @GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response findStoryById(@PathParam(value="login")
                                                                                                                                                                       String login,
                                                                                                                                                                       @PathParam(value="id")
                                                                                                                                                                       int id)
                                                                                                                                                                throws SecurityException

Returns the story identified by the id.

Parameters:

login - the Author that wants to retrieve his stories.

id - the story identifier.

Returns:

an OK response containing the Story with the provided id.

Throws:

IllegalArgumentException - if id is null or if it does not correspond with any story.

SecurityException - if the story can not be found or if the story has not published

deleteStoryById

@Path(value="/{login}/microstory/{id}")
 @DELETE
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response deleteStoryById(@PathParam(value="login")
                                                                                                                                                                            String login,
                                                                                                                                                                            @PathParam(value="id")
                                                                                                                                                                            int id)
                                                                                                                                                                     throws SecurityException

Deletes an story specified by an id.

Parameters:

login - the Author that wants to delete his Story.

id - the story identifier.

Returns:

an OK response if the story was deleted.

Throws:

IllegalArgumentException - if id is null or if it does not correspond with any story.

SecurityException - if the story can not be found or if the author is not the owner.