org.apache.syncope.common.services

Interface NotificationService

All Superinterfaces:

JAXRSService

@Path(value="notifications")
public interface NotificationService
extends JAXRSService

REST operations for notifications.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(NotificationTO notificationTO) Creates a new notification.
void	delete(Long notificationId) Deletes the notification matching the given id.
List<NotificationTO>	list() Returns a list of all notifications.
NotificationTO	read(Long notificationId) Returns notification with matching id.
void	update(Long notificationId, NotificationTO notificationTO) Updates the notification matching the given id.

Method Detail

read

@GET
@Path(value="{notificationId}")
@Produces(value={"application/xml","application/json"})
NotificationTO read(@NotNull@PathParam(value="notificationId")
                                    Long notificationId)

Returns notification with matching id.

Parameters:

notificationId - id of notification to be read

Returns:

notification with matching id

list

@GET
@Produces(value={"application/xml","application/json"})
List<NotificationTO> list()

Returns a list of all notifications.

Returns:

list of all notifications.

create

@POST
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response create(@NotNull
                                             NotificationTO notificationTO)

Creates a new notification.

Parameters:

notificationTO - Creates a new notification.

Returns:

Response object featuring Location header of created notification

update

@PUT
@Path(value="{notificationId}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="notificationId")
                            Long notificationId,
                            @NotNull
                            NotificationTO notificationTO)

Updates the notification matching the given id.

Parameters:

notificationId - id of notification to be updated

notificationTO - notification to be stored

delete

@DELETE
@Path(value="{notificationId}")
void delete(@NotNull@PathParam(value="notificationId")
                      Long notificationId)

Deletes the notification matching the given id.

Parameters:

notificationId - id for notification to be deleted