org.jasig.portlet.notice.controller.rest

Class JPANotificationRESTController

java.lang.Object

org.jasig.portlet.notice.controller.rest.JPANotificationRESTController

@Controller
 @RequestMapping(value="/api/v1/notifications")
public class JPANotificationRESTController
extends java.lang.Object

Controller for the REST endpoints exposed to manage JPA notifications.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQUEST_ROOT

Constructor Summary

Constructors

Constructor and Description
JPANotificationRESTController()

Method Summary

Modifier and Type	Method and Description
org.jasig.portlet.notice.rest.AddresseeDTO	addAddressee(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, long id, org.jasig.portlet.notice.rest.AddresseeDTO addressee) Create a new addressee for a notification.
org.jasig.portlet.notice.rest.EventDTO	createEvent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, long notificationId, org.jasig.portlet.notice.rest.EventDTO event) Create a new event.
org.jasig.portlet.notice.rest.EntryDTO	createNotification(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse response, org.jasig.portlet.notice.rest.EntryDTO entry) Create a notification.
org.jasig.portlet.notice.rest.AddresseeDTO	getAddressee(javax.servlet.http.HttpServletResponse resp, long notificationId, long addresseeId) Get a specific addressee
java.util.Set<org.jasig.portlet.notice.rest.AddresseeDTO>	getAddressees(long id) Get the set of addressees for a notification.
org.jasig.portlet.notice.rest.EventDTO	getEvent(javax.servlet.http.HttpServletResponse response, long notificationId, long eventId) Get a specific event.
java.util.List<org.jasig.portlet.notice.rest.EventDTO>	getEventsByNotification(long id) Get the list of events for a notification.
org.jasig.portlet.notice.rest.EntryDTO	getNotification(javax.servlet.http.HttpServletResponse response, long id, boolean full) Get 1 notification by id.
java.util.List<org.jasig.portlet.notice.rest.EntryDTO>	getNotifications(java.lang.Integer page, java.lang.Integer pageSize) Get the list of notifications.

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_ROOT

public static final java.lang.String REQUEST_ROOT

See Also:

Constant Field Values

Constructor Detail

JPANotificationRESTController

public JPANotificationRESTController()

Method Detail

getNotifications

@RequestMapping(method=GET)
 @ResponseBody
public java.util.List<org.jasig.portlet.notice.rest.EntryDTO> getNotifications(@RequestParam(value="page",required=false)
                                                                                                                          java.lang.Integer page,
                                                                                                                          @RequestParam(value="pageSize",required=false)
                                                                                                                          java.lang.Integer pageSize)

Get the list of notifications. Supports optional (and recommended!) paging

Parameters:

page - The 0 based page number

pageSize - the page size

Returns:

the list of matching notifications.

createNotification

@RequestMapping(method=POST)
 @ResponseStatus(value=CREATED)
 @ResponseBody
public org.jasig.portlet.notice.rest.EntryDTO createNotification(javax.servlet.http.HttpServletRequest req,
                                                                                                                                             javax.servlet.http.HttpServletResponse response,
                                                                                                                                             @RequestBody
                                                                                                                                             org.jasig.portlet.notice.rest.EntryDTO entry)

Create a notification.

Parameters:

req - the Http request

response - the Http response

entry - The Entry

Returns:

The persisted entry

getNotification

@RequestMapping(value="/{notificationId}",
                method=GET)
 @ResponseBody
public org.jasig.portlet.notice.rest.EntryDTO getNotification(javax.servlet.http.HttpServletResponse response,
                                                                                                                                                    @PathVariable(value="notificationId")
                                                                                                                                                    long id,
                                                                                                                                                    @RequestParam(value="full",required=false,defaultValue="false")
                                                                                                                                                    boolean full)

Get 1 notification by id.

Parameters:

response - the Http response

id - the id of the notification

full - optionally fetch addressee info. If false, addressee info will be omitted.

Returns:

the notification

getAddressees

@RequestMapping(value="/{notificationId}/addressees",
                method=GET)
 @ResponseBody
public java.util.Set<org.jasig.portlet.notice.rest.AddresseeDTO> getAddressees(@PathVariable(value="notificationId")
                                                                                                                                                                                long id)

Get the set of addressees for a notification.

Parameters:

id - the notification id

Returns:

the set of addressees

addAddressee

@RequestMapping(value="/{notificationId}/addressees",
                method=POST)
 @ResponseBody
 @ResponseStatus(value=CREATED)
public org.jasig.portlet.notice.rest.AddresseeDTO addAddressee(javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                                                 javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                                                                 @PathVariable(value="notificationId")
                                                                                                                                                                                                 long id,
                                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                                 org.jasig.portlet.notice.rest.AddresseeDTO addressee)

Create a new addressee for a notification.

Parameters:

req - the Http request

resp - the Http response

id - the notification id

addressee - the list of addressees

Returns:

the persisted addressee

getAddressee

@RequestMapping(value="/{notificationId}/addressees/{addresseeId}",
                method=GET)
 @ResponseBody
public org.jasig.portlet.notice.rest.AddresseeDTO getAddressee(javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                                              @PathVariable(value="notificationId")
                                                                                                                                                                              long notificationId,
                                                                                                                                                                              @PathVariable(value="addresseeId")
                                                                                                                                                                              long addresseeId)

Get a specific addressee

Parameters:

resp - the Http Response

notificationId - the notification id

addresseeId - the addressee id

Returns:

the matching addressee if available

getEventsByNotification

@RequestMapping(value="/{notificationId}/events",
                method=GET)
 @ResponseBody
public java.util.List<org.jasig.portlet.notice.rest.EventDTO> getEventsByNotification(@PathVariable(value="notificationId")
                                                                                                                                                                                   long id)

Get the list of events for a notification.

Parameters:

id - the notification id

Returns:

the list of events

getEvent

@RequestMapping(value="/{notificationId}/events/{eventId}",
                method=GET)
 @ResponseBody
public org.jasig.portlet.notice.rest.EventDTO getEvent(javax.servlet.http.HttpServletResponse response,
                                                                                                                                                              @PathVariable(value="notificationId")
                                                                                                                                                              long notificationId,
                                                                                                                                                              @PathVariable(value="eventId")
                                                                                                                                                              long eventId)

Get a specific event.

Parameters:

response - The Http response

notificationId - the notification id

eventId - the event id

Returns:

the matching event, if found

createEvent

@RequestMapping(value="/{notificationId}/events",
                method=POST)
 @ResponseStatus(value=CREATED)
 @ResponseBody
public org.jasig.portlet.notice.rest.EventDTO createEvent(javax.servlet.http.HttpServletRequest req,
                                                                                                                                                                                        javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                                                        @PathVariable(value="notificationId")
                                                                                                                                                                                        long notificationId,
                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                        org.jasig.portlet.notice.rest.EventDTO event)

Create a new event.

Parameters:

req - the Http request

resp - the Http response

notificationId - the notification id

event - the event id

Returns:

The newly persisted object