com.bigdata.rdf.sail.webapp

Class StatusServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.bigdata.rdf.sail.webapp.BigdataServlet

com.bigdata.rdf.sail.webapp.BigdataRDFServlet

com.bigdata.rdf.sail.webapp.StatusServlet

All Implemented Interfaces:

IMimeTypes, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class StatusServlet
extends BigdataRDFServlet

A status page for the service. TODO The KB addressed by the request should also be displayed as metadata associated with the request. We should make this a restriction that can be placed onto the status page and make it easy to see the status for different KBs.

Author:

thompsonbry, martyncutcher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CANCEL_QUERY The name of a request parameter used to cancel a running query (or any other kind of REST API operation).

Fields inherited from class com.bigdata.rdf.sail.webapp.BigdataRDFServlet

ATTR_BLUEPRINTS, MIME_JSON, MIME_RDF_XML, MIME_SPARQL_QUERY, MIME_SPARQL_RESULTS_JSON, MIME_SPARQL_RESULTS_XML, MIME_SPARQL_UPDATE, NA, OUTPUT_FORMAT_JSON, OUTPUT_FORMAT_JSON_SHORT, OUTPUT_FORMAT_QUERY_PARAMETER, OUTPUT_FORMAT_XML, OUTPUT_FORMAT_XML_SHORT, UNDEFINED_WORKBENCH_NAMESPACE, UTF8

Fields inherited from class com.bigdata.rdf.sail.webapp.BigdataServlet

ATTRIBUTE_RDF_CONTEXT, charset, DELETE, GET, HTTP_BADREQUEST, HTTP_HEADER_BIGDATA_READ_ONLY, HTTP_INTERNALERROR, HTTP_METHOD_NOT_ALLOWED, HTTP_NOTFOUND, HTTP_NOTIMPLEMENTED, HTTP_OK, POST, PUT

Fields inherited from interface com.bigdata.rdf.sail.webapp.client.IMimeTypes

MIME_APPLICATION_JSON, MIME_APPLICATION_URL_ENCODED, MIME_APPLICATION_XML, MIME_DEFAULT_BINARY, MIME_GRAPH_ML, MIME_PROPERTIES_XML, MIME_TEXT_HTML, MIME_TEXT_JAVASCRIPT, MIME_TEXT_PLAIN

Constructor Summary

Constructors

Constructor and Description
StatusServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) A status page.
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Handles CANCEL requests (terminate a running query).

Methods inherited from class com.bigdata.rdf.sail.webapp.BigdataRDFServlet

buildAndCommitBooleanResponse, buildAndCommitNamespaceNotFoundResponse, buildAndCommitRangeCountResponse, getNamespace, getTimestamp, isAttachment, launderThrowable, newPipedInputStream, parseBindings, sendGraph, sendProperties, toURIs

Methods inherited from class com.bigdata.rdf.sail.webapp.BigdataServlet

buildAndCommitResponse, decodeContexts, getBigdataRDFContext, getBooleanValue, getIndexManager, getIndexManager, getServiceURIs, readFully, submitApiTask

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

CANCEL_QUERY

protected static final String CANCEL_QUERY

The name of a request parameter used to cancel a running query (or any other kind of REST API operation). At least one QUERY_ID must also be specified. Queries specified by their QUERY_ID will be cancelled if they are still running.

See Also:

QUERY_ID, QueryHints.QUERYID, Constant Field Values

Constructor Detail

StatusServlet

public StatusServlet()

Method Detail

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
          javax.servlet.http.HttpServletResponse resp)
               throws IOException

Handles CANCEL requests (terminate a running query).

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
         javax.servlet.http.HttpServletResponse resp)
              throws IOException

A status page. Options include:

showQueries

List SPARQL queries accepted by the SPARQL end point which are currently executing on the QueryEngine. The queries are listed in order of decreasing elapsed time. You can also specify showQueries=details to get a detailed breakdown of the query execution.

queryId=<UUID> to specify the query(s) of interest. This parameter may appear zero or more times. When give, the response will include information only about the specified queries.

showKBInfo

Show some information about the AbstractTripleStore instance being served by this SPARQL end point.

showNamespaces

List the namespaces for the registered AbstractTripleStores.

dumpJournal

Provides low-level information about the backing Journal (if any).

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

IOException

See Also:

All REST API operations should be cancelable from both REST API and workbench