Package org.silverpeas.core.webapi.publication

Class PublicationResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.publication.AbstractPublicationResource

org.silverpeas.core.webapi.publication.PublicationResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("private/publications/{componentId}")
@Authorized
public class PublicationResource
extends AbstractPublicationResource

A REST Web resource providing access to publications through private mode.

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService

RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>

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

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addAlias(String pubId, String nodeId, String aliasComponentId)
javax.ws.rs.core.Response	deleteAlias(String pubId, String nodeId, String aliasComponentId)
javax.ws.rs.core.Response	deleteLink(String pubId, String linkId)
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
List<LocationEntity>	getLocations(String pubId, String language)
List<PublicationEntity>	getPublications(String nodeId, boolean withAttachments)	Gets the nodes that are children of a parent node.
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().
protected URI	identifiedBy(URI uri)
protected boolean	isNodeReadable(NodePK nodePK)

Methods inherited from class org.silverpeas.core.webapi.publication.AbstractPublicationResource

getNodeService, getPublicationEntity, getPublicationService

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

PublicationResource

public PublicationResource()

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.

getPublications

@GET
@Produces("application/json")
public List<PublicationEntity> getPublications(@QueryParam("node")
                                               String nodeId,
                                               @QueryParam("withAttachments")
                                               boolean withAttachments)

Description copied from class: AbstractPublicationResource

Gets the nodes that are children of a parent node.

Overrides:

getPublications in class AbstractPublicationResource

Parameters:

nodeId - The ID of the parent node.

withAttachments - Indicated whether attachments related to publications are required.

Returns:

An array of the nodes whose parent is the node matching the specified ID.

deleteLink

@DELETE
@Path("{pubId}/links/{linkId}")
@Produces("application/json")
public javax.ws.rs.core.Response deleteLink(@PathParam("pubId")
                                            String pubId,
                                            @PathParam("linkId")
                                            String linkId)

getLocations

@GET
@Path("{pubId}/locations")
@Produces("application/json")
public List<LocationEntity> getLocations(@PathParam("pubId")
                                         String pubId,
                                         @QueryParam("lang")
                                         String language)

addAlias

@PUT
@Path("{pubId}/locations/{nodeId}-{aliasComponentId}")
@Produces("application/json")
public javax.ws.rs.core.Response addAlias(@PathParam("pubId")
                                          String pubId,
                                          @PathParam("nodeId")
                                          String nodeId,
                                          @PathParam("aliasComponentId")
                                          String aliasComponentId)

deleteAlias

@DELETE
@Path("{pubId}/locations/{nodeId}-{aliasComponentId}")
@Produces("application/json")
public javax.ws.rs.core.Response deleteAlias(@PathParam("pubId")
                                             String pubId,
                                             @PathParam("nodeId")
                                             String nodeId,
                                             @PathParam("aliasComponentId")
                                             String aliasComponentId)

isNodeReadable

protected boolean isNodeReadable(NodePK nodePK)

Specified by:

isNodeReadable in class AbstractPublicationResource

identifiedBy

protected URI identifiedBy(URI uri)