Class WorkbenchGateway

java.lang.Object

org.eclipse.rdf4j.workbench.base.AbstractServlet

org.eclipse.rdf4j.workbench.proxy.WorkbenchGateway

All Implemented Interfaces:

jakarta.servlet.Servlet

public class WorkbenchGateway
extends AbstractServlet

All requests are serviced by this Servlet, though it usually delegates to other Servlets.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	TRANSFORMATIONS

Fields inherited from class AbstractServlet

ACCEPT, 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 static final String	ACCEPT
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
WorkbenchGateway()

Method Summary

Modifier and Type	Method	Description
protected CookieHandler	createCookieHandler(jakarta.servlet.ServletConfig config)
protected org.eclipse.rdf4j.workbench.proxy.ServerValidator	createServerValidator(jakarta.servlet.ServletConfig config)
protected WorkbenchServlet	createWorkbenchServlet()
protected jakarta.servlet.ServletConfig	createWorkbenchServletConfig(String server, Map<String,String> params)
void	destroy()
String	getChangeServerPath()
String	getDefaultServerPath()	Returns the value of the default-server configuration variable.
void	init(jakarta.servlet.ServletConfig config)
boolean	isServerFixed()	Whether the server path is fixed, which is when the change-server-path configuration value is not set.
void	service(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)

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

TRANSFORMATIONS

protected static final String TRANSFORMATIONS

See Also:

• Constant Field Values

Constructor Details

WorkbenchGateway

public WorkbenchGateway()

Method Details

init

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

Specified by:

init in interface jakarta.servlet.Servlet

Overrides:

init in class AbstractServlet

Throws:

jakarta.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Servlet

Overrides:

destroy in class AbstractServlet

getChangeServerPath

public String getChangeServerPath()

getDefaultServerPath

public String getDefaultServerPath()

Returns the value of the default-server configuration variable. Often, this is simply a relative path on the same HTTP server.

Returns:

the path to the default Sesame server instance

isServerFixed

public boolean isServerFixed()

Whether the server path is fixed, which is when the change-server-path configuration value is not set.

Returns:

true, if the change-server-path configuration variable is not set, meaning that changing the server is blocked

service

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

Overrides:

service in class AbstractServlet

Throws:

jakarta.servlet.ServletException

IOException

createCookieHandler

protected CookieHandler createCookieHandler(jakarta.servlet.ServletConfig config)

createServerValidator

protected org.eclipse.rdf4j.workbench.proxy.ServerValidator createServerValidator(jakarta.servlet.ServletConfig config)

createWorkbenchServlet

protected WorkbenchServlet createWorkbenchServlet()

createWorkbenchServletConfig

protected jakarta.servlet.ServletConfig createWorkbenchServletConfig(String server,
 Map<String,String> params)