Package org.silverpeas.core.webapi.calendar

Class ICalendarResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.calendar.ICalendarResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

Direct Known Subclasses:

UserICalendarResource

@WebService
@Path("calendar/ical")
public class ICalendarResource
extends RESTWebService

A REST Web resource giving calendar data.

Author:

Yohann Chastagnier

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
ICalendarResource()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getCalendar(String calendarId)	Gets the JSON representation of a calendar represented by the given identifier.
javax.ws.rs.core.Response	getCalendarHead(String calendarId)	Gets HEAD data of a calendar represented by the given identifier.
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
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 by SilverpeasWebResource.getBasePath().
javax.ws.rs.core.Response	privateExport(String token)	Gets the JSON representation of a calendar represented by a given token.
javax.ws.rs.core.Response	privateExportHead(String token)	Gets private HEAD data of a calendar represented by a given token.

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

Constructor Detail

ICalendarResource

public ICalendarResource()

Method Detail

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 by SilverpeasWebResource.getBasePath().

Specified by:

getResourceBasePath in class RESTWebService

Returns:

the relative path that identifies this REST web service among all other REST web services.

getCalendarHead

@HEAD
@Path("public/{calendarId}")
public javax.ws.rs.core.Response getCalendarHead(@PathParam("calendarId")
                                                 String calendarId)

Gets HEAD data of a calendar represented by the given identifier. If it doesn't exist, a 404 HTTP code is returned.

Parameters:

calendarId - the identifier of the aimed calendar

Returns:

the response to the HTTP GET request with the JSON representation of the asked calendar.

See Also:

RESTWebService.WebProcess.execute()

getCalendar

@GET
@Path("public/{calendarId}")
public javax.ws.rs.core.Response getCalendar(@PathParam("calendarId")
                                             String calendarId)

Gets the JSON representation of a calendar represented by the given identifier. If it doesn't exist, a 404 HTTP code is returned.

Parameters:

calendarId - the identifier of the aimed calendar

Returns:

the response to the HTTP GET request with the JSON representation of the asked calendar.

See Also:

RESTWebService.WebProcess.execute()

privateExportHead

@HEAD
@Path("private/{token}")
public javax.ws.rs.core.Response privateExportHead(@PathParam("token")
                                                   String token)

Gets private HEAD data of a calendar represented by a given token. 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 calendars.

See Also:

RESTWebService.WebProcess.execute()

privateExport

@GET
@Path("private/{token}")
public javax.ws.rs.core.Response privateExport(@PathParam("token")
                                               String token)

Gets the JSON representation of a calendar represented by a given token. 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 calendars.

See Also:

RESTWebService.WebProcess.execute()

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.