Class QueryServlet

java.lang.Object

org.eclipse.rdf4j.workbench.base.AbstractServlet

org.eclipse.rdf4j.workbench.base.AbstractRepositoryServlet

org.eclipse.rdf4j.workbench.base.TransformationServlet

org.eclipse.rdf4j.workbench.commands.QueryServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, RepositoryServlet

public class QueryServlet
extends TransformationServlet

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	LIMIT
protected static final String	QUERY
protected static final String	REF
protected boolean	writeQueryCookie

Fields inherited from class TransformationServlet

CONTEXT, cookies, INFO, NON_VERIFYING_PARSER_CONFIG

Modifier and Type	Field	Description
static final String	CONTEXT
protected CookieHandler	cookies
protected static final String	INFO
protected static final ParserConfig	NON_VERIFYING_PARSER_CONFIG

Fields inherited from class AbstractRepositoryServlet

info, manager, MANAGER_PARAM, repository, REPOSITORY_PARAM, vf

Modifier and Type	Field	Description
protected RepositoryInfo	info
protected RepositoryManager	manager
static final String	MANAGER_PARAM
protected Repository	repository
static final String	REPOSITORY_PARAM
protected ValueFactory	vf

Fields inherited from class AbstractServlet

appConfig, APPLICATION_JAVASCRIPT, APPLICATION_SPARQL_RESULTS_XML, APPLICATION_XML, config, DEFAULT_JSONP_CALLBACK_PARAMETER, JSONP_CALLBACK_PARAMETER, JSONP_ENABLED, JSONP_VALIDATOR, log, MOZILLA, MSIE, SERVER_PASSWORD, SERVER_USER, SERVER_USER_PASSWORD, TEXT_HTML, TEXT_PLAIN, USER_AGENT

Modifier and Type	Field	Description
protected AppConfiguration	appConfig
protected static final String	APPLICATION_JAVASCRIPT	This response content type is always used for JSONP results.
protected static final String	APPLICATION_SPARQL_RESULTS_XML	This response content type is used for SPARQL Results XML results in non-browser user agents or other cases where application/xml is not specifically requested.
protected static final String	APPLICATION_XML	This response content type is used in cases where application/xml is explicitly requested, or in cases where the user agent is known to be a commonly available browser.
protected jakarta.servlet.ServletConfig	config
protected static final String	DEFAULT_JSONP_CALLBACK_PARAMETER	This query parameter is only used in cases where the configuration property is not setup explicitly.
protected static final String	JSONP_CALLBACK_PARAMETER
protected static final String	JSONP_ENABLED	JSONP property for enabling/disabling jsonp functionality.
protected static final Pattern	JSONP_VALIDATOR
protected final org.slf4j.Logger	log
protected static final String	MOZILLA
protected static final String	MSIE
protected static final String	SERVER_PASSWORD	Deprecated.
protected static final String	SERVER_USER	Deprecated.
protected static final String	SERVER_USER_PASSWORD
protected static final String	TEXT_HTML
protected static final String	TEXT_PLAIN
protected static final String	USER_AGENT

Constructor Summary

Constructors

Constructor	Description
QueryServlet()

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	doPost(WorkbenchRequest req, jakarta.servlet.http.HttpServletResponse resp, String xslPath)
String[]	getCookieNames()
String[]	getCookieNames(WorkbenchRequest req)
protected String	getQueryText(WorkbenchRequest req)
void	init(jakarta.servlet.ServletConfig config)	Initialize this instance of the servlet.
final void	service(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)	Long query strings could blow past the Tomcat default 8k HTTP header limit if stuffed into a cookie.
protected void	service(WorkbenchRequest req, jakarta.servlet.http.HttpServletResponse resp, String xslPath)
protected boolean	shouldWriteQueryCookie(String queryText)	Determines if the servlet should write out the query text into a cookie as received, or write it's hash instead.
protected void	substituteAsyncExplainCoordinator(AsyncExplainCoordinator asyncExplainCoordinator)
protected static void	substituteQueryCache(Map<String,String> testQueryCache)	For testing purposes only.
protected void	substituteQueryStorage(QueryStorage storage)

Methods inherited from class TransformationServlet

service

Modifier and Type	Method	Description
protected void	service(TupleResultBuilder writer, String xslPath)

Methods inherited from class AbstractRepositoryServlet

setRepository, setRepositoryInfo, setRepositoryManager

Modifier and Type	Method	Description
void	setRepository(Repository repository)
void	setRepositoryInfo(RepositoryInfo info)
void	setRepositoryManager(RepositoryManager manager)

Methods inherited from class AbstractServlet

checkJSONP, getBooleanResultFormat, getJSONPResultFormat, getResultWriter, getServletConfig, getServletInfo, getTupleResultBuilder, getTupleResultFormat, service

Modifier and Type	Method	Description
protected QueryResultWriter	checkJSONP(jakarta.servlet.http.HttpServletRequest req, OutputStream outputStream)
protected QueryResultFormat	getBooleanResultFormat(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.ServletResponse resp)
protected QueryResultFormat	getJSONPResultFormat(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.ServletResponse resp)
protected QueryResultWriter	getResultWriter(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.ServletResponse resp, OutputStream outputStream)
jakarta.servlet.ServletConfig	getServletConfig()
String	getServletInfo()
protected TupleResultBuilder	getTupleResultBuilder(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, OutputStream outputStream)	Gets a TupleResultBuilder based on the Accept header, and sets the result content type to the best available match for that, returning a builder that can be used to write out the results.
protected QueryResultFormat	getTupleResultFormat(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.ServletResponse resp)
final void	service(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse resp)

Methods inherited from class Object

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

Field Details

REF

protected static final String REF

See Also:

• Constant Field Values

LIMIT

protected static final String LIMIT

See Also:

• Constant Field Values

QUERY

protected static final String QUERY

See Also:

• Constant Field Values

writeQueryCookie

protected boolean writeQueryCookie

Constructor Details

QueryServlet

public QueryServlet()

Method Details

substituteQueryCache

protected static void substituteQueryCache(Map<String,String> testQueryCache)

For testing purposes only.

Parameters:

testQueryCache - cache to use instead of the production cache instance

substituteQueryStorage

protected void substituteQueryStorage(QueryStorage storage)

substituteAsyncExplainCoordinator

protected void substituteAsyncExplainCoordinator(AsyncExplainCoordinator asyncExplainCoordinator)

getCookieNames

public String[] getCookieNames()

Overrides:

getCookieNames in class TransformationServlet

Returns:

the names of the cookies that will be retrieved from the request, and returned in the response

getCookieNames

public String[] getCookieNames(WorkbenchRequest req)

Overrides:

getCookieNames in class TransformationServlet

init

public void init(jakarta.servlet.ServletConfig config)
          throws jakarta.servlet.ServletException

Initialize this instance of the servlet.

Specified by:

init in interface jakarta.servlet.Servlet

Overrides:

init in class TransformationServlet

Parameters:

config - configuration passed in by the application container

Throws:

jakarta.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Servlet

Overrides:

destroy in class AbstractServlet

service

public final void service(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse resp)
                   throws jakarta.servlet.ServletException,
IOException

Long query strings could blow past the Tomcat default 8k HTTP header limit if stuffed into a cookie. In this case, we need to set a flag to avoid this happening before TransformationServlet.service(HttpServletRequest, HttpServletResponse) is called. A much lower limit on the size of the query text is used to stay well below the Tomcat limitation.

Overrides:

service in class TransformationServlet

Throws:

jakarta.servlet.ServletException

IOException

shouldWriteQueryCookie

protected boolean shouldWriteQueryCookie(String queryText)

Determines if the servlet should write out the query text into a cookie as received, or write it's hash instead.

Note: This is a separate method for testing purposes.

Parameters:

queryText - the text received as the value for the parameter 'query'

service

protected void service(WorkbenchRequest req,
 jakarta.servlet.http.HttpServletResponse resp,
 String xslPath)
                throws IOException,
RDF4JException,
BadRequestException

Overrides:

service in class TransformationServlet

Throws:

IOException

RDF4JException

BadRequestException

doPost

protected void doPost(WorkbenchRequest req,
 jakarta.servlet.http.HttpServletResponse resp,
 String xslPath)
               throws IOException,
BadRequestException,
RDF4JException

Overrides:

doPost in class TransformationServlet

Throws:

IOException

BadRequestException

RDF4JException

getQueryText

protected String getQueryText(WorkbenchRequest req)
                       throws BadRequestException,
RDF4JException

Parameters:

req - for looking at the request parameters

Returns:

the query text, if it can somehow be retrieved from request parameters, otherwise an empty string

Throws:

BadRequestException - if a problem occurs grabbing the request from storage

RDF4JException - if a problem occurs grabbing the request from storage