info.magnolia.rest.service.property.v1

Class PropertyEndpoint<D extends PropertyEndpointDefinition>

java.lang.Object

info.magnolia.rest.AbstractEndpoint<D>

info.magnolia.rest.service.property.v1.PropertyEndpoint<D>

Type Parameters:

D - The endpoint definition

@Path(value="/properties/v1")
public class PropertyEndpoint<D extends PropertyEndpointDefinition>
extends info.magnolia.rest.AbstractEndpoint<D>

Endpoint for accessing and manipulating properties.

Constructor Summary

Constructors

Constructor and Description
PropertyEndpoint(D endpointDefinition)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createProperty(String workspaceName, String parentPath, String name, List<String> valueStrings, String typeString, boolean multiple) Adds a property to a node.
javax.ws.rs.core.Response	deleteProperty(String workspaceName, String path) Deletes a property.
javax.ws.rs.core.Response	readProperty(String workspaceName, String path) Returns the string representation of a property's value.
javax.ws.rs.core.Response	updateProperty(String workspaceName, String path, List<String> valueStrings, String typeString, boolean multiple) Sets the value of an existing property.

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

PropertyEndpoint

@Inject
public PropertyEndpoint(D endpointDefinition)

Method Detail

readProperty

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

Returns the string representation of a property's value.

Throws:

javax.jcr.RepositoryException

createProperty

@PUT
 @Path(value="/{workspace}{path:(/.+)?}")
public javax.ws.rs.core.Response createProperty(@PathParam(value="workspace")
                                                                                               String workspaceName,
                                                                                               @PathParam(value="path") @DefaultValue(value="/")
                                                                                               String parentPath,
                                                                                               @QueryParam(value="name")
                                                                                               String name,
                                                                                               @QueryParam(value="value")
                                                                                               List<String> valueStrings,
                                                                                               @QueryParam(value="type") @DefaultValue(value="String")
                                                                                               String typeString,
                                                                                               @QueryParam(value="multiple") @DefaultValue(value="false")
                                                                                               boolean multiple)
                                                                                        throws javax.jcr.RepositoryException

Adds a property to a node.

Throws:

javax.jcr.RepositoryException

updateProperty

@POST
 @Path(value="/{workspace}{path:(/.+)?}")
public javax.ws.rs.core.Response updateProperty(@PathParam(value="workspace")
                                                                                                String workspaceName,
                                                                                                @PathParam(value="path") @DefaultValue(value="/")
                                                                                                String path,
                                                                                                @QueryParam(value="value")
                                                                                                List<String> valueStrings,
                                                                                                @QueryParam(value="type") @DefaultValue(value="String")
                                                                                                String typeString,
                                                                                                @QueryParam(value="multiple") @DefaultValue(value="false")
                                                                                                boolean multiple)
                                                                                         throws javax.jcr.RepositoryException

Sets the value of an existing property.

Throws:

javax.jcr.RepositoryException

deleteProperty

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

Deletes a property.

Throws:

javax.jcr.RepositoryException