Index: web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/AbstractJcrResource.java new file mode 100644 =================================================================== --- /dev/null (revision 1671) +++ web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/AbstractJcrResource.java (working copy) @@ -0,0 +1,56 @@ +package org.modeshape.web.jcr.rest; + +import javax.jcr.RepositoryException; +import javax.jcr.Session; +import javax.servlet.http.HttpServletRequest; +import org.modeshape.common.text.UrlEncoder; + +public abstract class AbstractJcrResource { + + protected static final UrlEncoder URL_ENCODER = new UrlEncoder(); + + /** Name to be used when the repository name is empty string as {@code "//"} is not a valid path. */ + public static final String EMPTY_REPOSITORY_NAME = ""; + /** Name to be used when the workspace name is empty string as {@code "//"} is not a valid path. */ + public static final String EMPTY_WORKSPACE_NAME = ""; + + + /** + * Returns an active session for the given workspace name in the named repository. + * + * @param request the servlet request; may not be null or unauthenticated + * @param rawRepositoryName the URL-encoded name of the repository in which the session is created + * @param rawWorkspaceName the URL-encoded name of the workspace to which the session should be connected + * @return an active session with the given workspace in the named repository + * @throws RepositoryException if any other error occurs + */ + protected Session getSession( HttpServletRequest request, + String rawRepositoryName, + String rawWorkspaceName ) throws RepositoryException { + assert request != null; + + return RepositoryFactory.getSession(request, repositoryNameFor(rawRepositoryName), workspaceNameFor(rawWorkspaceName)); + } + + private String workspaceNameFor( String rawWorkspaceName ) { + String workspaceName = URL_ENCODER.decode(rawWorkspaceName); + + if (EMPTY_WORKSPACE_NAME.equals(workspaceName)) { + workspaceName = ""; + } + + return workspaceName; + } + + private String repositoryNameFor( String rawRepositoryName ) { + String repositoryName = URL_ENCODER.decode(rawRepositoryName); + + if (EMPTY_REPOSITORY_NAME.equals(repositoryName)) { + repositoryName = ""; + } + + return repositoryName; + } + + +} Index: web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/ItemsResource.java new file mode 100644 =================================================================== --- /dev/null (revision 1671) +++ web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/ItemsResource.java (working copy) @@ -0,0 +1,652 @@ +package org.modeshape.web.jcr.rest; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Set; +import javax.jcr.Item; +import javax.jcr.Node; +import javax.jcr.NodeIterator; +import javax.jcr.PathNotFoundException; +import javax.jcr.Property; +import javax.jcr.PropertyIterator; +import javax.jcr.PropertyType; +import javax.jcr.RepositoryException; +import javax.jcr.Session; +import javax.jcr.Value; +import javax.jcr.ValueFactory; +import javax.jcr.nodetype.NodeType; +import javax.jcr.nodetype.PropertyDefinition; +import javax.servlet.http.HttpServletRequest; +import javax.ws.rs.Consumes; +import javax.ws.rs.DELETE; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.POST; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.Response; +import javax.ws.rs.core.Response.Status; +import net.jcip.annotations.Immutable; +import org.codehaus.jettison.json.JSONArray; +import org.codehaus.jettison.json.JSONException; +import org.codehaus.jettison.json.JSONObject; +import org.jboss.resteasy.spi.NotFoundException; +import org.jboss.resteasy.spi.UnauthorizedException; +import org.modeshape.common.util.Base64; + +/** + * RESTEasy handler to provide the JCR resources at the URIs below. Please note that these URIs assume a context of {@code + * /resources} for the web application. + * + * + * + * + * + * + * + * + * + * + * + * + *
URI PatternDescriptionSupported Methods
/resources/{repositoryName}/{workspaceName}/item/{path}accesses the item (node or property) at the pathALL
+ *

Binary data

+ *

+ * There are several ways to transfer binary property values, but all involve encoding the binary value into ASCII characters + * using a {@link Base64} notation and denoting this by adding annotating the property name with a suffix defining the type of + * encoding. Currently, only "base64" encoding is supported. + *

+ *

+ * For example, if the "jcr:data" property contains a single binary value of "propertyValue", then the JSON object representing + * that property will be: + * + * 

+ *   "jcr:data/base64/" : "cHJvcGVydHlWYWx1ZQ=="
+ *
+ * + * Likewise, if the "jcr:data" property contains two binary values each being "propertyValue", then the JSON object representing + * that property will be: + * + * 
+ *   "jcr:data/base64/" : [ "cHJvcGVydHlWYWx1ZQ==", "cHJvcGVydHlWYWx1ZQ==" ]
+ *
+ * + * Note that JCR 1.0.1 does not allow property names to and with a '/' character (among others), while JCR 2.0 does not allow + * property names to contain an unescaped or unencoded '/' character. Therefore, the "/{encoding}/" suffix can never appear in a + * valid JCR property name, and will always identify an encoded property. + *

+ *

+ * Here are the details: + *

+ *

+ */ + +@Immutable +@Path("/") +public class ItemsResource extends AbstractJcrResource { + + + private static final String BASE64_ENCODING_SUFFIX = "/base64/"; + + private static final String PROPERTIES_HOLDER = "properties"; + private static final String CHILD_NODE_HOLDER = "children"; + + private static final String PRIMARY_TYPE_PROPERTY = "jcr:primaryType"; + private static final String MIXIN_TYPES_PROPERTY = "jcr:mixinTypes"; + + /** + * Handles GET requests for an item in a workspace. + * + * @param request the servlet request; may not be null or unauthenticated + * @param rawRepositoryName the URL-encoded repository name + * @param rawWorkspaceName the URL-encoded workspace name + * @param path the path to the item + * @param depth the depth of the node graph that should be returned if {@code path} refers to a node. @{code 0} means return + * the requested node only. A negative value indicates that the full subgraph under the node should be returned. This + * parameter defaults to {@code 0} and is ignored if {@code path} refers to a property. + * @return the JSON-encoded version of the item (and, if the item is a node, its subgraph, depending on the value of {@code + * depth}) + * @throws NotFoundException if the named repository does not exists, the named workspace does not exist, or the user does not + * have access to the named workspace + * @throws JSONException if there is an error encoding the node + * @throws UnauthorizedException if the given login information is invalid + * @throws RepositoryException if any other error occurs + * @see #EMPTY_REPOSITORY_NAME + * @see #EMPTY_WORKSPACE_NAME + * @see Session#getItem(String) + */ + @GET + @Path( "/{repositoryName}/{workspaceName}/items{path:.*}" ) + @Produces( "application/json" ) + public String getItem( @Context HttpServletRequest request, + @PathParam( "repositoryName" ) String rawRepositoryName, + @PathParam( "workspaceName" ) String rawWorkspaceName, + @PathParam( "path" ) String path, + @QueryParam( "mode:depth" ) @DefaultValue( "0" ) int depth ) + throws JSONException, UnauthorizedException, RepositoryException { + assert path != null; + assert rawRepositoryName != null; + assert rawWorkspaceName != null; + + Session session = getSession(request, rawRepositoryName, rawWorkspaceName); + Item item; + + if ("/".equals(path) || "".equals(path)) { + item = session.getRootNode(); + } else { + try { + item = session.getItem(path); + } catch (PathNotFoundException pnfe) { + throw new NotFoundException(pnfe.getMessage(), pnfe); + } + } + + if (item instanceof Node) { + return jsonFor((Node)item, depth).toString(); + } + return jsonFor((Property)item).toString(); + } + + /** + * Returns the JSON-encoded version of the given property. If the property is single-valued, the returned string is the value + * of the property encoded as a JSON string, including the name. If the property is multi-valued with {@code N} values, this + * method returns a JSON array containing the JSON string for each value. + *

+ * Note that if any of the values are binary, then all values will be first encoded as {@link Base64} string values. + * However, if no values are binary, then all values will simply be the {@link Value#getString() string} representation of the + * value. + *

+ * + * @param property the property to be encoded + * @return the JSON-encoded version of the property + * @throws JSONException if there is an error encoding the node + * @throws RepositoryException if an error occurs accessing the property, its values, or its definition. + * @see Property#getDefinition() + * @see PropertyDefinition#isMultiple() + */ + private JSONObject jsonFor( Property property ) throws JSONException, RepositoryException { + boolean encoded = false; + Object valueObject = null; + if (property.getDefinition().isMultiple()) { + Value[] values = property.getValues(); + for (Value value : values) { + if (value.getType() == PropertyType.BINARY) { + encoded = true; + break; + } + } + List list = new ArrayList(values.length); + if (encoded) { + for (Value value : values) { + list.add(jsonEncodedStringFor(value)); + } + } else { + for (Value value : values) { + list.add(value.getString()); + } + } + valueObject = new JSONArray(list); + } else { + Value value = property.getValue(); + encoded = value.getType() == PropertyType.BINARY; + valueObject = encoded ? jsonEncodedStringFor(value) : value.getString(); + } + String propertyName = property.getName(); + if (encoded) propertyName = propertyName + BASE64_ENCODING_SUFFIX; + JSONObject jsonProperty = new JSONObject(); + jsonProperty.put(propertyName, valueObject); + return jsonProperty; + } + + /** + * Return the JSON-compatible string representation of the given property value. If the value is a {@link PropertyType#BINARY + * binary} value, then this method returns the Base-64 encoding of that value. Otherwise, it just returns the string + * representation of the value. + * + * @param value the property value; may not be null + * @return the string representation of the value + * @throws RepositoryException if there is a problem accessing the value + */ + private String jsonEncodedStringFor( Value value ) throws RepositoryException { + // Encode the binary value in Base64 ... + InputStream stream = value.getStream(); + try { + return Base64.encode(stream); + } finally { + if (stream != null) { + try { + stream.close(); + } catch (IOException e) { + // Error accessing the value, so throw this ... + throw new RepositoryException(e); + } + } + } + } + + /** + * Recursively returns the JSON-encoding of a node and its children to depth {@code toDepth}. + * + * @param node the node to be encoded + * @param toDepth the depth to which the recursion should extend; {@code 0} means no further recursion should occur. + * @return the JSON-encoding of a node and its children to depth {@code toDepth}. + * @throws JSONException if there is an error encoding the node + * @throws RepositoryException if any other error occurs + */ + private JSONObject jsonFor( Node node, + int toDepth ) throws JSONException, RepositoryException { + JSONObject jsonNode = new JSONObject(); + + JSONObject properties = new JSONObject(); + + for (PropertyIterator iter = node.getProperties(); iter.hasNext();) { + Property prop = iter.nextProperty(); + String propName = prop.getName(); + + boolean encoded = false; + + if (prop.getDefinition().isMultiple()) { + Value[] values = prop.getValues(); + // Do any of the property values need to be encoded ? + for (Value value : values) { + if (value.getType() == PropertyType.BINARY) { + encoded = true; + break; + } + } + if (encoded) propName = propName + BASE64_ENCODING_SUFFIX; + JSONArray array = new JSONArray(); + for (int i = 0; i < values.length; i++) { + array.put(encoded ? jsonEncodedStringFor(values[i]) : values[i].getString()); + } + properties.put(propName, array); + + } else { + Value value = prop.getValue(); + encoded = value.getType() == PropertyType.BINARY; + if (encoded) propName = propName + BASE64_ENCODING_SUFFIX; + properties.put(propName, encoded ? jsonEncodedStringFor(value) : value.getString()); + } + + } + if (properties.length() > 0) { + jsonNode.put(PROPERTIES_HOLDER, properties); + } + + if (toDepth == 0) { + List children = new ArrayList(); + + for (NodeIterator iter = node.getNodes(); iter.hasNext();) { + Node child = iter.nextNode(); + + children.add(child.getName()); + } + + if (children.size() > 0) { + jsonNode.put(CHILD_NODE_HOLDER, new JSONArray(children)); + } + } else { + JSONObject children = new JSONObject(); + + for (NodeIterator iter = node.getNodes(); iter.hasNext();) { + Node child = iter.nextNode(); + + children.put(child.getName(), jsonFor(child, toDepth - 1)); + } + + if (children.length() > 0) { + jsonNode.put(CHILD_NODE_HOLDER, children); + } + } + + return jsonNode; + } + + /** + * Adds the content of the request as a node (or subtree of nodes) at the location specified by {@code path}. + *

+ * The primary type and mixin type(s) may optionally be specified through the {@code jcr:primaryType} and {@code + * jcr:mixinTypes} properties. + *

+ * + * @param request the servlet request; may not be null or unauthenticated + * @param rawRepositoryName the URL-encoded repository name + * @param rawWorkspaceName the URL-encoded workspace name + * @param path the path to the item + * @param requestContent the JSON-encoded representation of the node or nodes to be added + * @return the JSON-encoded representation of the node or nodes that were added. This will differ from {@code requestContent} + * in that auto-created and protected properties (e.g., jcr:uuid) will be populated. + * @throws NotFoundException if the parent of the item to be added does not exist + * @throws UnauthorizedException if the user does not have the access required to create the node at this path + * @throws JSONException if there is an error encoding the node + * @throws RepositoryException if any other error occurs + */ + @POST + @Path( "/{repositoryName}/{workspaceName}/items/{path:.*}" ) + @Consumes( "application/json" ) + public Response postItem( @Context HttpServletRequest request, + @PathParam( "repositoryName" ) String rawRepositoryName, + @PathParam( "workspaceName" ) String rawWorkspaceName, + @PathParam( "path" ) String path, + String requestContent ) + throws NotFoundException, UnauthorizedException, RepositoryException, JSONException { + + assert rawRepositoryName != null; + assert rawWorkspaceName != null; + assert path != null; + JSONObject body = new JSONObject(requestContent); + + int lastSlashInd = path.lastIndexOf('/'); + String parentPath = lastSlashInd == -1 ? "/" : "/" + path.substring(0, lastSlashInd); + String newNodeName = lastSlashInd == -1 ? path : path.substring(lastSlashInd + 1); + + Session session = getSession(request, rawRepositoryName, rawWorkspaceName); + + Node parentNode = (Node)session.getItem(parentPath); + + Node newNode = addNode(parentNode, newNodeName, body); + + session.save(); + + String json = jsonFor(newNode, -1).toString(); + return Response.status(Status.CREATED).entity(json).build(); + } + + /** + * Adds the node described by {@code jsonNode} with name {@code nodeName} to the existing node {@code parentNode}. + * + * @param parentNode the parent of the node to be added + * @param nodeName the name of the node to be added + * @param jsonNode the JSON-encoded representation of the node or nodes to be added. + * @return the JSON-encoded representation of the node or nodes that were added. This will differ from {@code requestContent} + * in that auto-created and protected properties (e.g., jcr:uuid) will be populated. + * @throws JSONException if there is an error encoding the node + * @throws RepositoryException if any other error occurs + */ + private Node addNode( Node parentNode, + String nodeName, + JSONObject jsonNode ) throws RepositoryException, JSONException { + Node newNode; + + JSONObject properties = jsonNode.has(PROPERTIES_HOLDER) ? jsonNode.getJSONObject(PROPERTIES_HOLDER) : new JSONObject(); + + if (properties.has(PRIMARY_TYPE_PROPERTY)) { + String primaryType = properties.getString(PRIMARY_TYPE_PROPERTY); + newNode = parentNode.addNode(nodeName, primaryType); + } else { + newNode = parentNode.addNode(nodeName); + } + + if (properties.has(MIXIN_TYPES_PROPERTY)) { + Object rawMixinTypes = properties.get(MIXIN_TYPES_PROPERTY); + + if (rawMixinTypes instanceof JSONArray) { + JSONArray mixinTypes = (JSONArray)rawMixinTypes; + for (int i = 0; i < mixinTypes.length(); i++) { + newNode.addMixin(mixinTypes.getString(i)); + } + + } else { + newNode.addMixin(rawMixinTypes.toString()); + + } + } + + for (Iterator iter = properties.keys(); iter.hasNext();) { + String key = (String)iter.next(); + + if (PRIMARY_TYPE_PROPERTY.equals(key)) continue; + if (MIXIN_TYPES_PROPERTY.equals(key)) continue; + setPropertyOnNode(newNode, key, properties.get(key)); + } + + if (jsonNode.has(CHILD_NODE_HOLDER)) { + JSONObject children = jsonNode.getJSONObject(CHILD_NODE_HOLDER); + + for (Iterator iter = children.keys(); iter.hasNext();) { + String childName = (String)iter.next(); + JSONObject child = children.getJSONObject(childName); + + addNode(newNode, childName, child); + } + } + + return newNode; + } + + private Value decodeValue( String encodedValue, + ValueFactory valueFactory ) throws RepositoryException { + byte[] binaryValue = Base64.decode(encodedValue); + InputStream stream = new ByteArrayInputStream(binaryValue); + try { + return valueFactory.createValue(stream); + } finally { + try { + stream.close(); + } catch (IOException e) { + // Error accessing the value, so throw this ... + throw new RepositoryException(e); + } + } + } + + /** + * Sets the named property on the given node. This method expects {@code value} to be either a JSON string or a JSON array of + * JSON strings. If {@code value} is a JSON array, {@code Node#setProperty(String, String[]) the multi-valued property setter} + * will be used. + * + * @param node the node on which the property is to be set + * @param propName the name of the property to set + * @param value the JSON-encoded values to be set + * @throws RepositoryException if there is an error setting the property + * @throws JSONException if {@code value} cannot be decoded + */ + private void setPropertyOnNode( Node node, + String propName, + Object value ) throws RepositoryException, JSONException { + // Are the property values encoded ? + boolean encoded = propName.endsWith(BASE64_ENCODING_SUFFIX); + if (encoded) { + int newLength = propName.length() - BASE64_ENCODING_SUFFIX.length(); + propName = newLength > 0 ? propName.substring(0, newLength) : ""; + } + + Value[] values; + ValueFactory valueFactory = node.getSession().getValueFactory(); + if (value instanceof JSONArray) { + JSONArray jsonValues = (JSONArray)value; + values = new Value[jsonValues.length()]; + + for (int i = 0; i < values.length; i++) { + String strValue = jsonValues.getString(i); + if (encoded) { + values[i] = decodeValue(strValue, valueFactory); + } else { + values[i] = valueFactory.createValue(strValue); + } + } + } else { + String strValue = (String)value; + if (encoded) { + values = new Value[] {decodeValue(strValue, valueFactory)}; + } else { + values = new Value[] {valueFactory.createValue(strValue)}; + } + } + + if (propName.equals(ItemsResource.MIXIN_TYPES_PROPERTY)) { + Set toBeMixins = new HashSet(); + for (Value theValue : values) { + toBeMixins.add(theValue.getString()); + } + Set asIsMixins = new HashSet(); + + for (NodeType nodeType : node.getMixinNodeTypes()) { + asIsMixins.add(nodeType.getName()); + } + + Set mixinsToAdd = new HashSet(toBeMixins); + mixinsToAdd.removeAll(asIsMixins); + asIsMixins.removeAll(toBeMixins); + + for (String nodeType : mixinsToAdd) { + node.addMixin(nodeType); + } + + for (String nodeType : asIsMixins) { + node.removeMixin(nodeType); + } + } else { + if (values.length == 1) { + node.setProperty(propName, values[0]); + + } else { + node.setProperty(propName, values); + } + } + } + + /** + * Deletes the item at {@code path}. + * + * @param request the servlet request; may not be null or unauthenticated + * @param rawRepositoryName the URL-encoded repository name + * @param rawWorkspaceName the URL-encoded workspace name + * @param path the path to the item + * @throws NotFoundException if no item exists at {@code path} + * @throws UnauthorizedException if the user does not have the access required to delete the item at this path + * @throws RepositoryException if any other error occurs + */ + @DELETE + @Path( "/{repositoryName}/{workspaceName}/items{path:.*}" ) + @Consumes( "application/json" ) + public void deleteItem( @Context HttpServletRequest request, + @PathParam( "repositoryName" ) String rawRepositoryName, + @PathParam( "workspaceName" ) String rawWorkspaceName, + @PathParam( "path" ) String path ) + throws NotFoundException, UnauthorizedException, RepositoryException { + + assert rawRepositoryName != null; + assert rawWorkspaceName != null; + assert path != null; + + Session session = getSession(request, rawRepositoryName, rawWorkspaceName); + + Item item; + try { + item = session.getItem(path); + } catch (PathNotFoundException pnfe) { + throw new NotFoundException(pnfe.getMessage(), pnfe); + } + item.remove(); + session.save(); + } + + /** + * Updates the properties at the path. + *

+ * If path points to a property, this method expects the request content to be either a JSON array or a JSON string. The array + * or string will become the values or value of the property. If path points to a node, this method expects the request + * content to be a JSON object. The keys of the objects correspond to property names that will be set and the values for the + * keys correspond to the values that will be set on the properties. + *

+ * + * @param request the servlet request; may not be null or unauthenticated + * @param rawRepositoryName the URL-encoded repository name + * @param rawWorkspaceName the URL-encoded workspace name + * @param path the path to the item + * @param requestContent the JSON-encoded representation of the values and, possibly, properties to be set + * @return the JSON-encoded representation of the node on which the property or properties were set. + * @throws NotFoundException if the parent of the item to be added does not exist + * @throws UnauthorizedException if the user does not have the access required to create the node at this path + * @throws JSONException if there is an error encoding the node + * @throws RepositoryException if any other error occurs + * @throws IOException if there is a problem reading the value + */ + @PUT + @Path( "/{repositoryName}/{workspaceName}/items{path:.*}" ) + @Consumes( "application/json" ) + public String putItem( @Context HttpServletRequest request, + @PathParam( "repositoryName" ) String rawRepositoryName, + @PathParam( "workspaceName" ) String rawWorkspaceName, + @PathParam( "path" ) String path, + String requestContent ) throws UnauthorizedException, JSONException, RepositoryException, IOException { + + assert path != null; + assert rawRepositoryName != null; + assert rawWorkspaceName != null; + + Session session = getSession(request, rawRepositoryName, rawWorkspaceName); + Node node; + Item item; + if ("".equals(path) || "/".equals(path)) { + item = session.getRootNode(); + } else { + try { + item = session.getItem(path); + } catch (PathNotFoundException pnfe) { + throw new NotFoundException(pnfe.getMessage(), pnfe); + } + } + + if (item instanceof Node) { + JSONObject properties = new JSONObject(requestContent); + node = (Node)item; + + for (Iterator iter = properties.keys(); iter.hasNext();) { + String key = (String)iter.next(); + + setPropertyOnNode(node, key, properties.get(key)); + } + + } else { + /* + * The incoming content should be a JSON object containing the property name and a value that is either a JSON + * string or a JSON array. + */ + Property property = (Property)item; + String propertyName = property.getName(); + JSONObject jsonProperty = new JSONObject(requestContent); + String jsonPropertyName = jsonProperty.has(propertyName) ? propertyName : propertyName + BASE64_ENCODING_SUFFIX; + node = property.getParent(); + setPropertyOnNode(node, jsonPropertyName, jsonProperty.get(jsonPropertyName)); + } + node.save(); + return jsonFor(node, 0).toString(); + } + +} Index: web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/JcrApplication.java =================================================================== --- web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/JcrApplication.java (revision 1671) +++ web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/JcrApplication.java (working copy) @@ -43,6 +43,9 @@ public class JcrApplication extends Application { @Override public Set> getClasses() { return new HashSet>(Arrays.asList(new Class[] { + ServerResource.class, + RepositoryResource.class, + ItemsResource.class, JcrResources.class, JcrResources.JSONExceptionMapper.class, JcrResources.NotFoundExceptionMapper.class, Index: web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/JcrResources.java =================================================================== --- web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/JcrResources.java (revision 1671) +++ web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/JcrResources.java (working copy) @@ -23,773 +23,22 @@ */ package org.modeshape.web.jcr.rest; -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.HashSet; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.Set; -import javax.jcr.Item; -import javax.jcr.Node; -import javax.jcr.NodeIterator; -import javax.jcr.PathNotFoundException; -import javax.jcr.Property; -import javax.jcr.PropertyIterator; -import javax.jcr.PropertyType; import javax.jcr.RepositoryException; -import javax.jcr.Session; -import javax.jcr.Value; -import javax.jcr.ValueFactory; -import javax.jcr.nodetype.NodeType; -import javax.jcr.nodetype.PropertyDefinition; -import javax.servlet.http.HttpServletRequest; -import javax.ws.rs.Consumes; -import javax.ws.rs.DELETE; -import javax.ws.rs.DefaultValue; -import javax.ws.rs.GET; -import javax.ws.rs.POST; -import javax.ws.rs.PUT; import javax.ws.rs.Path; -import javax.ws.rs.PathParam; -import javax.ws.rs.Produces; -import javax.ws.rs.QueryParam; -import javax.ws.rs.core.Context; import javax.ws.rs.core.Response; import javax.ws.rs.core.Response.Status; import javax.ws.rs.ext.ExceptionMapper; import javax.ws.rs.ext.Provider; import net.jcip.annotations.Immutable; -import org.codehaus.jettison.json.JSONArray; import org.codehaus.jettison.json.JSONException; -import org.codehaus.jettison.json.JSONObject; import org.jboss.resteasy.spi.NotFoundException; -import org.jboss.resteasy.spi.UnauthorizedException; -import org.modeshape.common.text.UrlEncoder; -import org.modeshape.common.util.Base64; -import org.modeshape.web.jcr.rest.model.RepositoryEntry; -import org.modeshape.web.jcr.rest.model.WorkspaceEntry; /** - * RESTEasy handler to provide the JCR resources at the URIs below. Please note that these URIs assume a context of {@code - * /resources} for the web application. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
URI PatternDescriptionSupported Methods
/resourcesreturns a list of accessible repositoriesGET
/resources/{repositoryName}returns a list of accessible workspaces within that repositoryGET
/resources/{repositoryName}/{workspaceName}returns a list of operations within the workspaceGET
/resources/{repositoryName}/{workspaceName}/item/{path}accesses the item (node or property) at the pathALL
- *

Binary data

- *

- * There are several ways to transfer binary property values, but all involve encoding the binary value into ASCII characters - * using a {@link Base64} notation and denoting this by adding annotating the property name with a suffix defining the type of - * encoding. Currently, only "base64" encoding is supported. - *

- *

- * For example, if the "jcr:data" property contains a single binary value of "propertyValue", then the JSON object representing - * that property will be: - * - * 

- *   "jcr:data/base64/" : "cHJvcGVydHlWYWx1ZQ=="
- *
- * - * Likewise, if the "jcr:data" property contains two binary values each being "propertyValue", then the JSON object representing - * that property will be: - * - * 
- *   "jcr:data/base64/" : [ "cHJvcGVydHlWYWx1ZQ==", "cHJvcGVydHlWYWx1ZQ==" ]
- *
- * - * Note that JCR 1.0.1 does not allow property names to and with a '/' character (among others), while JCR 2.0 does not allow - * property names to contain an unescaped or unencoded '/' character. Therefore, the "/{encoding}/" suffix can never appear in a - * valid JCR property name, and will always identify an encoded property. - *

- *

- * Here are the details: - *

    - *
  • Getting a node with GET /resources/{repositoryName}/item/{pathToNode} obtains the JSON object representing the - * node, and each property is represented as a nested JSON object where the name is the property name and the value(s) are - * represented as either a single string value or an array of string values. If the property has a binary value, then the property - * name is appended with "/base64/" and the string representation of each value is encoded in Base64.
    • - *
  • Getting a property with GET /resources/{repositoryName}/item/{pathToProperty} allows only the value(s) for the - * one property to be included in the response. If any of the values is a binary value, then all of the values will be - * encoded in Base64.
    • - *
  • Setting a property with PUT /resources/{repositoryName}/item/{pathToProperty} allows setting the property to a - * single value, and only that value needs to be included in the body of the request. If the value is binary, the value - * must be {@link Base64 encoded} by the client and the "Content-Transfer-Encoding" header must be set to "base64" (case - * does not matter). When the request is received, the value is decoded before the property value is updated on the node.
    • - *
  • Creating a node with POST /resources/{repositoryName}/item/{pathToNode} requires a request that is structured - * in the same way as the response from getting a node: the resulting JSON object represents the node, with nested JSON objects - * for the properties and children. If any property of the new node has a binary value, then the name of the property must - * be appended with "/base64/" and the string representation of each value are to be encoded in Base64.
    • - *
  • Updating a node with PUT /resources/{repositoryName}/item/{pathToNode} requires a request that is structured - * in the same way as the response from getting or posting a node: the resulting JSON object represents the node, with nested JSON - * objects for the properties and children. If any property of the new node has a binary value, then the name of the property - * must be appended with "/base64/" and the string representation of each value are to be encoded in Base64.
    • - *
- *

+ * RESTEasy exception handlers for the Modeshape REST server. */ @Immutable @Path( "/" ) -public class JcrResources { - - private static final String BASE64_ENCODING_SUFFIX = "/base64/"; - - private static final UrlEncoder URL_ENCODER = new UrlEncoder(); - - private static final String PROPERTIES_HOLDER = "properties"; - private static final String CHILD_NODE_HOLDER = "children"; - - private static final String PRIMARY_TYPE_PROPERTY = "jcr:primaryType"; - private static final String MIXIN_TYPES_PROPERTY = "jcr:mixinTypes"; - - /** Name to be used when the repository name is empty string as {@code "//"} is not a valid path. */ - public static final String EMPTY_REPOSITORY_NAME = ""; - /** Name to be used when the workspace name is empty string as {@code "//"} is not a valid path. */ - public static final String EMPTY_WORKSPACE_NAME = ""; - - /** - * Returns an active session for the given workspace name in the named repository. - * - * @param request the servlet request; may not be null or unauthenticated - * @param rawRepositoryName the URL-encoded name of the repository in which the session is created - * @param rawWorkspaceName the URL-encoded name of the workspace to which the session should be connected - * @return an active session with the given workspace in the named repository - * @throws RepositoryException if any other error occurs - */ - private Session getSession( HttpServletRequest request, - String rawRepositoryName, - String rawWorkspaceName ) throws RepositoryException { - assert request != null; - - return RepositoryFactory.getSession(request, repositoryNameFor(rawRepositoryName), workspaceNameFor(rawWorkspaceName)); - } - - /** - * Returns the list of JCR repositories available on this server - * - * @param request the servlet request; may not be null - * @return the list of JCR repositories available on this server - */ - @GET - @Path( "/" ) - @Produces( "application/json" ) - public Map getRepositories( @Context HttpServletRequest request ) { - assert request != null; - - Map repositories = new HashMap(); - - for (String name : RepositoryFactory.getJcrRepositoryNames()) { - if (name.trim().length() == 0) { - name = EMPTY_REPOSITORY_NAME; - } - name = URL_ENCODER.encode(name); - repositories.put(name, new RepositoryEntry(request.getContextPath(), name)); - } - - return repositories; - } - - /** - * Returns the list of workspaces available to this user within the named repository. - * - * @param rawRepositoryName the name of the repository; may not be null - * @param request the servlet request; may not be null - * @return the list of workspaces available to this user within the named repository. - * @throws IOException if the given repository name does not map to any repositories and there is an error writing the error - * code to the response. - * @throws RepositoryException if there is any other error accessing the list of available workspaces for the repository - */ - @GET - @Path( "/{repositoryName}" ) - @Produces( "application/json" ) - public Map getWorkspaces( @Context HttpServletRequest request, - @PathParam( "repositoryName" ) String rawRepositoryName ) - throws RepositoryException, IOException { - - assert request != null; - assert rawRepositoryName != null; - - Map workspaces = new HashMap(); - - Session session = getSession(request, rawRepositoryName, null); - rawRepositoryName = URL_ENCODER.encode(rawRepositoryName); - - for (String name : session.getWorkspace().getAccessibleWorkspaceNames()) { - if (name.trim().length() == 0) { - name = EMPTY_WORKSPACE_NAME; - } - name = URL_ENCODER.encode(name); - workspaces.put(name, new WorkspaceEntry(request.getContextPath(), rawRepositoryName, name)); - } - - return workspaces; - } - - /** - * Handles GET requests for an item in a workspace. - * - * @param request the servlet request; may not be null or unauthenticated - * @param rawRepositoryName the URL-encoded repository name - * @param rawWorkspaceName the URL-encoded workspace name - * @param path the path to the item - * @param depth the depth of the node graph that should be returned if {@code path} refers to a node. @{code 0} means return - * the requested node only. A negative value indicates that the full subgraph under the node should be returned. This - * parameter defaults to {@code 0} and is ignored if {@code path} refers to a property. - * @return the JSON-encoded version of the item (and, if the item is a node, its subgraph, depending on the value of {@code - * depth}) - * @throws NotFoundException if the named repository does not exists, the named workspace does not exist, or the user does not - * have access to the named workspace - * @throws JSONException if there is an error encoding the node - * @throws UnauthorizedException if the given login information is invalid - * @throws RepositoryException if any other error occurs - * @see #EMPTY_REPOSITORY_NAME - * @see #EMPTY_WORKSPACE_NAME - * @see Session#getItem(String) - */ - @GET - @Path( "/{repositoryName}/{workspaceName}/items{path:.*}" ) - @Produces( "application/json" ) - public String getItem( @Context HttpServletRequest request, - @PathParam( "repositoryName" ) String rawRepositoryName, - @PathParam( "workspaceName" ) String rawWorkspaceName, - @PathParam( "path" ) String path, - @QueryParam( "mode:depth" ) @DefaultValue( "0" ) int depth ) - throws JSONException, UnauthorizedException, RepositoryException { - assert path != null; - assert rawRepositoryName != null; - assert rawWorkspaceName != null; - - Session session = getSession(request, rawRepositoryName, rawWorkspaceName); - Item item; - - if ("/".equals(path) || "".equals(path)) { - item = session.getRootNode(); - } else { - try { - item = session.getItem(path); - } catch (PathNotFoundException pnfe) { - throw new NotFoundException(pnfe.getMessage(), pnfe); - } - } - - if (item instanceof Node) { - return jsonFor((Node)item, depth).toString(); - } - return jsonFor((Property)item).toString(); - } - - /** - * Returns the JSON-encoded version of the given property. If the property is single-valued, the returned string is the value - * of the property encoded as a JSON string, including the name. If the property is multi-valued with {@code N} values, this - * method returns a JSON array containing the JSON string for each value. - *

- * Note that if any of the values are binary, then all values will be first encoded as {@link Base64} string values. - * However, if no values are binary, then all values will simply be the {@link Value#getString() string} representation of the - * value. - *

- * - * @param property the property to be encoded - * @return the JSON-encoded version of the property - * @throws JSONException if there is an error encoding the node - * @throws RepositoryException if an error occurs accessing the property, its values, or its definition. - * @see Property#getDefinition() - * @see PropertyDefinition#isMultiple() - */ - private JSONObject jsonFor( Property property ) throws JSONException, RepositoryException { - boolean encoded = false; - Object valueObject = null; - if (property.getDefinition().isMultiple()) { - Value[] values = property.getValues(); - for (Value value : values) { - if (value.getType() == PropertyType.BINARY) { - encoded = true; - break; - } - } - List list = new ArrayList(values.length); - if (encoded) { - for (Value value : values) { - list.add(jsonEncodedStringFor(value)); - } - } else { - for (Value value : values) { - list.add(value.getString()); - } - } - valueObject = new JSONArray(list); - } else { - Value value = property.getValue(); - encoded = value.getType() == PropertyType.BINARY; - valueObject = encoded ? jsonEncodedStringFor(value) : value.getString(); - } - String propertyName = property.getName(); - if (encoded) propertyName = propertyName + BASE64_ENCODING_SUFFIX; - JSONObject jsonProperty = new JSONObject(); - jsonProperty.put(propertyName, valueObject); - return jsonProperty; - } - - /** - * Return the JSON-compatible string representation of the given property value. If the value is a {@link PropertyType#BINARY - * binary} value, then this method returns the Base-64 encoding of that value. Otherwise, it just returns the string - * representation of the value. - * - * @param value the property value; may not be null - * @return the string representation of the value - * @throws RepositoryException if there is a problem accessing the value - */ - private String jsonEncodedStringFor( Value value ) throws RepositoryException { - // Encode the binary value in Base64 ... - InputStream stream = value.getStream(); - try { - return Base64.encode(stream); - } finally { - if (stream != null) { - try { - stream.close(); - } catch (IOException e) { - // Error accessing the value, so throw this ... - throw new RepositoryException(e); - } - } - } - } - - /** - * Recursively returns the JSON-encoding of a node and its children to depth {@code toDepth}. - * - * @param node the node to be encoded - * @param toDepth the depth to which the recursion should extend; {@code 0} means no further recursion should occur. - * @return the JSON-encoding of a node and its children to depth {@code toDepth}. - * @throws JSONException if there is an error encoding the node - * @throws RepositoryException if any other error occurs - */ - private JSONObject jsonFor( Node node, - int toDepth ) throws JSONException, RepositoryException { - JSONObject jsonNode = new JSONObject(); - - JSONObject properties = new JSONObject(); - - for (PropertyIterator iter = node.getProperties(); iter.hasNext();) { - Property prop = iter.nextProperty(); - String propName = prop.getName(); - - boolean encoded = false; - - if (prop.getDefinition().isMultiple()) { - Value[] values = prop.getValues(); - // Do any of the property values need to be encoded ? - for (Value value : values) { - if (value.getType() == PropertyType.BINARY) { - encoded = true; - break; - } - } - if (encoded) propName = propName + BASE64_ENCODING_SUFFIX; - JSONArray array = new JSONArray(); - for (int i = 0; i < values.length; i++) { - array.put(encoded ? jsonEncodedStringFor(values[i]) : values[i].getString()); - } - properties.put(propName, array); - - } else { - Value value = prop.getValue(); - encoded = value.getType() == PropertyType.BINARY; - if (encoded) propName = propName + BASE64_ENCODING_SUFFIX; - properties.put(propName, encoded ? jsonEncodedStringFor(value) : value.getString()); - } - - } - if (properties.length() > 0) { - jsonNode.put(PROPERTIES_HOLDER, properties); - } - - if (toDepth == 0) { - List children = new ArrayList(); - - for (NodeIterator iter = node.getNodes(); iter.hasNext();) { - Node child = iter.nextNode(); - - children.add(child.getName()); - } - - if (children.size() > 0) { - jsonNode.put(CHILD_NODE_HOLDER, new JSONArray(children)); - } - } else { - JSONObject children = new JSONObject(); - - for (NodeIterator iter = node.getNodes(); iter.hasNext();) { - Node child = iter.nextNode(); - - children.put(child.getName(), jsonFor(child, toDepth - 1)); - } - - if (children.length() > 0) { - jsonNode.put(CHILD_NODE_HOLDER, children); - } - } - - return jsonNode; - } - - /** - * Adds the content of the request as a node (or subtree of nodes) at the location specified by {@code path}. - *

- * The primary type and mixin type(s) may optionally be specified through the {@code jcr:primaryType} and {@code - * jcr:mixinTypes} properties. - *

- * - * @param request the servlet request; may not be null or unauthenticated - * @param rawRepositoryName the URL-encoded repository name - * @param rawWorkspaceName the URL-encoded workspace name - * @param path the path to the item - * @param requestContent the JSON-encoded representation of the node or nodes to be added - * @return the JSON-encoded representation of the node or nodes that were added. This will differ from {@code requestContent} - * in that auto-created and protected properties (e.g., jcr:uuid) will be populated. - * @throws NotFoundException if the parent of the item to be added does not exist - * @throws UnauthorizedException if the user does not have the access required to create the node at this path - * @throws JSONException if there is an error encoding the node - * @throws RepositoryException if any other error occurs - */ - @POST - @Path( "/{repositoryName}/{workspaceName}/items/{path:.*}" ) - @Consumes( "application/json" ) - public Response postItem( @Context HttpServletRequest request, - @PathParam( "repositoryName" ) String rawRepositoryName, - @PathParam( "workspaceName" ) String rawWorkspaceName, - @PathParam( "path" ) String path, - String requestContent ) - throws NotFoundException, UnauthorizedException, RepositoryException, JSONException { - - assert rawRepositoryName != null; - assert rawWorkspaceName != null; - assert path != null; - JSONObject body = new JSONObject(requestContent); - - int lastSlashInd = path.lastIndexOf('/'); - String parentPath = lastSlashInd == -1 ? "/" : "/" + path.substring(0, lastSlashInd); - String newNodeName = lastSlashInd == -1 ? path : path.substring(lastSlashInd + 1); - - Session session = getSession(request, rawRepositoryName, rawWorkspaceName); - - Node parentNode = (Node)session.getItem(parentPath); - - Node newNode = addNode(parentNode, newNodeName, body); - - session.save(); - - String json = jsonFor(newNode, -1).toString(); - return Response.status(Status.CREATED).entity(json).build(); - } - - /** - * Adds the node described by {@code jsonNode} with name {@code nodeName} to the existing node {@code parentNode}. - * - * @param parentNode the parent of the node to be added - * @param nodeName the name of the node to be added - * @param jsonNode the JSON-encoded representation of the node or nodes to be added. - * @return the JSON-encoded representation of the node or nodes that were added. This will differ from {@code requestContent} - * in that auto-created and protected properties (e.g., jcr:uuid) will be populated. - * @throws JSONException if there is an error encoding the node - * @throws RepositoryException if any other error occurs - */ - private Node addNode( Node parentNode, - String nodeName, - JSONObject jsonNode ) throws RepositoryException, JSONException { - Node newNode; - - JSONObject properties = jsonNode.has(PROPERTIES_HOLDER) ? jsonNode.getJSONObject(PROPERTIES_HOLDER) : new JSONObject(); - - if (properties.has(PRIMARY_TYPE_PROPERTY)) { - String primaryType = properties.getString(PRIMARY_TYPE_PROPERTY); - newNode = parentNode.addNode(nodeName, primaryType); - } else { - newNode = parentNode.addNode(nodeName); - } - - if (properties.has(MIXIN_TYPES_PROPERTY)) { - Object rawMixinTypes = properties.get(MIXIN_TYPES_PROPERTY); - - if (rawMixinTypes instanceof JSONArray) { - JSONArray mixinTypes = (JSONArray)rawMixinTypes; - for (int i = 0; i < mixinTypes.length(); i++) { - newNode.addMixin(mixinTypes.getString(i)); - } - - } else { - newNode.addMixin(rawMixinTypes.toString()); - - } - } - - for (Iterator iter = properties.keys(); iter.hasNext();) { - String key = (String)iter.next(); - - if (PRIMARY_TYPE_PROPERTY.equals(key)) continue; - if (MIXIN_TYPES_PROPERTY.equals(key)) continue; - setPropertyOnNode(newNode, key, properties.get(key)); - } - - if (jsonNode.has(CHILD_NODE_HOLDER)) { - JSONObject children = jsonNode.getJSONObject(CHILD_NODE_HOLDER); - - for (Iterator iter = children.keys(); iter.hasNext();) { - String childName = (String)iter.next(); - JSONObject child = children.getJSONObject(childName); - - addNode(newNode, childName, child); - } - } - - return newNode; - } - - private Value decodeValue( String encodedValue, - ValueFactory valueFactory ) throws RepositoryException { - byte[] binaryValue = Base64.decode(encodedValue); - InputStream stream = new ByteArrayInputStream(binaryValue); - try { - return valueFactory.createValue(stream); - } finally { - try { - stream.close(); - } catch (IOException e) { - // Error accessing the value, so throw this ... - throw new RepositoryException(e); - } - } - } - - /** - * Sets the named property on the given node. This method expects {@code value} to be either a JSON string or a JSON array of - * JSON strings. If {@code value} is a JSON array, {@code Node#setProperty(String, String[]) the multi-valued property setter} - * will be used. - * - * @param node the node on which the property is to be set - * @param propName the name of the property to set - * @param value the JSON-encoded values to be set - * @throws RepositoryException if there is an error setting the property - * @throws JSONException if {@code value} cannot be decoded - */ - private void setPropertyOnNode( Node node, - String propName, - Object value ) throws RepositoryException, JSONException { - // Are the property values encoded ? - boolean encoded = propName.endsWith(BASE64_ENCODING_SUFFIX); - if (encoded) { - int newLength = propName.length() - BASE64_ENCODING_SUFFIX.length(); - propName = newLength > 0 ? propName.substring(0, newLength) : ""; - } - - Value[] values; - ValueFactory valueFactory = node.getSession().getValueFactory(); - if (value instanceof JSONArray) { - JSONArray jsonValues = (JSONArray)value; - values = new Value[jsonValues.length()]; - - for (int i = 0; i < values.length; i++) { - String strValue = jsonValues.getString(i); - if (encoded) { - values[i] = decodeValue(strValue, valueFactory); - } else { - values[i] = valueFactory.createValue(strValue); - } - } - } else { - String strValue = (String)value; - if (encoded) { - values = new Value[] {decodeValue(strValue, valueFactory)}; - } else { - values = new Value[] {valueFactory.createValue(strValue)}; - } - } - - if (propName.equals(JcrResources.MIXIN_TYPES_PROPERTY)) { - Set toBeMixins = new HashSet(); - for (Value theValue : values) { - toBeMixins.add(theValue.getString()); - } - Set asIsMixins = new HashSet(); - - for (NodeType nodeType : node.getMixinNodeTypes()) { - asIsMixins.add(nodeType.getName()); - } - - Set mixinsToAdd = new HashSet(toBeMixins); - mixinsToAdd.removeAll(asIsMixins); - asIsMixins.removeAll(toBeMixins); - - for (String nodeType : mixinsToAdd) { - node.addMixin(nodeType); - } - - for (String nodeType : asIsMixins) { - node.removeMixin(nodeType); - } - } else { - if (values.length == 1) { - node.setProperty(propName, values[0]); - - } else { - node.setProperty(propName, values); - } - } - } - - /** - * Deletes the item at {@code path}. - * - * @param request the servlet request; may not be null or unauthenticated - * @param rawRepositoryName the URL-encoded repository name - * @param rawWorkspaceName the URL-encoded workspace name - * @param path the path to the item - * @throws NotFoundException if no item exists at {@code path} - * @throws UnauthorizedException if the user does not have the access required to delete the item at this path - * @throws RepositoryException if any other error occurs - */ - @DELETE - @Path( "/{repositoryName}/{workspaceName}/items{path:.*}" ) - @Consumes( "application/json" ) - public void deleteItem( @Context HttpServletRequest request, - @PathParam( "repositoryName" ) String rawRepositoryName, - @PathParam( "workspaceName" ) String rawWorkspaceName, - @PathParam( "path" ) String path ) - throws NotFoundException, UnauthorizedException, RepositoryException { - - assert rawRepositoryName != null; - assert rawWorkspaceName != null; - assert path != null; - - Session session = getSession(request, rawRepositoryName, rawWorkspaceName); - - Item item; - try { - item = session.getItem(path); - } catch (PathNotFoundException pnfe) { - throw new NotFoundException(pnfe.getMessage(), pnfe); - } - item.remove(); - session.save(); - } - - /** - * Updates the properties at the path. - *

- * If path points to a property, this method expects the request content to be either a JSON array or a JSON string. The array - * or string will become the values or value of the property. If path points to a node, this method expects the request - * content to be a JSON object. The keys of the objects correspond to property names that will be set and the values for the - * keys correspond to the values that will be set on the properties. - *

- * - * @param request the servlet request; may not be null or unauthenticated - * @param rawRepositoryName the URL-encoded repository name - * @param rawWorkspaceName the URL-encoded workspace name - * @param path the path to the item - * @param requestContent the JSON-encoded representation of the values and, possibly, properties to be set - * @return the JSON-encoded representation of the node on which the property or properties were set. - * @throws NotFoundException if the parent of the item to be added does not exist - * @throws UnauthorizedException if the user does not have the access required to create the node at this path - * @throws JSONException if there is an error encoding the node - * @throws RepositoryException if any other error occurs - * @throws IOException if there is a problem reading the value - */ - @PUT - @Path( "/{repositoryName}/{workspaceName}/items{path:.*}" ) - @Consumes( "application/json" ) - public String putItem( @Context HttpServletRequest request, - @PathParam( "repositoryName" ) String rawRepositoryName, - @PathParam( "workspaceName" ) String rawWorkspaceName, - @PathParam( "path" ) String path, - String requestContent ) throws UnauthorizedException, JSONException, RepositoryException, IOException { - - assert path != null; - assert rawRepositoryName != null; - assert rawWorkspaceName != null; - - Session session = getSession(request, rawRepositoryName, rawWorkspaceName); - Node node; - Item item; - if ("".equals(path) || "/".equals(path)) { - item = session.getRootNode(); - } else { - try { - item = session.getItem(path); - } catch (PathNotFoundException pnfe) { - throw new NotFoundException(pnfe.getMessage(), pnfe); - } - } - - if (item instanceof Node) { - JSONObject properties = new JSONObject(requestContent); - node = (Node)item; - - for (Iterator iter = properties.keys(); iter.hasNext();) { - String key = (String)iter.next(); - - setPropertyOnNode(node, key, properties.get(key)); - } - - } else { - /* - * The incoming content should be a JSON object containing the property name and a value that is either a JSON - * string or a JSON array. - */ - Property property = (Property)item; - String propertyName = property.getName(); - JSONObject jsonProperty = new JSONObject(requestContent); - String jsonPropertyName = jsonProperty.has(propertyName) ? propertyName : propertyName + BASE64_ENCODING_SUFFIX; - node = property.getParent(); - setPropertyOnNode(node, jsonPropertyName, jsonProperty.get(jsonPropertyName)); - } - node.save(); - return jsonFor(node, 0).toString(); - } - - private String workspaceNameFor( String rawWorkspaceName ) { - String workspaceName = URL_ENCODER.decode(rawWorkspaceName); - - if (EMPTY_WORKSPACE_NAME.equals(workspaceName)) { - workspaceName = ""; - } - - return workspaceName; - } - - private String repositoryNameFor( String rawRepositoryName ) { - String repositoryName = URL_ENCODER.decode(rawRepositoryName); - - if (EMPTY_REPOSITORY_NAME.equals(repositoryName)) { - repositoryName = ""; - } - - return repositoryName; - } +public class JcrResources extends AbstractJcrResource { @Provider public static class NotFoundExceptionMapper implements ExceptionMapper { Index: web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/RepositoryResource.java new file mode 100644 =================================================================== --- /dev/null (revision 1671) +++ web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/RepositoryResource.java (working copy) @@ -0,0 +1,74 @@ +package org.modeshape.web.jcr.rest; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import javax.jcr.RepositoryException; +import javax.jcr.Session; +import javax.servlet.http.HttpServletRequest; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import net.jcip.annotations.Immutable; +import org.modeshape.web.jcr.rest.model.WorkspaceEntry; + +/** + * RESTEasy handler to provide the JCR repository at the URI below. Please note that the URI assumes a context of {@code + * /resources} for the web application. + * + * + * + * + * + * + * + * + * + * + * + *
URI PatternDescriptionSupported Methods
/resources/{repositoryName}returns a list of accessible workspaces within that repositoryGET
+ */ +@Immutable +@Path("/") +public class RepositoryResource extends AbstractJcrResource { + + + /** + * Returns the list of workspaces available to this user within the named repository. + * + * @param rawRepositoryName the name of the repository; may not be null + * @param request the servlet request; may not be null + * @return the list of workspaces available to this user within the named repository. + * @throws IOException if the given repository name does not map to any repositories and there is an error writing the error + * code to the response. + * @throws RepositoryException if there is any other error accessing the list of available workspaces for the repository + */ + @GET + @Path( "/{repositoryName}" ) + @Produces( "application/json" ) + public Map getWorkspaces( @Context HttpServletRequest request, + @PathParam( "repositoryName" ) String rawRepositoryName ) + throws RepositoryException, IOException { + + assert request != null; + assert rawRepositoryName != null; + + Map workspaces = new HashMap(); + + Session session = getSession(request, rawRepositoryName, null); + rawRepositoryName = URL_ENCODER.encode(rawRepositoryName); + + for (String name : session.getWorkspace().getAccessibleWorkspaceNames()) { + if (name.trim().length() == 0) { + name = EMPTY_WORKSPACE_NAME; + } + name = URL_ENCODER.encode(name); + workspaces.put(name, new WorkspaceEntry(request.getContextPath(), rawRepositoryName, name)); + } + + return workspaces; + } + +} Index: web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/ServerResource.java new file mode 100644 =================================================================== --- /dev/null (revision 1671) +++ web/modeshape-web-jcr-rest/src/main/java/org/modeshape/web/jcr/rest/ServerResource.java (working copy) @@ -0,0 +1,59 @@ +package org.modeshape.web.jcr.rest; + +import java.util.HashMap; +import java.util.Map; +import javax.servlet.http.HttpServletRequest; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import org.modeshape.web.jcr.rest.model.RepositoryEntry; +import net.jcip.annotations.Immutable; + +/** + * RESTEasy handler to provide the JCR repositories hosted on the server at the URI below. Please note that this URI assumes a + * context of {@code /resources} for the web application. + * + * + * + * + * + * + * + * + * + * + * + *
URI PatternDescriptionSupported Methods
/resourcesreturns a list of accessible repositoriesGET
+ */ + +@Immutable +@Path( "/" ) +public class ServerResource extends AbstractJcrResource { + + /** + * Returns the list of JCR repositories available on this server + * + * @param request the servlet request; may not be null + * @return the list of JCR repositories available on this server + */ + @GET + @Path( "/" ) + @Produces( "application/json" ) + public Map getRepositories( @Context HttpServletRequest request ) { + assert request != null; + + Map repositories = new HashMap(); + + for (String name : RepositoryFactory.getJcrRepositoryNames()) { + if (name.trim().length() == 0) { + name = EMPTY_REPOSITORY_NAME; + } + name = URL_ENCODER.encode(name); + repositories.put(name, new RepositoryEntry(request.getContextPath(), name)); + } + + return repositories; + } + +} Index: web/pom.xml new file mode 100644 =================================================================== --- /dev/null (revision 1671) +++ web/pom.xml (working copy) @@ -0,0 +1,19 @@ + + + org.modeshape + modeshape + 1.0.0-SNAPSHOT + + 4.0.0 + org.modeshape.web + modeshape-web + pom + ModeShape Web Components + http://www.modeshape.org + ModeShape Web Components + + modeshape-web-jcr-rest + modeshape-web-jcr-rest-client + modeshape-web-jcr-rest-war + +