es.uvigo.esei.dgss.letta.rest

Class UserResource

java.lang.Object

es.uvigo.esei.dgss.letta.rest.UserResource

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

Resource that represents the User private funcionalities

Author:

Jesús Álvarez Casanova, Adolfo Álvarez López

Constructor Summary

Constructors

Constructor and Description
UserResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createEvent(String userLogin, es.uvigo.esei.dgss.letta.domain.entities.Event event) Creates an Event
javax.ws.rs.core.Response	getEventsCreatedByUser(String userLogin) Returns the Event created by the current User
javax.ws.rs.core.Response	getEventsJoinedByUser(String userLogin, int start, int count) Returns the Event joined by the current User sorted by descending Date
javax.ws.rs.core.Response	joinEvent(String userLogin, int eventId) Allows the current User to join into an Event
javax.ws.rs.core.Response	modifyEvent(String userLogin, es.uvigo.esei.dgss.letta.domain.entities.Event event) Modifies an Event

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

getEventsJoinedByUser

@GET
 @Path(value="{login}/joined")
public javax.ws.rs.core.Response getEventsJoinedByUser(@PathParam(value="login")
                                                                                           String userLogin,
                                                                                           @QueryParam(value="start") @DefaultValue(value="0")
                                                                                           int start,
                                                                                           @QueryParam(value="count") @DefaultValue(value="20")
                                                                                           int count)

Returns the Event joined by the current User sorted by descending Date

Parameters:

userLogin - Login of the User

start - Index of the list of Event where you want to start the list. If not set, it will be defaulted to the first element

count - Number of Event asked for retrieved. If not set, it will be defaulted to twenty

Returns:

An OK HTTP response containing the list of events or a response with no content if the login doesn't match with the logged user

getEventsCreatedByUser

@GET
 @Path(value="{login}/created")
public javax.ws.rs.core.Response getEventsCreatedByUser(@PathParam(value="login")
                                                                                             String userLogin)

Returns the Event created by the current User

Parameters:

userLogin - Login of the User

Returns:

An OK HTTP response containing the list of events or a response with no content if the login doesn't match with the logged user

joinEvent

@POST
 @Path(value="{login}/joined/{id}")
 @Consumes(value="*/*")
public javax.ws.rs.core.Response joinEvent(@PathParam(value="login")
                                                                                                             String userLogin,
                                                                                                             @PathParam(value="id")
                                                                                                             int eventId)
                                                                                                      throws SecurityException,
                                                                                                             es.uvigo.esei.dgss.letta.service.util.exceptions.EventAlredyJoinedException,
                                                                                                             es.uvigo.esei.dgss.letta.service.util.exceptions.EventIsCancelledException

Allows the current User to join into an Event

Parameters:

userLogin - Login of the User

eventId - Unique identifier of an Event

Returns:

An OK HTTP response or a response with no content if the login doesn't match with the logged user

Throws:

SecurityException - If the User logged login doesn't match with the login sent

es.uvigo.esei.dgss.letta.service.util.exceptions.EventAlredyJoinedException - If the User is already register for the event.

es.uvigo.esei.dgss.letta.service.util.exceptions.EventIsCancelledException - If the Event is cancelled

createEvent

@POST
 @Path(value="{login}/create")
public javax.ws.rs.core.Response createEvent(@PathParam(value="login")
                                                                                  String userLogin,
                                                                                  es.uvigo.esei.dgss.letta.domain.entities.Event event)
                                                                           throws SecurityException

Creates an Event

Parameters:

userLogin - indicates the owner login

event - indicates the new Event

Returns:

CREATED response with the URI of the new event in the Location header.

Throws:

SecurityException - If the User logged login doesn't match with the login sent

modifyEvent

@PUT
 @Path(value="{login}/modify")
public javax.ws.rs.core.Response modifyEvent(@PathParam(value="login")
                                                                                 String userLogin,
                                                                                 es.uvigo.esei.dgss.letta.domain.entities.Event event)
                                                                          throws SecurityException,
                                                                                 IllegalArgumentException,
                                                                                 es.uvigo.esei.dgss.letta.service.util.exceptions.UserNotAuthorizedException

Modifies an Event

Parameters:

userLogin - indicates the owner login

event - indicates the modified Event

Returns:

An OK HTTP response or a response with no content if the login doesn't match with the logged user

Throws:

SecurityException - If the User logged login doesn't match with the login sent

es.uvigo.esei.dgss.letta.service.util.exceptions.UserNotAuthorizedException - If the User is not the owner

IllegalArgumentException - If the Event does not exists