com.hp.hpl.jena.sparql.engine.http

Class HttpQuery

java.lang.Object

com.hp.hpl.jena.sparql.engine.http.Params

com.hp.hpl.jena.sparql.engine.http.HttpQuery

public class HttpQuery
extends Params

Create an execution object for performing a query on a model over HTTP. This is the main protocol engine for HTTP query. There are higher level classes for doing a query and presenting the results in an API fashion. If the query string is large, then HTTP POST is used.

Nested Class Summary

Nested classes/interfaces inherited from class com.hp.hpl.jena.sparql.engine.http.Params

Params.Pair

Field Summary

Fields

Modifier and Type	Field and Description
static int	urlLimit The definition of "large" queries

Constructor Summary

Constructors

Constructor and Description
HttpQuery(String serviceURL) Create a execution object for a whole model GET
HttpQuery(URL url) Create a execution object for a whole model GET

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	exec() Execute the operation
HttpURLConnection	getConnection()
int	getConnectTimeout() Gets the HTTP Connection timeout
String	getContentType() Gets the Content Type, if the query has been made this reflects the Content-Type header returns, if it has not been made this reflects only the Accept header that will be sent (as set via the setAccept(String) method)
int	getReadTimeout() Gets the HTTP Read timeout
int	getResponseCode() Gets the HTTP Response Code returned by the request (returns 0 if request has yet to be made)
void	setAccept(String contentType) Set the content type (Accept header) for the results
void	setAllowDeflate(boolean allow) Sets whether the HTTP request will include a Accept-Encoding: deflate header
void	setAllowGZip(boolean allow) Sets whether the HTTP request will include a Accept-Encoding: gzip header
void	setBasicAuthentication(String user, char[] password) Sets basic authentication
void	setConnectTimeout(int timeout) Sets HTTP Connection timeout, any value <= 0 is taken to mean no timeout
void	setForcePOST() Force the use of HTTP POST for the query operation
void	setReadTimeout(int timeout) Sets HTTP Read timeout, any value <= 0 is taken to mean no timeout
String	toString()
boolean	usesPOST() Return whether this request will go by GET or POST

Methods inherited from class com.hp.hpl.jena.sparql.engine.http.Params

addParam, addParam, containsParam, count, getValue, getValues, httpString, merge, names, pairs, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

urlLimit

public static int urlLimit

The definition of "large" queries

Constructor Detail

HttpQuery

public HttpQuery(String serviceURL)

Create a execution object for a whole model GET

Parameters:

serviceURL - The model

HttpQuery

public HttpQuery(URL url)

Create a execution object for a whole model GET

Parameters:

url - The model

Method Detail

getConnection

public HttpURLConnection getConnection()

setAccept

public void setAccept(String contentType)

Set the content type (Accept header) for the results

getContentType

public String getContentType()

Gets the Content Type, if the query has been made this reflects the Content-Type header returns, if it has not been made this reflects only the Accept header that will be sent (as set via the setAccept(String) method)

getResponseCode

public int getResponseCode()

Gets the HTTP Response Code returned by the request (returns 0 if request has yet to be made)

setAllowGZip

public void setAllowGZip(boolean allow)

Sets whether the HTTP request will include a Accept-Encoding: gzip header

setAllowDeflate

public void setAllowDeflate(boolean allow)

Sets whether the HTTP request will include a Accept-Encoding: deflate header

setBasicAuthentication

public void setBasicAuthentication(String user,
                          char[] password)

Sets basic authentication

Parameters:

user - Username

password - Password

usesPOST

public boolean usesPOST()

Return whether this request will go by GET or POST

Returns:

boolean

setForcePOST

public void setForcePOST()

Force the use of HTTP POST for the query operation

setConnectTimeout

public void setConnectTimeout(int timeout)

Sets HTTP Connection timeout, any value <= 0 is taken to mean no timeout

getConnectTimeout

public int getConnectTimeout()

Gets the HTTP Connection timeout

setReadTimeout

public void setReadTimeout(int timeout)

Sets HTTP Read timeout, any value <= 0 is taken to mean no timeout

getReadTimeout

public int getReadTimeout()

Gets the HTTP Read timeout

exec

public InputStream exec()
                 throws QueryExceptionHTTP

Execute the operation

Returns:

Model The resulting model

Throws:

QueryExceptionHTTP

toString

public String toString()

Overrides:

toString in class Object