RSSResource (Silverpeas Components 6.3 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.components.rssaggregator.web.RSSResource

All Implemented Interfaces:

org.silverpeas.core.web.rs.ProtectedWebResource, org.silverpeas.core.web.rs.WebAuthenticationValidation, org.silverpeas.core.web.rs.WebAuthorizationValidation, org.silverpeas.core.web.SilverpeasWebResource
```
@WebService
@Path("rss/{componentId}")
@Authorized
public class RSSResource
extends org.silverpeas.core.web.rs.RESTWebService
```

Nested Class Summary
- Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService
  org.silverpeas.core.web.rs.RESTWebService.WebProcess<R extends Object>, org.silverpeas.core.web.rs.RESTWebService.WebTreatment<R extends Object>

Field Summary

Fields
Modifier and Type Field Description

protected String componentId
- 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

RSSResource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getComponentId()`
`protected String`	`getResourceBasePath()`
`List<RSSItem>`	`getRSS(String agregate)`	Gets the JSON representation of the specified existing channel. If the channel doesn't exist, a 404 HTTP code is returned.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService
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

- Field Detail
  - componentId
```
@PathParam("componentId")
protected String componentId
```
- Constructor Detail
  - RSSResource
```
public RSSResource()
```
- Method Detail
  - getComponentId
```
public String getComponentId()
```
  - getResourceBasePath
```
protected String getResourceBasePath()
```
    Specified by:
    
    getResourceBasePath in class org.silverpeas.core.web.rs.RESTWebService
  - getRSS
```
@GET
@Produces("application/json")
public List<RSSItem> getRSS(@QueryParam("agregate")
                            String agregate)
```
    Gets the JSON representation of the specified existing channel.
    If the channel doesn't exist, a 404 HTTP code is returned.
    If the user isn't authentified, a 401 HTTP code is returned.
    If the user isn't authorized to access the channel, a 403 is returned.
    If a problem occurs when processing the request, a 503 HTTP code is returned.
    
    Parameters:
    
    agregate - String option to specify if we agregate channels items sorting them by date or not.
    It means URI has the following parameter : agregate=y or agregate=n
    
    Returns:
    
    the response to the HTTP GET request with the JSON representation of the asked channel items.