Package org.silverpeas.core.webapi.documenttemplate

Class DocumentTemplateResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.documenttemplate.DocumentTemplateResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("documentTemplates")
@Authenticated
public class DocumentTemplateResource
extends RESTWebService

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

Method Summary

Modifier and Type	Method	Description
DocumentTemplateEntity	get(String id)	Gets the JSON representation of a document template.
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().
List<DocumentTemplateEntity>	listAll()	Gets the JSON representation of a list of document template.

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

DocumentTemplateResource

public DocumentTemplateResource()

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.

get

@GET
@Path("{id}")
@Produces("application/json")
public DocumentTemplateEntity get(@PathParam("id")
                                  String id)

Gets the JSON representation of a document template. 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 document template.

listAll

@GET
@Produces("application/json")
public List<DocumentTemplateEntity> listAll()

Gets the JSON representation of a list of document template. 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 document templates.

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.