Class ReminderResource
- java.lang.Object
-
- org.silverpeas.core.web.rs.RESTWebService
-
- org.silverpeas.core.webapi.reminder.ReminderResource
-
- All Implemented Interfaces:
ProtectedWebResource
,WebAuthenticationValidation
,WebAuthorizationValidation
,SilverpeasWebResource
@WebService @Path("reminder/{componentInstanceId}/{type}/{localId}") @Authenticated public class ReminderResource extends RESTWebService
A REST Web resource giving reminder data.- Author:
- silveryocha
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService
RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>
-
-
Field Summary
-
Fields inherited from class org.silverpeas.core.web.rs.RESTWebService
RESPONSE_HEADER_ARRAYSIZE
-
Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource
BASE_PATH
-
-
Constructor Summary
Constructors Constructor Description ReminderResource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReminderEntity
createReminder(ReminderEntity reminderEntity)
Creates the reminder from its JSON representation and returns it once created.
If the user isn't authenticated, a 401 HTTP code is returned.void
deleteReminder(String id)
Deletes the given reminder from its JSON representation.
If the user isn't authenticated, a 401 HTTP code is returned.String
getComponentId()
Gets the identifier of the component instance to which the requested resource belongs to.List<String>
getPossibleDurations(String contributionProperty)
Gets the identifier list of possible of durations.List<ReminderEntity>
getReminders()
Gets the JSON representation of a list of reminder.protected String
getResourceBasePath()
Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given bySilverpeasWebResource.getBasePath()
.ReminderEntity
updateReminder(String id, ReminderEntity reminderEntity)
Updates the reminder from its JSON representation and returns it once updated.
If the user isn't authenticated, a 401 HTTP code is returned.-
Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
createWebResourceUri, fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource
validateUserAuthorization
-
Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation
validateUserAuthentication
-
-
-
-
Method Detail
-
getPossibleDurations
@Path("possibledurations/{property}") @GET @Produces("application/json") public List<String> getPossibleDurations(@PathParam("property") String contributionProperty)
Gets the identifier list of possible of durations.An identifier of a duration is the concatenation about the duration value and the duration unit (
TimeUnit
).
15MINUTE
for example.- Returns:
- a filled list if any, or an empty one if no trigger can be scheduled.
- See Also:
RESTWebService.WebProcess.execute()
-
getReminders
@GET @Produces("application/json") public List<ReminderEntity> getReminders()
Gets the JSON representation of a list of reminder. If it doesn't exist, a 404 HTTP code is returned.- Returns:
- the response to the HTTP GET request with the JSON representation of the asked reminders.
- See Also:
RESTWebService.WebProcess.execute()
-
createReminder
@POST @Produces("application/json") public ReminderEntity createReminder(ReminderEntity reminderEntity)
Creates the reminder from its JSON representation and returns it once created.
If the user isn't authenticated, a 401 HTTP code is returned. If the user isn't authorized to save the reminder, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.- Parameters:
reminderEntity
- the reminder data- Returns:
- the response to the HTTP POST request with the JSON representation of the created reminder.
-
updateReminder
@Path("{id}") @PUT @Produces("application/json") public ReminderEntity updateReminder(@PathParam("id") String id, ReminderEntity reminderEntity)
Updates the reminder from its JSON representation and returns it once updated.
If the user isn't authenticated, a 401 HTTP code is returned. If the user isn't authorized to save the reminder, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.- Parameters:
id
- a reminder identifier, the one of reminderEntityreminderEntity
- the reminder data- Returns:
- the response to the HTTP POST request with the JSON representation of the updated reminder.
-
deleteReminder
@DELETE @Path("{id}") @Produces("application/json") public void deleteReminder(@PathParam("id") String id)
Deletes the given reminder from its JSON representation.
If the user isn't authenticated, a 401 HTTP code is returned. If the user isn't authorized to delete the reminder, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.- Parameters:
id
- a reminder identifier
-
getResourceBasePath
protected String getResourceBasePath()
Description copied from class:RESTWebService
Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given bySilverpeasWebResource.getBasePath()
.- Specified by:
getResourceBasePath
in classRESTWebService
- Returns:
- the relative path that identifies this REST web service among all other REST web services.
-
getComponentId
public String getComponentId()
Description copied from interface:SilverpeasWebResource
Gets the identifier of the component instance to which the requested resource belongs to.- Returns:
- the identifier of the Silverpeas component instance.
-
-