org.silverpeas.kmelia.web
Class FolderResource

java.lang.Object
  com.silverpeas.web.RESTWebService
      org.silverpeas.kmelia.web.FolderResource

@Service
@RequestScoped
@Authorized
public class FolderResource
extends com.silverpeas.web.RESTWebService

A REST Web resource representing a given node. It is a web service that provides an access to a node referenced by its URL.

Nested Class Summary

Nested classes/interfaces inherited from class com.silverpeas.web.RESTWebService

com.silverpeas.web.RESTWebService.WebProcess<RETURN_VALUE>, com.silverpeas.web.RESTWebService.WebTreatment<RETURN_VALUE>

Field Summary

Fields inherited from class com.silverpeas.web.RESTWebService

RESPONSE_HEADER_ARRAYSIZE, REST_WEB_SERVICES_URI_BASE

Constructor Summary

FolderResource()

Method Summary

javax.ws.rs.core.Response	createNode(String path, org.silverpeas.node.web.NodeEntity nodeEntity) Creates a node corresponding to the given node entity and whose parent matches the specified path.
org.silverpeas.node.web.NodeEntity[]	getChildren(String path, String language) Get all children of any node of the application.
String	getComponentId()
KmeliaBm	getKmeliaBm()
org.silverpeas.node.web.NodeEntity	getNode(String path, String language) Get any node of the application and its children.
org.silverpeas.node.web.NodeEntity[]	getPath(String path, String language) Get all children of any node of the application.
org.silverpeas.node.web.NodeEntity	getRoot(String language) Get the root of the application and its children.
org.silverpeas.node.web.NodeEntity	getTreeview(String path, String language) Get all children of any node of the application.

Methods inherited from class com.silverpeas.web.RESTWebService

getBundle, getBundleLocation, getGreaterUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getUriInfo, getUserDetail, getUserPreferences, getUserRoles, process, validateUserAuthentication, validateUserAuthorization

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderResource

public FolderResource()

Method Detail

getRoot

public org.silverpeas.node.web.NodeEntity getRoot(String language)

Get the root of the application and its children.

Returns:

the application root and its children

getNode

public org.silverpeas.node.web.NodeEntity getNode(String path,
                                                  String language)

Get any node of the application and its children.

Returns:

NodeEntity representing asking node

getPath

public org.silverpeas.node.web.NodeEntity[] getPath(String path,
                                                    String language)

Get all children of any node of the application.

Returns:

an array of NodeEntity representing children

getChildren

public org.silverpeas.node.web.NodeEntity[] getChildren(String path,
                                                        String language)

Get all children of any node of the application.

Returns:

an array of NodeEntity representing children

createNode

public javax.ws.rs.core.Response createNode(String path,
                                            org.silverpeas.node.web.NodeEntity nodeEntity)

Creates a node corresponding to the given node entity and whose parent matches the specified path.

Parameters:

path - The path of the parent node.

nodeEntity - The description of the node to create.

Returns:

a response containing the entity describing the newly created node.

getTreeview

public org.silverpeas.node.web.NodeEntity getTreeview(String path,
                                                      String language)

Get all children of any node of the application.

Returns:

an array of NodeEntity representing children

getComponentId

public String getComponentId()

Specified by:

getComponentId in class com.silverpeas.web.RESTWebService

getKmeliaBm

public KmeliaBm getKmeliaBm()