Package org.silverpeas.core.webapi.contribution

Class ContributionContentResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.contribution.AbstractContributionResource

org.silverpeas.core.webapi.contribution.ContributionContentResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("contribution/{componentInstanceId}/{contributionId}/content")
@Authorized
public class ContributionContentResource
extends AbstractContributionResource

User: Yohann Chastagnier Date: 21/05/13

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

Method Summary

Modifier and Type	Method	Description
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
String	getContributionId()
FormEntity	getFormContent(String lang)	Gets the JSON representation of contribution template.
FormEntity	getFormContent(String formId, String lang, boolean renderView)	Gets the JSON representation of contribution template.
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().

Methods inherited from class org.silverpeas.core.webapi.contribution.AbstractContributionResource

getDefaultFormId, getDefaultPublicationTemplateLanguage, getFormFieldValue, getFormFieldValues, getPublicationTemplate

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

Constructor Detail

ContributionContentResource

public ContributionContentResource()

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 of 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.

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.

getContributionId

public String getContributionId()

Specified by:

getContributionId in class AbstractContributionResource

getFormContent

@GET
@Path("form")
@Produces("application/json")
public FormEntity getFormContent(@QueryParam("lang")
                                 String lang)

Gets the JSON representation of contribution template. If it doesn't exist, a 404 HTTP code is returned. If the user isn't authentified, a 401 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Returns:

the response to the HTTP GET request with the JSON representation of form informations.

getFormContent

@GET
@Path("form/{formId}")
@Produces("application/json")
public FormEntity getFormContent(@PathParam("formId")
                                 String formId,
                                 @QueryParam("lang")
                                 String lang,
                                 @QueryParam("renderView")
                                 boolean renderView)

Gets the JSON representation of contribution template. If it doesn't exist, a 404 HTTP code is returned. If the user isn't authentified, a 401 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Parameters:

formId - the form identifier

lang - the language

Returns:

the response to the HTTP GET request with the JSON representation of form informations.