es.uvigo.esei.dgss.letta.rest

Class EventResource

java.lang.Object

es.uvigo.esei.dgss.letta.rest.EventResource

@Path(value="event")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public class EventResource
extends Object

Resource that represents the Events in the application.

Author:

Alberto Gutiérrez Jácome, Alberto Pardellas Soto, Jesús Álvarez Casanova, Adolfo Álvarez López, Abel Fernández Nandín

Constructor Summary

Constructors

Constructor and Description
EventResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	advancedSearch(String query, String state, String category, int page, int size) REST aplication of the EJB advanced_search method
javax.ws.rs.core.Response	attendToEvent(int id)
javax.ws.rs.core.Response	cancelEvent(int eventId)
javax.ws.rs.core.Response	create(es.uvigo.esei.dgss.letta.domain.entities.Event event)
javax.ws.rs.core.Response	get(int id)
javax.ws.rs.core.Response	getAttendees(int id)
javax.ws.rs.core.Response	getEventInfo(int eventId) Returns the Event information
javax.ws.rs.core.Response	highlighted() Returns the list of Events that are currently highlighted.
javax.ws.rs.core.Response	list(int page, int size) Returns the list of Events stored in the application, sorted by ascending date and paginated.
javax.ws.rs.core.Response	search(String query, int page, int size) Returns the list of Events matching a given search query.
javax.ws.rs.core.Response	update(int id, es.uvigo.esei.dgss.letta.domain.entities.Event event)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventResource

public EventResource()

Method Detail

get

@GET
 @Path(value="{id: \\d+}")
public javax.ws.rs.core.Response get(@PathParam(value="id")
                                                                     int id)

list

@GET
public javax.ws.rs.core.Response list(@QueryParam(value="page") @DefaultValue(value="1")
                                           int page,
                                           @QueryParam(value="size") @DefaultValue(value="20")
                                           int size)
                                    throws IllegalArgumentException

Returns the list of Events stored in the application, sorted by ascending date and paginated.

Parameters:

page - Page number to retrieve, counting from 1. If not set, it will be defaulted to the first page.

size - Number of events to retrieve per page. If not set, it will be defaulted to twenty.

Returns:

An OK HTTP response containing the list of events in the requested page.

Throws:

IllegalArgumentException - If either the page number is less than one or the page size is less than zero.

highlighted

@GET
 @Path(value="highlighted")
public javax.ws.rs.core.Response highlighted()

Returns the list of Events that are currently highlighted.

Returns:

A OK HTTP response containing the list of the events in the application that are currently highlighted.

search

@GET
 @Path(value="search")
public javax.ws.rs.core.Response search(@QueryParam(value="query") @DefaultValue(value="")
                                                                    String query,
                                                                    @QueryParam(value="page") @DefaultValue(value="1")
                                                                    int page,
                                                                    @QueryParam(value="size") @DefaultValue(value="20")
                                                                    int size)
                                                             throws IllegalArgumentException

Returns the list of Events matching a given search query. The search will be performed in both the event's title and the summary.

Parameters:

query - The search query (title/summary terms) to perform. If not set, it will be defaulted to an empty search query, thus supposedly returning all the events (equivalent to list(int, int)).

page - Page number to retrieve, counting from 1. If not set, it will be defaulted to the first page.

size - Number of events to retrieve per page. If not set, it will be defaulted to twenty.

Returns:

An OK HTTP response containing the list of events that result from executing a search with the specified query in the requested page.

Throws:

IllegalArgumentException - If either the page number is less than one or the page size is less than zero.

create

@POST
public javax.ws.rs.core.Response create(es.uvigo.esei.dgss.letta.domain.entities.Event event)
                                       throws IllegalArgumentException,
                                              SecurityException

Throws:

IllegalArgumentException

SecurityException

update

@PUT
 @Path(value="{id: \\d+}")
public javax.ws.rs.core.Response update(@PathParam(value="id")
                                                                        int id,
                                                                        es.uvigo.esei.dgss.letta.domain.entities.Event event)
                                                                 throws IllegalArgumentException,
                                                                        SecurityException,
                                                                        javax.mail.MessagingException

Throws:

IllegalArgumentException

SecurityException

javax.mail.MessagingException

getAttendees

@GET
 @Path(value="{id: \\d+}/attendees")
public javax.ws.rs.core.Response getAttendees(@PathParam(value="id")
                                                                                        int id)

attendToEvent

@POST
 @Path(value="{id: \\d+}/attendees")
public javax.ws.rs.core.Response attendToEvent(@PathParam(value="id")
                                                                                          int id)
                                                                                   throws SecurityException,
                                                                                          IllegalArgumentException

Throws:

SecurityException

IllegalArgumentException

advancedSearch

@GET
 @Path(value="advanced_search")
public javax.ws.rs.core.Response advancedSearch(@QueryParam(value="query") @DefaultValue(value="")
                                                                                     String query,
                                                                                     @QueryParam(value="state") @DefaultValue(value="AVAILABLE")
                                                                                     String state,
                                                                                     @QueryParam(value="category") @DefaultValue(value="TELEVISION")
                                                                                     String category,
                                                                                     @QueryParam(value="page") @DefaultValue(value="1")
                                                                                     int page,
                                                                                     @QueryParam(value="size") @DefaultValue(value="20")
                                                                                     int size)
                                                                              throws IllegalArgumentException

REST aplication of the EJB advanced_search method

Parameters:

query -

state -

category -

page -

size -

Returns:

Throws:

IllegalArgumentException

getEventInfo

@GET
 @Path(value="{id}")
public javax.ws.rs.core.Response getEventInfo(@PathParam(value="id")
                                                                        int eventId)
                                                                 throws IllegalArgumentException

Returns the Event information

Parameters:

eventId - indicates the Event id

Returns:

the Event information

Throws:

IllegalArgumentException - if the Event is not found

cancelEvent

@POST
 @Path(value="{id: \\d+}/cancel")
public javax.ws.rs.core.Response cancelEvent(@PathParam(value="id")
                                                                                     int eventId)