package com.tinkerpop.rexster;
import com.codahale.metrics.annotation.Timed;
import com.tinkerpop.blueprints.Features;
import com.tinkerpop.blueprints.Graph;
import com.tinkerpop.blueprints.util.wrappers.WrapperGraph;
import com.tinkerpop.blueprints.util.wrappers.readonly.ReadOnlyGraph;
import com.tinkerpop.rexster.extension.ExtensionMethod;
import com.tinkerpop.rexster.extension.ExtensionPoint;
import com.tinkerpop.rexster.extension.ExtensionResponse;
import com.tinkerpop.rexster.extension.ExtensionSegmentSet;
import com.tinkerpop.rexster.extension.HttpMethod;
import com.tinkerpop.rexster.extension.RexsterExtension;
import com.tinkerpop.rexster.server.RexsterApplication;
import org.apache.log4j.Logger;
import org.codehaus.jettison.json.JSONArray;
import org.codehaus.jettison.json.JSONException;
import org.codehaus.jettison.json.JSONObject;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HEAD;
import javax.ws.rs.OPTIONS;
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.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.UriInfo;
import java.util.List;
import java.util.ServiceConfigurationError;
/**
* Resource for graphs.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
@Path("/graphs/{graphname}")
public class GraphResource extends AbstractSubResource {
private static final Logger logger = Logger.getLogger(GraphResource.class);
public GraphResource() {
super(null);
}
public GraphResource(final UriInfo ui, final HttpServletRequest req, final RexsterApplication ra) {
super(ra);
this.httpServletRequest = req;
this.uriInfo = ui;
}
@OPTIONS
public Response optionsGraph() {
return buildOptionsResponse(HttpMethod.GET.toString(),
HttpMethod.DELETE.toString());
}
@GET
@Produces({MediaType.APPLICATION_JSON})
@Timed(name = "http.rest.graphs.object.get", absolute = true)
public Response getGraphProducesJson(@PathParam("graphname") final String graphName) {
return getGraph(graphName, false);
}
/**
* GET http://host/graph
* graph.toString();
*/
@GET
@Produces({RexsterMediaType.APPLICATION_REXSTER_JSON, RexsterMediaType.APPLICATION_REXSTER_TYPED_JSON})
@Timed(name = "http.rest.graphs.object.get", absolute = true)
public Response getGraphProducesRexsterJson(@PathParam("graphname") final String graphName) {
return getGraph(graphName, true);
}
private Response getGraph(final String graphName, final boolean showHypermedia) {
final RexsterApplicationGraph rag = this.getRexsterApplicationGraph(graphName);
final Graph graph = rag.getGraph();
try {
this.resultObject.put("name", graphName);
this.resultObject.put("graph", graph.toString());
boolean isReadOnly = false;
String graphType = graph.getClass().getName();
if (graph instanceof WrapperGraph) {
graphType = ((WrapperGraph) graph).getBaseGraph().getClass().getName();
if (graph instanceof ReadOnlyGraph) {
isReadOnly = true;
}
}
final Features features = graph.getFeatures();
this.resultObject.put(Tokens.FEATURES, new JSONObject(features.toMap()));
this.resultObject.put(Tokens.READ_ONLY, isReadOnly);
this.resultObject.put(Tokens.TYPE, graphType);
this.resultObject.put(Tokens.QUERY_TIME, this.sh.stopWatch());
this.resultObject.put(Tokens.UP_TIME, this.getTimeAlive());
this.resultObject.put(Tokens.VERSION, Tokens.REXSTER_VERSION);
if (showHypermedia) {
final JSONArray extensionsList = rag.getExtensionHypermedia(ExtensionPoint.GRAPH, this.getUriPath());
if (extensionsList != null) {
this.resultObject.put(Tokens.EXTENSIONS, extensionsList);
}
}
} catch (JSONException ex) {
logger.error(ex);
final JSONObject error = generateErrorObjectJsonFail(ex);
throw new WebApplicationException(Response.status(Status.INTERNAL_SERVER_ERROR).entity(error).build());
}
return Response.ok(this.resultObject).build();
}
@HEAD
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_JSON)
public Response headGraphExtension(@PathParam("graphname") final String graphName, final JSONObject json) {
this.setRequestObject(json);
return this.executeGraphExtension(graphName, HttpMethod.HEAD);
}
@HEAD
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
public Response headGraphExtension(@PathParam("graphname") final String graphName) {
return this.executeGraphExtension(graphName, HttpMethod.HEAD);
}
@PUT
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_JSON)
@Timed(name = "http.rest.graphs.extension.put", absolute = true)
public Response putGraphExtension(@PathParam("graphname") final String graphName, final JSONObject json) {
this.setRequestObject(json);
return this.executeGraphExtension(graphName, HttpMethod.PUT);
}
@PUT
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Timed(name = "http.rest.graphs.extension.put", absolute = true)
public Response putGraphExtension(@PathParam("graphname") final String graphName, final MultivaluedMap<String, String> formParams) {
this.setRequestObject(formParams);
return this.executeGraphExtension(graphName, HttpMethod.PUT);
}
@PUT
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Timed(name = "http.rest.graphs.extension.put", absolute = true)
public Response putGraphExtension(@PathParam("graphname") final String graphName) {
return this.executeGraphExtension(graphName, HttpMethod.PUT);
}
@OPTIONS
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_JSON)
public Response optionsGraphExtension(@PathParam("graphname") final String graphName, final JSONObject json) {
this.setRequestObject(json);
return this.executeGraphExtension(graphName, HttpMethod.OPTIONS);
}
@OPTIONS
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
public Response optionsGraphExtension(@PathParam("graphname") final String graphName) {
return this.executeGraphExtension(graphName, HttpMethod.OPTIONS);
}
@DELETE
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_JSON)
@Timed(name = "http.rest.graphs.extension.delete", absolute = true)
public Response deleteGraphExtension(@PathParam("graphname") final String graphName, final JSONObject json) {
this.setRequestObject(json);
return this.executeGraphExtension(graphName, HttpMethod.DELETE);
}
@DELETE
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Timed(name = "http.rest.graphs.extension.delete", absolute = true)
public Response deleteGraphExtension(@PathParam("graphname") final String graphName) {
return this.executeGraphExtension(graphName, HttpMethod.DELETE);
}
@POST
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_JSON)
@Timed(name = "http.rest.graphs.extension.post", absolute = true)
public Response postGraphExtension(@PathParam("graphname") final String graphName, final JSONObject json) {
this.setRequestObject(json);
return this.executeGraphExtension(graphName, HttpMethod.POST);
}
@POST
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@Timed(name = "http.rest.graphs.extension.post", absolute = true)
public Response postGraphExtension(@PathParam("graphname") String graphName, final MultivaluedMap<String, String> formParams) {
this.setRequestObject(formParams);
return this.executeGraphExtension(graphName, HttpMethod.POST);
}
@POST
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Timed(name = "http.rest.graphs.extension.post", absolute = true)
public Response postGraphExtension(@PathParam("graphname") final String graphName) {
return this.executeGraphExtension(graphName, HttpMethod.POST);
}
@GET
@Path("{extension: (?!vertices)(?!edges)(?!indices)(?!keyindices)(?!prefixes).+}")
@Timed(name = "http.rest.graphs.extension.post", absolute = true)
public Response getGraphExtension(@PathParam("graphname") final String graphName) {
return this.executeGraphExtension(graphName, HttpMethod.GET);
}
private Response executeGraphExtension(final String graphName, final HttpMethod httpMethodRequested) {
ExtensionResponse extResponse;
ExtensionMethod methodToCall;
final ExtensionSegmentSet extensionSegmentSet = parseUriForExtensionSegment(graphName, ExtensionPoint.GRAPH);
// determine if the namespace and extension are enabled for this graph
final RexsterApplicationGraph rag = this.getRexsterApplicationGraph(graphName);
if (rag.isExtensionAllowed(extensionSegmentSet)) {
Object returnValue = null;
// namespace was allowed so try to run the extension
try {
// look for the extension as loaded through serviceloader
List<RexsterExtension> rexsterExtensions = null;
try {
rexsterExtensions = findExtensionClasses(extensionSegmentSet);
} catch (ServiceConfigurationError sce) {
logger.error("ServiceLoader could not find a class referenced in com.tinkerpop.rexster.extension.RexsterExtension.");
final JSONObject error = generateErrorObject(
"Class specified in com.tinkerpop.rexster.extension.RexsterExtension could not be found.",
sce);
throw new WebApplicationException(Response.status(Status.NOT_FOUND).entity(error).build());
}
if (rexsterExtensions == null || rexsterExtensions.size() == 0) {
// extension was not found for some reason
logger.error("The [" + extensionSegmentSet + "] extension was not found for [" + graphName + "]. Check com.tinkerpop.rexster.extension.RexsterExtension file in META-INF.services.");
final JSONObject error = generateErrorObject(
"The [" + extensionSegmentSet + "] extension was not found for [" + graphName + "]");
throw new WebApplicationException(Response.status(Status.NOT_FOUND).entity(error).build());
}
// look up the method on the extension that needs to be called.
methodToCall = findExtensionMethod(rexsterExtensions, ExtensionPoint.GRAPH, extensionSegmentSet.getExtensionMethod(), httpMethodRequested);
if (methodToCall == null) {
// extension method was not found for some reason
if (httpMethodRequested == HttpMethod.OPTIONS) {
// intercept the options call and return the standard business
// no need to stop the transaction here
return buildOptionsResponse();
}
logger.error("The [" + extensionSegmentSet + "] extension was not found for [" + graphName + "] with a HTTP method of [" + httpMethodRequested.name() + "]. Check com.tinkerpop.rexster.extension.RexsterExtension file in META-INF.services.");
final JSONObject error = generateErrorObject(
"The [" + extensionSegmentSet + "] extension was not found for [" + graphName + "] with a HTTP method of [" + httpMethodRequested.name() + "]");
throw new WebApplicationException(Response.status(Status.NOT_FOUND).entity(error).build());
}
// found the method...time to do work
returnValue = invokeExtension(rag, methodToCall);
rag.tryCommit();
} catch (WebApplicationException wae) {
// already logged this...just throw it up.
rag.tryRollback();
throw wae;
} catch (Exception ex) {
logger.error("Dynamic invocation of the [" + extensionSegmentSet + "] extension failed.", ex);
if (ex.getCause() != null) {
final Throwable cause = ex.getCause();
logger.error("It would be smart to trap this this exception within the extension and supply a good response to the user:" + cause.getMessage(), cause);
}
rag.tryRollback();
final JSONObject error = generateErrorObjectJsonFail(ex);
throw new WebApplicationException(Response.status(Status.INTERNAL_SERVER_ERROR).entity(error).build());
}
if (returnValue instanceof ExtensionResponse) {
extResponse = (ExtensionResponse) returnValue;
if (extResponse.isErrorResponse()) {
// an error was raised within the extension. pass it back out as an error.
logger.warn("The [" + extensionSegmentSet + "] extension raised an error response.");
if (methodToCall.getExtensionDefinition().autoCommitTransaction()) {
rag.tryRollback();
}
throw new WebApplicationException(Response.fromResponse(extResponse.getJerseyResponse()).build());
}
if (methodToCall.getExtensionDefinition().autoCommitTransaction()) {
rag.tryCommit();
}
} else {
// extension method is not returning the correct type...needs to be an ExtensionResponse
logger.error("The [" + extensionSegmentSet + "] extension does not return an ExtensionResponse.");
final JSONObject error = generateErrorObject(
"The [" + extensionSegmentSet + "] extension does not return an ExtensionResponse.");
throw new WebApplicationException(Response.status(Status.INTERNAL_SERVER_ERROR).entity(error).build());
}
} else {
// namespace was not allowed
logger.error("The [" + extensionSegmentSet + "] extension was not configured for [" + graphName + "]");
final JSONObject error = generateErrorObject(
"The [" + extensionSegmentSet + "] extension was not configured for [" + graphName + "]");
throw new WebApplicationException(Response.status(Status.INTERNAL_SERVER_ERROR).entity(error).build());
}
String mediaType = MediaType.APPLICATION_JSON;
if (methodToCall != null) {
mediaType = methodToCall.getExtensionDefinition().produces();
extResponse = tryAppendRexsterAttributesIfJson(extResponse, methodToCall, mediaType);
}
return Response.fromResponse(extResponse.getJerseyResponse()).type(mediaType).build();
}
}