org.apache.marmotta.platform.sparql.webservices

Class SparqlWebService

java.lang.Object

org.apache.marmotta.platform.sparql.webservices.SparqlWebService

@ApplicationScoped
@Path(value="/sparql")
public class SparqlWebService
extends Object

Execute SPARQL query (both query and update) on the LMF triple store according the SPARQL 1.1 Protocol

Author:

Sebastian Schaffert, Sergio Fernández

See Also:

http://www.w3.org/TR/sparql11-protocol/, http://www.w3.org/TR/sparql11-service-description/

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH
static String	SELECT
static String	UPDATE

Constructor Summary

Constructors

Constructor and Description
SparqlWebService()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get(String query, String update, javax.servlet.http.HttpServletRequest request) Single SPARQL endpoint, redirecting to the actual select endpoint when possible
javax.ws.rs.core.Response	post(javax.servlet.http.HttpServletRequest request) Single endpoint for direct post queries (not yet implemented)
javax.ws.rs.core.Response	selectGet(String query, String resultType, javax.servlet.http.HttpServletRequest request) Execute a SPARQL 1.1 tuple query on the LMF triple store using the query passed as query parameter to the GET request.
javax.ws.rs.core.Response	selectPost(String resultType, javax.servlet.http.HttpServletRequest request) Execute a SPARQL 1.1 tuple query on the LMF triple store using the query passed in the body of the POST request.
javax.ws.rs.core.Response	selectPostForm(String query, String resultType, javax.servlet.http.HttpServletRequest request) Execute a SPARQL 1.1 tuple query on the LMF triple store using the query passed as form parameter to the POST request.
javax.ws.rs.core.Response	updateGet(String update, String query, String resultType, javax.servlet.http.HttpServletRequest request) Execute a SPARQL 1.1 Update request passed in the query parameter of the GET.
javax.ws.rs.core.Response	updatePostDirectly(javax.servlet.http.HttpServletRequest request, String resultType) Execute a SPARQL 1.1 Update request using update via POST directly; see details at http://www.w3.org/TR/sparql11-protocol/\#update-operation
javax.ws.rs.core.Response	updatePostUrlEncoded(javax.servlet.http.HttpServletRequest request) Execute a SPARQL 1.1 Update request using update via URL-encoded POST; see details at http://www.w3.org/TR/sparql11-protocol/\#update-operation

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

SELECT

public static final String SELECT

See Also:

Constant Field Values

UPDATE

public static final String UPDATE

See Also:

Constant Field Values

Constructor Detail

SparqlWebService

public SparqlWebService()

Method Detail

get

@GET
public javax.ws.rs.core.Response get(@QueryParam(value="query")
                                String query,
                                @QueryParam(value="update")
                                String update,
                                @Context
                                javax.servlet.http.HttpServletRequest request)
                              throws URISyntaxException

Single SPARQL endpoint, redirecting to the actual select endpoint when possible

Parameters:

query -

update -

request -

Returns:

Throws:

URISyntaxException

post

@POST
public javax.ws.rs.core.Response post(@Context
                                  javax.servlet.http.HttpServletRequest request)

Single endpoint for direct post queries (not yet implemented)

Parameters:

request -

Returns:

selectGet

@GET
@Path(value="/select")
public javax.ws.rs.core.Response selectGet(@QueryParam(value="query")
                                           String query,
                                           @QueryParam(value="output")
                                           String resultType,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)

Execute a SPARQL 1.1 tuple query on the LMF triple store using the query passed as query parameter to the GET request. Result will be formatted using the result type passed as argument (either "html", "json" or "xml").

see SPARQL 1.1 Query syntax at http://www.w3.org/TR/sparql11-query/

Parameters:

query - the SPARQL 1.1 Query as a string parameter

resultType - the format for serializing the query results ("html", "json", or "xml")

Returns:

the query result in the format passed as argument

HTTP Status Codes

200 in case the query was executed successfully, 500 in case there was an error during the query evaluation

selectPostForm

@POST
@Consumes(value={"application/x-www-url-form-urlencoded","application/x-www-form-urlencoded"})
@Path(value="/select")
public javax.ws.rs.core.Response selectPostForm(@FormParam(value="query")
                                                          String query,
                                                          @QueryParam(value="output")
                                                          String resultType,
                                                          @Context
                                                          javax.servlet.http.HttpServletRequest request)

Execute a SPARQL 1.1 tuple query on the LMF triple store using the query passed as form parameter to the POST request. Result will be formatted using the result type passed as argument (either "html", "json" or "xml").

see SPARQL 1.1 Query syntax at http://www.w3.org/TR/sparql11-query/

Parameters:

query - the SPARQL 1.1 Query as a string parameter

resultType - the format for serializing the query results ("html", "json", or "xml")

Returns:

the query result in the format passed as argument

HTTP Status Codes

200 in case the query was executed successfully, 500 in case there was an error during the query evaluation

selectPost

@POST
@Path(value="/select")
public javax.ws.rs.core.Response selectPost(@QueryParam(value="output")
                                             String resultType,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request)

Execute a SPARQL 1.1 tuple query on the LMF triple store using the query passed in the body of the POST request. Result will be formatted using the result type passed as argument (either "html", "json" or "xml").

see SPARQL 1.1 Query syntax at http://www.w3.org/TR/sparql11-query/

Parameters:

request - the servlet request (to retrieve the SPARQL 1.1 Query passed in the body of the POST request)

resultType - the format for serializing the query results ("html", "json", or "xml")

Returns:

the query result in the format passed as argument

HTTP Status Codes

200 in case the query was executed successfully, 500 in case there was an error during the query evaluation

updateGet

@GET
@Path(value="/update")
public javax.ws.rs.core.Response updateGet(@QueryParam(value="update")
                                           String update,
                                           @QueryParam(value="query")
                                           String query,
                                           @QueryParam(value="output")
                                           String resultType,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)

Execute a SPARQL 1.1 Update request passed in the query parameter of the GET. The update will be carried out on the LMF triple store.

see SPARQL 1.1 Update syntax at http://www.w3.org/TR/sparql11-update/

Parameters:

update - the update query in SPARQL 1.1 syntax

query - the update query in SPARUL syntax

Returns:

empty content in case the update was successful, the error message in case an error occurred

HTTP Status Codes

200 in case the update was carried out successfully, 500 in case the update was not successful

updatePostDirectly

@POST
@Path(value="/update")
@Consumes(value="application/sparql-update")
public javax.ws.rs.core.Response updatePostDirectly(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              @QueryParam(value="output")
                                                              String resultType)

Execute a SPARQL 1.1 Update request using update via POST directly; see details at http://www.w3.org/TR/sparql11-protocol/\#update-operation

Parameters:

request - the servlet request (to retrieve the SPARQL 1.1 Update query passed in the body of the POST request)

Returns:

empty content in case the update was successful, the error message in case an error occurred

HTTP Status Codes

200 in case the update was carried out successfully, 400 in case the update query is missing or invalid, 500 in case the update was not successful

updatePostUrlEncoded

@POST
@Path(value="/update")
@Consumes(value={"application/x-www-url-form-urlencoded","application/x-www-form-urlencoded"})
public javax.ws.rs.core.Response updatePostUrlEncoded(@Context
                                                                javax.servlet.http.HttpServletRequest request)

Execute a SPARQL 1.1 Update request using update via URL-encoded POST; see details at http://www.w3.org/TR/sparql11-protocol/\#update-operation

Parameters:

request - the servlet request (to retrieve the SPARQL 1.1 Update query passed in the body of the POST request)

Returns:

empty content in case the update was successful, the error message in case an error occurred

HTTP Status Codes

200 in case the update was carried out successfully, 400 in case the update query is missing or invalid, 500 in case the update was not successful