info.magnolia.rest.service.node.v1

Class NodeEndpoint<D extends NodeEndpointDefinition>

java.lang.Object

info.magnolia.rest.AbstractEndpoint<D>

info.magnolia.rest.service.node.v1.NodeEndpoint<D>

Type Parameters:

D - The endpoint definition

@Path(value="/nodes/v1")
public class NodeEndpoint<D extends NodeEndpointDefinition>
extends info.magnolia.rest.AbstractEndpoint<D>

Endpoint for accessing and manipulating nodes.

Constructor Summary

Constructors

Constructor and Description
NodeEndpoint(D endpointDefinition)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createNode(String workspaceName, String parentPath, RepositoryNode repositoryNode) Creates a new node and populates it with the supplied properties.
javax.ws.rs.core.Response	deleteNode(String workspaceName, String path) Delete a node.
javax.ws.rs.core.Response	readNode(String workspaceName, String path, int depth, String excludeNodeTypes, boolean includeMetadata) Returns a node including its properties and child nodes down to a certain depth.
protected List<String>	splitExcludeNodeTypesString(String excludes)
javax.ws.rs.core.Response	updateNode(String workspaceName, String path, RepositoryNode repositoryNode) Adds properties to a node.

Methods inherited from class info.magnolia.rest.AbstractEndpoint

getEndpointDefinition

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeEndpoint

@Inject
public NodeEndpoint(D endpointDefinition)

Method Detail

readNode

@GET
 @Path(value="/{workspace}{path:(/.+)?}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response readNode(@PathParam(value="workspace")
                                                                                                                                                  String workspaceName,
                                                                                                                                                  @PathParam(value="path") @DefaultValue(value="/")
                                                                                                                                                  String path,
                                                                                                                                                  @QueryParam(value="depth") @DefaultValue(value="0")
                                                                                                                                                  int depth,
                                                                                                                                                  @QueryParam(value="excludeNodeTypes") @DefaultValue(value="")
                                                                                                                                                  String excludeNodeTypes,
                                                                                                                                                  @QueryParam(value="includeMetadata") @DefaultValue(value="false")
                                                                                                                                                  boolean includeMetadata)
                                                                                                                                           throws javax.jcr.RepositoryException

Returns a node including its properties and child nodes down to a certain depth.

Throws:

javax.jcr.RepositoryException

createNode

@PUT
 @Path(value="/{workspace}{path:(/.+)?}")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response createNode(@PathParam(value="workspace")
                                                                                                                                                                                                             String workspaceName,
                                                                                                                                                                                                             @PathParam(value="path") @DefaultValue(value="/")
                                                                                                                                                                                                             String parentPath,
                                                                                                                                                                                                             RepositoryNode repositoryNode)
                                                                                                                                                                                                      throws javax.jcr.RepositoryException

Creates a new node and populates it with the supplied properties. Does not support adding sub nodes. The submitted node must contain name and type.

Throws:

javax.jcr.RepositoryException

updateNode

@POST
 @Path(value="/{workspace}{path:(/.+)?}")
 @Produces(value={"application/json","application/xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response updateNode(@PathParam(value="workspace")
                                                                                                                                                                                                              String workspaceName,
                                                                                                                                                                                                              @PathParam(value="path") @DefaultValue(value="/")
                                                                                                                                                                                                              String path,
                                                                                                                                                                                                              RepositoryNode repositoryNode)
                                                                                                                                                                                                       throws javax.jcr.RepositoryException

Adds properties to a node. Existing properties are changed if present in the request. Existing properties not present in the request are not removed.

Throws:

javax.jcr.RepositoryException

deleteNode

@DELETE
 @Path(value="/{workspace}{path:(/.+)?}")
public javax.ws.rs.core.Response deleteNode(@PathParam(value="workspace")
                                                                                              String workspaceName,
                                                                                              @PathParam(value="path") @DefaultValue(value="/")
                                                                                              String path)
                                                                                       throws javax.jcr.RepositoryException

Delete a node.

Throws:

javax.jcr.RepositoryException

splitExcludeNodeTypesString

protected List<String> splitExcludeNodeTypesString(String excludes)