Interface NotificationService
-
- All Superinterfaces:
JAXRSService
- All Known Implementing Classes:
NotificationServiceImpl
@Path("notifications") public interface NotificationService extends JAXRSService
REST operations for notifications.
-
-
Field Summary
-
Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
actionJob(JobAction action)
Executes an action on the notification job.javax.ws.rs.core.Response
create(@NotNull NotificationTO notificationTO)
Creates a new notification.void
delete(@NotNull String key)
Deletes the notification matching the given key.JobTO
getJob()
Returns details about notification job.List<NotificationTO>
list()
Returns a list of all notifications.NotificationTO
read(@NotNull String key)
Returns notification with matching key.void
update(@NotNull NotificationTO notificationTO)
Updates the notification matching the given key.
-
-
-
Method Detail
-
read
@GET @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) NotificationTO read(@NotNull @PathParam("key") @NotNull String key)
Returns notification with matching key.- Parameters:
key
- key of notification to be read- Returns:
- notification with matching key
-
list
@GET @Produces({"application/json","application/yaml","application/xml"}) List<NotificationTO> list()
Returns a list of all notifications.- Returns:
- list of all notifications.
-
create
@POST @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response create(@NotNull @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("{key}") @Consumes({"application/json","application/yaml","application/xml"}) @Produces({"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull NotificationTO notificationTO)
Updates the notification matching the given key.- Parameters:
notificationTO
- notification to be stored
-
delete
@DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key)
Deletes the notification matching the given key.- Parameters:
key
- key for notification to be deleted
-
getJob
@GET @Path("job") @Produces({"application/json","application/yaml","application/xml"}) JobTO getJob()
Returns details about notification job.- Returns:
- details about notification job
-
actionJob
@POST @Path("job") @Produces({"application/json","application/yaml","application/xml"}) void actionJob(@QueryParam("action") JobAction action)
Executes an action on the notification job.- Parameters:
action
- action to execute
-
-