com.atomgraph.server.model.impl

Class ResourceBase

java.lang.Object

com.atomgraph.core.model.impl.ResourceBase

com.atomgraph.core.model.impl.QueriedResourceBase

com.atomgraph.server.model.impl.ResourceBase

All Implemented Interfaces:

com.atomgraph.core.model.QueriedResource, com.atomgraph.core.model.Resource

Direct Known Subclasses:

Item

public class ResourceBase
extends com.atomgraph.core.model.impl.QueriedResourceBase
implements Resource, QueriedResource

Base class of generic read-write Linked Data resources. Configured declaratively using sitemap ontology to provide Linked Data layer over a SPARQL endpoint. Supports pagination on containers (implemented using SPARQL query solution modifiers).

Author:

Martynas Jusevičius <martynas@atomgraph.com>

See Also:

OntResource, 15 Solution Sequences and Modifiers

Constructor Summary

Constructors

Modifier	Constructor and Description
	ResourceBase(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, com.atomgraph.core.MediaTypes mediaTypes, com.atomgraph.core.model.Service service, Application application, org.apache.jena.ontology.Ontology ontology, TemplateCall templateCall, javax.ws.rs.core.HttpHeaders httpHeaders, com.sun.jersey.api.core.ResourceContext resourceContext) Public JAX-RS instance.
protected	ResourceBase(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, com.atomgraph.core.MediaTypes mediaTypes, URI uri, com.atomgraph.core.model.Service service, Application application, org.apache.jena.ontology.Ontology ontology, TemplateCall templateCall, javax.ws.rs.core.HttpHeaders httpHeaders, com.sun.jersey.api.core.ResourceContext resourceContext)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete() Handles DELETE method, deletes the RDF representation of this resource from the application's dataset, and returns response.
Application	getApplication()
javax.ws.rs.core.CacheControl	getCacheControl() Returns the cache control of this resource, if specified.
javax.ws.rs.core.HttpHeaders	getHttpHeaders() Returns HTTP headers of the current request.
List<Locale>	getLanguages() Content languages supported by the matching LDT template.
org.apache.jena.ontology.Ontology	getOntology()
org.apache.jena.ontology.OntResource	getOntResource() Returns this resource as ontology resource.
org.apache.jena.query.Query	getQuery() Returns query used to retrieve RDF description of this resource.
org.apache.jena.query.QuerySolutionMap	getQuerySolutionMap() Returns variable bindings for description query.
com.sun.jersey.api.core.ResourceContext	getResourceContext()
javax.ws.rs.core.Response.ResponseBuilder	getResponseBuilder(org.apache.jena.query.Dataset dataset) Creates response builder from response dataset.
javax.ws.rs.core.Response.ResponseBuilder	getResponseBuilder(org.apache.jena.rdf.model.Model model) Creates response builder from response model.
Object	getSubResource() Returns sub-resource instance.
TemplateCall	getTemplateCall() Returns LDT template that the URI of this resource matches.
org.apache.jena.update.UpdateRequest	getUpdate() Returns update used to remove RDF description of this resource.
javax.ws.rs.core.Response	post(org.apache.jena.query.Dataset dataset) Handles POST method.
javax.ws.rs.core.Response	put(org.apache.jena.query.Dataset dataset) Handles PUT method.

Methods inherited from class com.atomgraph.core.model.impl.QueriedResourceBase

describe, get, getQuery, getService

Methods inherited from class com.atomgraph.core.model.impl.ResourceBase

getEncodings, getEntityTag, getEntityTag, getLastModified, getLastModified, getMediaTypes, getRequest, getResponse, getResponse, getURI, getUriInfo, getVariants, getWritableMediaTypes

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atomgraph.core.model.QueriedResource

describe

Constructor Detail

ResourceBase

public ResourceBase(@Context
                    javax.ws.rs.core.UriInfo uriInfo,
                    @Context
                    javax.ws.rs.core.Request request,
                    @Context
                    com.atomgraph.core.MediaTypes mediaTypes,
                    @Context
                    com.atomgraph.core.model.Service service,
                    @Context
                    Application application,
                    @Context
                    org.apache.jena.ontology.Ontology ontology,
                    @Context
                    TemplateCall templateCall,
                    @Context
                    javax.ws.rs.core.HttpHeaders httpHeaders,
                    @Context
                    com.sun.jersey.api.core.ResourceContext resourceContext)

Public JAX-RS instance. Suitable for subclassing. If the request URI does not match any URI template in the sitemap ontology, 404 Not Found is returned. If the matching template extends ldt:Document, this resource becomes a page resource and HATEOS metadata is added (relations to the container and previous/next page resources).

Parameters:

application - LDT application

mediaTypes - mediaTypes

uriInfo - URI information of the current request

request - current request

service - SPARQL service

ontology - LDT ontology

templateCall - templateCall

httpHeaders - HTTP headers of the current request

resourceContext - resource context

ResourceBase

protected ResourceBase(javax.ws.rs.core.UriInfo uriInfo,
                       javax.ws.rs.core.Request request,
                       com.atomgraph.core.MediaTypes mediaTypes,
                       URI uri,
                       com.atomgraph.core.model.Service service,
                       Application application,
                       org.apache.jena.ontology.Ontology ontology,
                       TemplateCall templateCall,
                       javax.ws.rs.core.HttpHeaders httpHeaders,
                       com.sun.jersey.api.core.ResourceContext resourceContext)

Method Detail

getSubResource

public Object getSubResource()

Returns sub-resource instance. By default matches any path.

Overrides:

getSubResource in class com.atomgraph.core.model.impl.QueriedResourceBase

Returns:

resource object

post

public javax.ws.rs.core.Response post(org.apache.jena.query.Dataset dataset)

Handles POST method. Appends the submitted RDF representation to the application's dataset.

Specified by:

post in interface com.atomgraph.core.model.Resource

Overrides:

post in class com.atomgraph.core.model.impl.QueriedResourceBase

Parameters:

dataset - the RDF payload

Returns:

response 200 OK

put

public javax.ws.rs.core.Response put(org.apache.jena.query.Dataset dataset)

Handles PUT method. Deletes the resource description (if any) and appends the submitted RDF representation to the application's dataset.

Specified by:

put in interface com.atomgraph.core.model.Resource

Overrides:

put in class com.atomgraph.core.model.impl.QueriedResourceBase

Parameters:

dataset - RDF payload

Returns:

response 201 Created if resource did not exist, 200 OK if it did

delete

public javax.ws.rs.core.Response delete()

Handles DELETE method, deletes the RDF representation of this resource from the application's dataset, and returns response.

Specified by:

delete in interface com.atomgraph.core.model.Resource

Overrides:

delete in class com.atomgraph.core.model.impl.QueriedResourceBase

Returns:

response 204 No Content

getQuerySolutionMap

public org.apache.jena.query.QuerySolutionMap getQuerySolutionMap()

Returns variable bindings for description query.

Returns:

map with variable bindings

getResponseBuilder

public javax.ws.rs.core.Response.ResponseBuilder getResponseBuilder(org.apache.jena.query.Dataset dataset)

Creates response builder from response dataset. Adds matched sitemap class as affordance metadata in

Link

header.

Overrides:

getResponseBuilder in class com.atomgraph.core.model.impl.ResourceBase

Parameters:

dataset - response RDF dataset

Returns:

response builder

getResponseBuilder

public javax.ws.rs.core.Response.ResponseBuilder getResponseBuilder(org.apache.jena.rdf.model.Model model)

Creates response builder from response model. Adds matched sitemap class as affordance metadata in

Link

header.

Overrides:

getResponseBuilder in class com.atomgraph.core.model.impl.ResourceBase

Parameters:

model - response RDF model

Returns:

response builder

getLanguages

public List<Locale> getLanguages()

Content languages supported by the matching LDT template.

Overrides:

getLanguages in class com.atomgraph.core.model.impl.ResourceBase

Returns:

list of locales

See Also:

Content-Language

getOntResource

public org.apache.jena.ontology.OntResource getOntResource()

Returns this resource as ontology resource.

Returns:

ontology resource

getTemplateCall

public TemplateCall getTemplateCall()

Returns LDT template that the URI of this resource matches. If the request URI did not match any template, 404 Not Found was returned.

Returns:

ontology class

getCacheControl

public javax.ws.rs.core.CacheControl getCacheControl()

Returns the cache control of this resource, if specified. The control value can be specified as ldt:cacheControl on templates in the sitemap ontology.

Returns:

cache control object or null, if not specified

getQuery

public org.apache.jena.query.Query getQuery()

Returns query used to retrieve RDF description of this resource. Query solution bindings are applied by default.

Specified by:

getQuery in interface com.atomgraph.core.model.QueriedResource

Overrides:

getQuery in class com.atomgraph.core.model.impl.QueriedResourceBase

Returns:

query object with applied solution bindings

See Also:

getQuerySolutionMap()

getUpdate

public org.apache.jena.update.UpdateRequest getUpdate()

Returns update used to remove RDF description of this resource. Query solution bindings are applied by default.

Returns:

update object with applied solution bindings

See Also:

getQuerySolutionMap()

getHttpHeaders

public javax.ws.rs.core.HttpHeaders getHttpHeaders()

Returns HTTP headers of the current request.

Returns:

header object

getResourceContext

public com.sun.jersey.api.core.ResourceContext getResourceContext()

getApplication

public Application getApplication()

getOntology

public org.apache.jena.ontology.Ontology getOntology()