es.uvigo.esei.dgss.letta.rest

Class UserResource

java.lang.Object

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

@Path(value="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, world1mehdi

Constructor Summary

Constructors

Constructor and Description
UserResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	acceptFriendRequest(String userLogin, String friendLogin) Accepts friend requests
javax.ws.rs.core.Response	cancelFriendRequest(String userLogin, String friendLogin) Cancels friend requests
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	rejectFriendRequest(String userLogin, String friendLogin) Rejects friend requests
javax.ws.rs.core.Response	removeFriendship(String userLogin, String friendLogin) Remove friendship
javax.ws.rs.core.Response	searchForAnUser(String userLogin, String keyword)
javax.ws.rs.core.Response	sendFriendRequest(String userLogin, String friendLogin) Sends friend requests

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

sendFriendRequest

@POST
 @Path(value="{login}/sendRequest/{friendLogin}")
public javax.ws.rs.core.Response sendFriendRequest(@PathParam(value="login")
                                                                                                           String userLogin,
                                                                                                           @PathParam(value="friendLogin")
                                                                                                           String friendLogin)
                                                                                                    throws IllegalArgumentException,
                                                                                                           SecurityException

Sends friend requests

Parameters:

userLogin - the login if User

friendLogin - the login of friend's User

Returns:

An OK HTTP response

Throws:

IllegalArgumentException - if the provided parameters are not valid.

SecurityException - if the user does not have permission.

cancelFriendRequest

@POST
 @Path(value="{login}/cancelRequest/{friendLogin}")
public javax.ws.rs.core.Response cancelFriendRequest(@PathParam(value="login")
                                                                                                               String userLogin,
                                                                                                               @PathParam(value="friendLogin")
                                                                                                               String friendLogin)
                                                                                                        throws IllegalArgumentException,
                                                                                                               SecurityException

Cancels friend requests

Parameters:

userLogin - the login if User

friendLogin - the login of friend's User

Returns:

An OK HTTP response

Throws:

IllegalArgumentException - if the provided parameters are not valid.

SecurityException - if the user does not have permission.

acceptFriendRequest

@PUT
 @Path(value="{login}/acceptRequest/{friendLogin}")
public javax.ws.rs.core.Response acceptFriendRequest(@PathParam(value="login")
                                                                                                              String userLogin,
                                                                                                              @PathParam(value="friendLogin")
                                                                                                              String friendLogin)
                                                                                                       throws IllegalArgumentException,
                                                                                                              SecurityException

Accepts friend requests

Parameters:

userLogin - the login if User

friendLogin - the login of friend's User

Returns:

An OK HTTP response

Throws:

IllegalArgumentException - if the provided parameters are not valid.

SecurityException - if the user does not have permission.

rejectFriendRequest

@PUT
 @Path(value="{login}/rejectRequest/{friendLogin}")
public javax.ws.rs.core.Response rejectFriendRequest(@PathParam(value="login")
                                                                                                              String userLogin,
                                                                                                              @PathParam(value="friendLogin")
                                                                                                              String friendLogin)
                                                                                                       throws IllegalArgumentException,
                                                                                                              SecurityException

Rejects friend requests

Parameters:

userLogin - the login if User

friendLogin - the login of friend's User

Returns:

An OK HTTP response

Throws:

IllegalArgumentException - if the provided parameters are not valid.

SecurityException - if the user does not have permission.

removeFriendship

@DELETE
 @Path(value="{login}/removeFriendship/{friendLogin}")
public javax.ws.rs.core.Response removeFriendship(@PathParam(value="login")
                                                                                                                 String userLogin,
                                                                                                                 @PathParam(value="friendLogin")
                                                                                                                 String friendLogin)
                                                                                                          throws IllegalArgumentException,
                                                                                                                 SecurityException

Remove friendship

Parameters:

userLogin - the login if User

friendLogin - the login of friend's User

Returns:

An OK HTTP response

Throws:

IllegalArgumentException - if the provided parameters are not valid.

SecurityException - if the user does not have permission.

searchForAnUser

@GET
 @Path(value="{login}/searchUser/{keyword}")
public javax.ws.rs.core.Response searchForAnUser(@PathParam(value="login")
                                                                                                   String userLogin,
                                                                                                   @PathParam(value="keyword")
                                                                                                   String keyword)