com.bigdata.rdf.sail.webapp.client

Class RemoteRepositoryDecls

java.lang.Object

com.bigdata.rdf.sail.webapp.client.RemoteRepositoryDecls

Direct Known Subclasses:

RemoteRepositoryBase

public class RemoteRepositoryDecls
extends Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URI The name of the parameter/attribute that contains baseURI for remote queries execution.
protected static org.openrdf.model.URI	BD_NULL_GRAPH
static String	BINDING_PREFIX The Prefix of the parameter/attribute that contains binding for remote queries execution.
static String	DEFAULT_GRAPH_URI URL query parameter used to specify a URI in the default graph for SPARQL query (but not for SPARQL update).
static int	DEFAULT_MAX_REQUEST_URL_LENGTH The default maximum limit on a requestURL before the request is converted into a POST using a application/x-www-form-urlencoded request entity.
static String	DEFAULT_NAMESPACE The name of the default namespace.
static String	DEFAULT_QUERY_METHOD Note: The default is "POST".
static String	FORCE_INDEX_CREATE URL query parameter that contains boolean flag to create full text index if not exists.
protected static String	HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS HTTP header may be used to specify the timeout for a query.
static String	INCLUDE_INFERRED The name of the parameter/attribute that contains boolean flag to include inferred statements for remote queries execution or returning statements.
static String	MAX_QUERY_TIME_MILLIS The name of the parameter/attribute that contains high resolution maxQueryTime (milliseconds) for remote queries execution.
static String	MAX_REQUEST_URL_LENGTH 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.
static String	NAMED_GRAPH_URI URL query parameter used to specify a URI in the set of named graphs for SPARQL query (but not for SPARQL update).
static String	OPTION_CREATE_KB_NAMESPACE The name of the property whose value is the namespace of the KB to be created.
static String	QUERY_METHOD 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.
protected static String	QUERYID The name of the URL request parameter used to assign a unique identifier to a REST API request.
static String	USING_GRAPH_URI URL query parameter used to specify a URI in the default graph for SPARQL UPDATE.
static String	USING_NAMED_GRAPH_URI URL query parameter used to specify a URI in the set of named graphs for SPARQL UPDATE.
protected static String	UTF8 The name of the UTF-8 character encoding.

Constructor Summary

Constructors

Constructor and Description
RemoteRepositoryDecls()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

BD_NULL_GRAPH

protected static final org.openrdf.model.URI BD_NULL_GRAPH

UTF8

protected static final String UTF8

The name of the UTF-8 character encoding.

See Also:

Constant Field Values

QUERYID

protected static final String QUERYID

The name of the URL request parameter used to assign a unique identifier to a REST API request.

See Also:

Constant Field Values

QUERY_METHOD

public static final String QUERY_METHOD

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 Also:

DEFAULT_QUERY_METHOD, Allow overrride of maximum length before converting an HTTP GET to an HTTP POST

DEFAULT_QUERY_METHOD

public static final String DEFAULT_QUERY_METHOD

Note: The default is "POST". 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 Also:

#getQueryMethod(), #setQueryMethod(String), Constant Field Values

MAX_REQUEST_URL_LENGTH

public static final String MAX_REQUEST_URL_LENGTH

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 Also:

Allow overrride of maximum length before converting an HTTP GET to an HTTP POST

DEFAULT_MAX_REQUEST_URL_LENGTH

public static final int DEFAULT_MAX_REQUEST_URL_LENGTH

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.

See Also:

Constant Field Values

OPTION_CREATE_KB_NAMESPACE

public static final String OPTION_CREATE_KB_NAMESPACE

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 Also:

DEFAULT_NAMESPACE, Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

The name of the default namespace.

See Also:

Constant Field Values

HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS

protected static final String HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS

HTTP header may be used to specify the timeout for a query.

See Also:

(Set timeout on remote query), Constant Field Values

INCLUDE_INFERRED

public static final String INCLUDE_INFERRED

The name of the parameter/attribute that contains boolean flag to include inferred statements for remote queries execution or returning statements.

See Also:

com.bigdata.rdf.sail.webapp.QueryServlet.INCLUDE_INFERRED, Constant Field Values

BASE_URI

public static final String BASE_URI

The name of the parameter/attribute that contains baseURI for remote queries execution.

See Also:

com.bigdata.rdf.sail.webapp.QueryServlet.BASE_URI, Constant Field Values

MAX_QUERY_TIME_MILLIS

public static final String MAX_QUERY_TIME_MILLIS

The name of the parameter/attribute that contains high resolution maxQueryTime (milliseconds) for remote queries execution. Minimum value of maxQueryTimeMillis and HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS header will be used as an effective timeout.

See Also:

com.bigdata.rdf.sail.webapp.QueryServlet.TIMEOUT, Constant Field Values

DEFAULT_GRAPH_URI

public static final String DEFAULT_GRAPH_URI

URL query parameter used to specify a URI in the default graph for SPARQL query (but not for SPARQL update).

See Also:

com.bigdata.rdf.sail.webapp.BigdataRDFContext.DEFAULT_GRAPH_URI, Constant Field Values

NAMED_GRAPH_URI

public static final String NAMED_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 Also:

com.bigdata.rdf.sail.webapp.BigdataRDFContext.NAMED_GRAPH_URI, Constant Field Values

USING_GRAPH_URI

public static final String USING_GRAPH_URI

URL query parameter used to specify a URI in the default graph for SPARQL UPDATE.

See Also:

com.bigdata.rdf.sail.webapp.BigdataRDFContext.USING_GRAPH_URI, Constant Field Values

USING_NAMED_GRAPH_URI

public static final String USING_NAMED_GRAPH_URI

URL query parameter used to specify a URI in the set of named graphs for SPARQL UPDATE.

See Also:

com.bigdata.rdf.sail.webapp.BigdataRDFContext.USING_NAMED_GRAPH_URI, Constant Field Values

BINDING_PREFIX

public static final String BINDING_PREFIX

The Prefix of the parameter/attribute that contains binding for remote queries execution.

See Also:

com.bigdata.rdf.sail.webapp.QueryServlet.BINDING_PREFIX, Constant Field Values

FORCE_INDEX_CREATE

public static final String FORCE_INDEX_CREATE

URL query parameter that contains boolean flag to create full text index if not exists.

See Also:

Constant Field Values

Constructor Detail

RemoteRepositoryDecls

public RemoteRepositoryDecls()