com.bigdata.rdf.sail.webapp.client.RemoteRepositoryDecls Maven / Gradle / Ivy
/**
Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016. All rights reserved.
Contact:
SYSTAP, LLC DBA Blazegraph
2501 Calvert ST NW #106
Washington, DC 20008
[email protected]
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package com.bigdata.rdf.sail.webapp.client;
import org.openrdf.model.URI;
import org.openrdf.model.impl.URIImpl;
//Note: Do not import. Not part of the bigdata-client.jar
//
//import com.bigdata.rdf.sparql.ast.service.RemoteServiceOptions;
/**
* Various declarations used by the client API.
*
* Note: Some of these fields are replicated from the com.bigdata.rdf.store.BD
* interface in order to avoid dragging in other aspects of the bigdata code
* base.
*/
public class RemoteRepositoryDecls {
/**
* The namespace used for bigdata specific extensions.
*/
private static final String BD_NAMESPACE = "http://www.bigdata.com/rdf#";
protected static final URI BD_NULL_GRAPH = new URIImpl(BD_NAMESPACE + "nullGraph");
/**
* The name of the UTF-8 character encoding.
*/
static protected final String UTF8 = "UTF-8";
/**
* The name of the URL request parameter used to assign a unique identifier
* to a REST API request.
*/
static protected final String QUERYID = "queryId";
/**
* The name of the system property that may be used to specify the default
* HTTP method (GET or POST) for a SPARQL QUERY or other indempotent
* request.
*
* @see #DEFAULT_QUERY_METHOD
*
* @see Allow overrride of
* maximum length before converting an HTTP GET to an HTTP POST
*/
static public final String QUERY_METHOD = RemoteRepository.class
.getName() + ".queryMethod";
/**
* Note: The default is {@value #DEFAULT_QUERY_METHOD}. This supports use
* cases where the end points are read/write databases and http caching must
* be defeated in order to gain access to the most recent committed state of
* the end point.
*
* @see #getQueryMethod()
* @see #setQueryMethod(String)
*/
static public final String DEFAULT_QUERY_METHOD = "POST";
/**
* The name of the system property that may be used to specify the maximum
* length (in characters) for a requestURL associated with an HTTP GET
* before it is automatically converted to an HTTP POST.
*
* @see Allow overrride of
* maximum length before converting an HTTP GET to an HTTP POST
*/
static public final String MAX_REQUEST_URL_LENGTH = RemoteRepository.class
.getName() + ".maxRequestURLLength";
/**
* The default maximum limit on a requestURL before the request is converted
* into a POST using a application/x-www-form-urlencoded
* request entity.
*
* Note: I suspect that 2000 might be a better default limit. If the limit
* is 4096 bytes on the target, then, even with UTF encoding, most queries
* having a request URL that is 2000 characters long should go through with
* a GET. 1000 is a safe value but it could reduce http caching.
*/
static public final int DEFAULT_MAX_REQUEST_URL_LENGTH = 1000;
/**
* The name of the property whose value is the namespace of the KB to be
* created.
*
* Note: This string is identicial to one defined by the BigdataSail
* options, but the client API must not include a dependency on the Sail so
* it is given by value again here in a package local scope.
*
* @see #DEFAULT_NAMESPACE
*/
public static final String OPTION_CREATE_KB_NAMESPACE = "com.bigdata.rdf.sail.namespace";
/**
* The name of the default namespace.
*/
public static final String DEFAULT_NAMESPACE = "kb";
/**
* HTTP header may be used to specify the timeout for a query.
*
* @see http://trac.blazegraph.com/ticket/914 (Set timeout on remote query)
*/
static protected final String HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS = "X-BIGDATA-MAX-QUERY-MILLIS";
/**
* The name of the parameter/attribute that contains boolean flag to include inferred statements for remote queries execution or returning statements.
* @see com.bigdata.rdf.sail.webapp.QueryServlet.INCLUDE_INFERRED
*/
public static final String INCLUDE_INFERRED = "includeInferred";
/**
* The name of the parameter/attribute that contains baseURI for remote queries execution.
* @see com.bigdata.rdf.sail.webapp.QueryServlet.BASE_URI
*/
public static final String BASE_URI = "baseURI";
/**
* The name of the parameter/attribute that contains high resolution maxQueryTime (milliseconds) for remote queries execution.
* Minimum value of maxQueryTimeMillis and {@link com.bigdata.rdf.sail.webapp.client.RemoteRepositoryDecls.HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS header} will be used as an effective timeout.
* @see com.bigdata.rdf.sail.webapp.QueryServlet.TIMEOUT
*/
public static final String MAX_QUERY_TIME_MILLIS = "maxQueryTimeMillis";
/**
* URL query parameter used to specify a URI in the default graph for SPARQL
* query (but not for SPARQL update).
* @see com.bigdata.rdf.sail.webapp.BigdataRDFContext.DEFAULT_GRAPH_URI
*/
public static final String DEFAULT_GRAPH_URI = "default-graph-uri";
/**
* URL query parameter used to specify a URI in the set of named graphs for
* SPARQL query (but not for SPARQL update).
* @see com.bigdata.rdf.sail.webapp.BigdataRDFContext.NAMED_GRAPH_URI
*/
public static final String NAMED_GRAPH_URI = "named-graph-uri";
/**
* URL query parameter used to specify a URI in the default graph for SPARQL
* UPDATE.
* @see com.bigdata.rdf.sail.webapp.BigdataRDFContext.USING_GRAPH_URI
*/
public static final String USING_GRAPH_URI = "using-graph-uri";
/**
* URL query parameter used to specify a URI in the set of named graphs for
* SPARQL UPDATE.
* @see com.bigdata.rdf.sail.webapp.BigdataRDFContext.USING_NAMED_GRAPH_URI
*/
public static final String USING_NAMED_GRAPH_URI = "using-named-graph-uri";
/**
* The Prefix of the parameter/attribute that contains binding for remote queries execution.
* @see com.bigdata.rdf.sail.webapp.QueryServlet.BINDING_PREFIX
*/
public static final String BINDING_PREFIX = "$";
/**
* URL query parameter that contains boolean flag to create full text index if not exists.
*/
public static final String FORCE_INDEX_CREATE = "force-index-create";
}