org.openrdf.http.client

Class HTTPClient

java.lang.Object

org.openrdf.http.client.HTTPClient

Direct Known Subclasses:

SesameHTTPClient

public class HTTPClient
extends Object

The HTTP client provides low level HTTP methods for the HTTP communication of the SPARQL repository as well as the HTTP Repository. All methods are compliant to the SPARQL 1.1 protocol. For both Tuple and Graph queries there is a variant which parses the result in the background, see BackgroundTupleResult and BackgroundGraphResult. For boolean queries the result is parsed in the current thread. All methods in this class guarantee that HTTP connections are closed properly and returned to the connection pool. Functionality specific to the Sesame HTTP protocol can be found in SesameHTTPClient (which is used by Remote Repositories).

Author:

Herko ter Horst, Arjohn Kampman, Andreas Schwarte

See Also:

SesameHTTPClient

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.httpclient.HttpClient	httpClient

Constructor Summary

Constructors

Constructor and Description
HTTPClient()

Method Summary

Modifier and Type	Method and Description
protected void	execute(Runnable command)
Map<String,String>	getAdditionalHttpHeaders()
protected BackgroundTupleResult	getBackgroundTupleQueryResult(org.apache.commons.httpclient.HttpMethod method) Parse the response in a background thread.
protected boolean	getBoolean(org.apache.commons.httpclient.HttpMethodBase method) Parse the response in this thread using a suitable BooleanQueryResultParser.
long	getConnectionTimeout() Gets the http connection read timeout in milliseconds.
protected ErrorInfo	getErrorInfo(org.apache.commons.httpclient.HttpMethod method)
protected org.apache.commons.httpclient.HttpClient	getHttpClient()
ParserConfig	getParserConfig()
BooleanQueryResultFormat	getPreferredBooleanQueryResultFormat() Gets the preferred BooleanQueryResultFormat for encoding boolean query results.
RDFFormat	getPreferredRDFFormat() Gets the preferred RDFFormat for encoding RDF documents.
TupleQueryResultFormat	getPreferredTupleQueryResultFormat() Gets the preferred TupleQueryResultFormat for encoding tuple query results.
protected org.apache.commons.httpclient.HttpMethodBase	getQueryMethod(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
protected List<org.apache.commons.httpclient.NameValuePair>	getQueryMethodParameters(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
String	getQueryURL()
protected void	getRDF(org.apache.commons.httpclient.HttpMethod method, RDFHandler handler, boolean requireContext) Parse the response in this thread using the provided RDFHandler.
protected BackgroundGraphResult	getRDFBackground(org.apache.commons.httpclient.HttpMethodBase method, boolean requireContext) Parse the response in a background thread.
protected String	getResponseMIMEType(org.apache.commons.httpclient.HttpMethod method) Gets the MIME type specified in the response headers of the supplied method, if any.
protected void	getTupleQueryResult(org.apache.commons.httpclient.HttpMethod method, TupleQueryResultHandler handler) Parse the response in this thread using the provided TupleQueryResultHandler.
protected org.apache.commons.httpclient.HttpMethod	getUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings)
protected List<org.apache.commons.httpclient.NameValuePair>	getUpdateMethodParameters(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings)
String	getUpdateURL()
ValueFactory	getValueFactory()
void	initialize() (re)initializes the connection manager and HttpClient (if not already done), for example after a shutdown has been invoked earlier.
protected boolean	is2xx(int statusCode) Checks whether the specified status code is in the 2xx-range, indicating a successfull request.
protected void	releaseConnection(org.apache.commons.httpclient.HttpMethod method)
boolean	sendBooleanQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, Binding... bindings)
boolean	sendBooleanQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
GraphQueryResult	sendGraphQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, Binding... bindings)
void	sendGraphQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, RDFHandler handler, Binding... bindings)
GraphQueryResult	sendGraphQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
void	sendGraphQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, RDFHandler handler, Binding... bindings)
TupleQueryResult	sendTupleQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, Binding... bindings)
TupleQueryResult	sendTupleQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
void	sendTupleQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, TupleQueryResultHandler handler, Binding... bindings)
void	sendUpdate(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings)
void	setAdditionalHttpHeaders(Map<String,String> additionalHttpHeaders)
void	setConnectionTimeout(long timeout) Sets the http connection read timeout.
protected void	setDoAuthentication(org.apache.commons.httpclient.HttpMethod method)
void	setParserConfig(ParserConfig parserConfig) Sets the parser configuration used to process HTTP response data.
void	setPreferredBooleanQueryResultFormat(BooleanQueryResultFormat format) Sets the preferred format for encoding boolean query results.
void	setPreferredRDFFormat(RDFFormat format) Sets the preferred format for encoding RDF documents.
void	setPreferredTupleQueryResultFormat(TupleQueryResultFormat format) Sets the preferred format for encoding tuple query results.
void	setQueryURL(String queryURL)
void	setUpdateURL(String updateURL)
void	setUsernameAndPassword(String username, String password) Set the username and password for authentication with the remote server.
protected void	setUsernameAndPasswordForUrl(String username, String password, String url)
void	setValueFactory(ValueFactory valueFactory)
void	shutDown()

Methods inherited from class java.lang.Object

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

Field Detail

httpClient

protected org.apache.commons.httpclient.HttpClient httpClient

Constructor Detail

HTTPClient

public HTTPClient()

Method Detail

shutDown

public void shutDown()

initialize

public void initialize()

(re)initializes the connection manager and HttpClient (if not already done), for example after a shutdown has been invoked earlier. Invoking this method multiple times will have no effect.

getHttpClient

protected final org.apache.commons.httpclient.HttpClient getHttpClient()

setValueFactory

public void setValueFactory(ValueFactory valueFactory)

getValueFactory

public ValueFactory getValueFactory()

setQueryURL

public void setQueryURL(String queryURL)

setUpdateURL

public void setUpdateURL(String updateURL)

setPreferredTupleQueryResultFormat

public void setPreferredTupleQueryResultFormat(TupleQueryResultFormat format)

Sets the preferred format for encoding tuple query results. The binary format is preferred by default.

Parameters:

format - The preferred TupleQueryResultFormat, or null to indicate no specific format is preferred.

getPreferredTupleQueryResultFormat

public TupleQueryResultFormat getPreferredTupleQueryResultFormat()

Gets the preferred TupleQueryResultFormat for encoding tuple query results.

Returns:

The preferred format, of null if no specific format is preferred.

setPreferredRDFFormat

public void setPreferredRDFFormat(RDFFormat format)

Sets the preferred format for encoding RDF documents. The Turtle format is preferred by default.

Parameters:

format - The preferred RDFFormat, or null to indicate no specific format is preferred.

getPreferredRDFFormat

public RDFFormat getPreferredRDFFormat()

Gets the preferred RDFFormat for encoding RDF documents.

Returns:

The preferred format, of null if no specific format is preferred.

setPreferredBooleanQueryResultFormat

public void setPreferredBooleanQueryResultFormat(BooleanQueryResultFormat format)

Sets the preferred format for encoding boolean query results. The binary format is preferred by default.

Parameters:

format - The preferred BooleanQueryResultFormat, or null to indicate no specific format is preferred.

getPreferredBooleanQueryResultFormat

public BooleanQueryResultFormat getPreferredBooleanQueryResultFormat()

Gets the preferred BooleanQueryResultFormat for encoding boolean query results.

Returns:

The preferred format, of null if no specific format is preferred.

setUsernameAndPassword

public void setUsernameAndPassword(String username,
                                   String password)

Set the username and password for authentication with the remote server.

Parameters:

username - the username

password - the password

setUsernameAndPasswordForUrl

protected void setUsernameAndPasswordForUrl(String username,
                                            String password,
                                            String url)

setAdditionalHttpHeaders

public void setAdditionalHttpHeaders(Map<String,String> additionalHttpHeaders)

Parameters:

additionalHttpHeaders - The additionalHttpHeaders to set as key value pairs.

getAdditionalHttpHeaders

public Map<String,String> getAdditionalHttpHeaders()

Returns:

Returns the additionalHttpHeaders.

execute

protected void execute(Runnable command)

getQueryURL

public String getQueryURL()

getUpdateURL

public String getUpdateURL()

sendTupleQuery

public TupleQueryResult sendTupleQuery(QueryLanguage ql,
                                       String query,
                                       Dataset dataset,
                                       boolean includeInferred,
                                       Binding... bindings)
                                throws IOException,
                                       RepositoryException,
                                       MalformedQueryException,
                                       UnauthorizedException,
                                       QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendTupleQuery

public TupleQueryResult sendTupleQuery(QueryLanguage ql,
                                       String query,
                                       String baseURI,
                                       Dataset dataset,
                                       boolean includeInferred,
                                       int maxQueryTime,
                                       Binding... bindings)
                                throws IOException,
                                       RepositoryException,
                                       MalformedQueryException,
                                       UnauthorizedException,
                                       QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendTupleQuery

public void sendTupleQuery(QueryLanguage ql,
                           String query,
                           String baseURI,
                           Dataset dataset,
                           boolean includeInferred,
                           int maxQueryTime,
                           TupleQueryResultHandler handler,
                           Binding... bindings)
                    throws IOException,
                           TupleQueryResultHandlerException,
                           RepositoryException,
                           MalformedQueryException,
                           UnauthorizedException,
                           QueryInterruptedException

Throws:

IOException

TupleQueryResultHandlerException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendUpdate

public void sendUpdate(QueryLanguage ql,
                       String update,
                       String baseURI,
                       Dataset dataset,
                       boolean includeInferred,
                       Binding... bindings)
                throws IOException,
                       RepositoryException,
                       MalformedQueryException,
                       UnauthorizedException,
                       QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendGraphQuery

public GraphQueryResult sendGraphQuery(QueryLanguage ql,
                                       String query,
                                       Dataset dataset,
                                       boolean includeInferred,
                                       Binding... bindings)
                                throws IOException,
                                       RepositoryException,
                                       MalformedQueryException,
                                       UnauthorizedException,
                                       QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendGraphQuery

public GraphQueryResult sendGraphQuery(QueryLanguage ql,
                                       String query,
                                       String baseURI,
                                       Dataset dataset,
                                       boolean includeInferred,
                                       int maxQueryTime,
                                       Binding... bindings)
                                throws IOException,
                                       RepositoryException,
                                       MalformedQueryException,
                                       UnauthorizedException,
                                       QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendGraphQuery

public void sendGraphQuery(QueryLanguage ql,
                           String query,
                           Dataset dataset,
                           boolean includeInferred,
                           RDFHandler handler,
                           Binding... bindings)
                    throws IOException,
                           RDFHandlerException,
                           RepositoryException,
                           MalformedQueryException,
                           UnauthorizedException,
                           QueryInterruptedException

Throws:

IOException

RDFHandlerException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendGraphQuery

public void sendGraphQuery(QueryLanguage ql,
                           String query,
                           String baseURI,
                           Dataset dataset,
                           boolean includeInferred,
                           int maxQueryTime,
                           RDFHandler handler,
                           Binding... bindings)
                    throws IOException,
                           RDFHandlerException,
                           RepositoryException,
                           MalformedQueryException,
                           UnauthorizedException,
                           QueryInterruptedException

Throws:

IOException

RDFHandlerException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendBooleanQuery

public boolean sendBooleanQuery(QueryLanguage ql,
                                String query,
                                Dataset dataset,
                                boolean includeInferred,
                                Binding... bindings)
                         throws IOException,
                                RepositoryException,
                                MalformedQueryException,
                                UnauthorizedException,
                                QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

sendBooleanQuery

public boolean sendBooleanQuery(QueryLanguage ql,
                                String query,
                                String baseURI,
                                Dataset dataset,
                                boolean includeInferred,
                                int maxQueryTime,
                                Binding... bindings)
                         throws IOException,
                                RepositoryException,
                                MalformedQueryException,
                                UnauthorizedException,
                                QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

getQueryMethod

protected org.apache.commons.httpclient.HttpMethodBase getQueryMethod(QueryLanguage ql,
                                                                      String query,
                                                                      String baseURI,
                                                                      Dataset dataset,
                                                                      boolean includeInferred,
                                                                      int maxQueryTime,
                                                                      Binding... bindings)

getUpdateMethod

protected org.apache.commons.httpclient.HttpMethod getUpdateMethod(QueryLanguage ql,
                                                                   String update,
                                                                   String baseURI,
                                                                   Dataset dataset,
                                                                   boolean includeInferred,
                                                                   Binding... bindings)

getQueryMethodParameters

protected List<org.apache.commons.httpclient.NameValuePair> getQueryMethodParameters(QueryLanguage ql,
                                                                                     String query,
                                                                                     String baseURI,
                                                                                     Dataset dataset,
                                                                                     boolean includeInferred,
                                                                                     int maxQueryTime,
                                                                                     Binding... bindings)

getUpdateMethodParameters

protected List<org.apache.commons.httpclient.NameValuePair> getUpdateMethodParameters(QueryLanguage ql,
                                                                                      String update,
                                                                                      String baseURI,
                                                                                      Dataset dataset,
                                                                                      boolean includeInferred,
                                                                                      Binding... bindings)

getBackgroundTupleQueryResult

protected BackgroundTupleResult getBackgroundTupleQueryResult(org.apache.commons.httpclient.HttpMethod method)
                                                       throws RepositoryException,
                                                              QueryInterruptedException,
                                                              org.apache.commons.httpclient.HttpException,
                                                              MalformedQueryException,
                                                              IOException

Parse the response in a background thread. HTTP connections are dealt with in the BackgroundTupleResult or (in the error-case) in this method.

Throws:

RepositoryException

QueryInterruptedException

org.apache.commons.httpclient.HttpException

MalformedQueryException

IOException

getTupleQueryResult

protected void getTupleQueryResult(org.apache.commons.httpclient.HttpMethod method,
                                   TupleQueryResultHandler handler)
                            throws IOException,
                                   TupleQueryResultHandlerException,
                                   RepositoryException,
                                   MalformedQueryException,
                                   UnauthorizedException,
                                   QueryInterruptedException

Parse the response in this thread using the provided TupleQueryResultHandler. All HTTP connections are closed and released in this method

Throws:

IOException

TupleQueryResultHandlerException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

getRDFBackground

protected BackgroundGraphResult getRDFBackground(org.apache.commons.httpclient.HttpMethodBase method,
                                                 boolean requireContext)
                                          throws IOException,
                                                 RDFHandlerException,
                                                 RepositoryException,
                                                 MalformedQueryException,
                                                 UnauthorizedException,
                                                 QueryInterruptedException

Parse the response in a background thread. HTTP connections are dealt with in the BackgroundGraphResult or (in the error-case) in this method.

Throws:

IOException

RDFHandlerException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

getRDF

protected void getRDF(org.apache.commons.httpclient.HttpMethod method,
                      RDFHandler handler,
                      boolean requireContext)
               throws IOException,
                      RDFHandlerException,
                      RepositoryException,
                      MalformedQueryException,
                      UnauthorizedException,
                      QueryInterruptedException

Parse the response in this thread using the provided RDFHandler. All HTTP connections are closed and released in this method

Throws:

IOException

RDFHandlerException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

getBoolean

protected boolean getBoolean(org.apache.commons.httpclient.HttpMethodBase method)
                      throws IOException,
                             RepositoryException,
                             MalformedQueryException,
                             UnauthorizedException,
                             QueryInterruptedException

Parse the response in this thread using a suitable BooleanQueryResultParser. All HTTP connections are closed and released in this method

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

is2xx

protected boolean is2xx(int statusCode)

Checks whether the specified status code is in the 2xx-range, indicating a successfull request.

Returns:

true if the status code is in the 2xx range.

getResponseMIMEType

protected String getResponseMIMEType(org.apache.commons.httpclient.HttpMethod method)
                              throws IOException

Gets the MIME type specified in the response headers of the supplied method, if any. For example, if the response headers contain Content-Type: application/xml;charset=UTF-8, this method will return application/xml as the MIME type.

Parameters:

method - The method to get the reponse MIME type from.

Returns:

The response MIME type, or null if not available.

Throws:

IOException

getErrorInfo

protected ErrorInfo getErrorInfo(org.apache.commons.httpclient.HttpMethod method)
                          throws RepositoryException

Throws:

RepositoryException

setDoAuthentication

protected final void setDoAuthentication(org.apache.commons.httpclient.HttpMethod method)

releaseConnection

protected final void releaseConnection(org.apache.commons.httpclient.HttpMethod method)

setParserConfig

public void setParserConfig(ParserConfig parserConfig)

Sets the parser configuration used to process HTTP response data.

Parameters:

parserConfig - The parserConfig to set.

getParserConfig

public ParserConfig getParserConfig()

Returns:

Returns the parser configuration used to process HTTP response data.

getConnectionTimeout

public long getConnectionTimeout()

Gets the http connection read timeout in milliseconds.

setConnectionTimeout

public void setConnectionTimeout(long timeout)

Sets the http connection read timeout.

Parameters:

timeout - timeout in milliseconds. Zero sets to infinity.