org.eclipse.lyo.ldp.server.jena

Class JenaLDPContainer

java.lang.Object

org.eclipse.lyo.ldp.server.LDPResource

org.eclipse.lyo.ldp.server.LDPRDFSource

org.eclipse.lyo.ldp.server.jena.JenaLDPRDFSource

org.eclipse.lyo.ldp.server.jena.JenaLDPContainer

All Implemented Interfaces:

ILDPContainer, ILDPRDFSource, ILDPResource

Direct Known Subclasses:

JenaLDPBasicContainer, JenaLDPDirectContainer

public class JenaLDPContainer
extends JenaLDPRDFSource
implements ILDPContainer

This class implements a Linked Data Profile Container (LDP-C) using an RDF Graph Store. The LDP specification can be found at www.w3.org/2012/ldp/hg/ldp.html.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RESOURCE_PREFIX
protected String	fResourceURIPrefix

Fields inherited from class org.eclipse.lyo.ldp.server.jena.JenaLDPRDFSource

CONSTRAINTS_URI, fConfigGraphURI, fGraphStore

Fields inherited from class org.eclipse.lyo.ldp.server.LDPResource

fModel, fRDFType, fURI

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JenaLDPContainer(String containerURI, TDBGraphStore graphStore)

Method Summary

Modifier and Type	Method and Description
protected void	addToContainer(String resourceURI, org.apache.jena.rdf.model.Model resourceModel, Calendar time) Adds containment triples and, if a direct container, membership triples for this resource.
protected void	amendResponse(javax.ws.rs.core.Response.ResponseBuilder response, javax.ws.rs.core.MultivaluedMap<String,String> preferences)
protected org.apache.jena.rdf.model.Model	amendResponseGraph(org.apache.jena.rdf.model.Model container, javax.ws.rs.core.MultivaluedMap<String,String> preferences) For sub-classes to implement, given the graph for resource R, amend some triples before response set to client
static String	appendURISegment(String base, String append)
static JenaLDPContainer	create(String containerURI, TDBGraphStore graphStore) Create a LDPContainer instance for the specified URI and with the default configuration parameters}.
protected String	createResource(String resourceURI, boolean addToContainer, InputStream stream, String contentType, String user) Create resource and add membership triples
void	delete() Delete the specified member resource and remove it from the container.
Set<String>	getAllowedMethods() Returns the allowed HTTP methods for this resource as defined in RFC 2616.
static org.apache.jena.rdf.model.Property	getIsMemberOfRelation(org.apache.jena.rdf.model.Model containerGraph, org.apache.jena.rdf.model.Resource containerResource)
static org.apache.jena.rdf.model.Property	getMemberRelation(org.apache.jena.rdf.model.Model containerGraph, org.apache.jena.rdf.model.Resource containerResource)
static String	getMembershipResourceURI(org.apache.jena.rdf.model.Model containerGraph, org.apache.jena.rdf.model.Resource containerResource)
protected Set<String>	getReadOnlyProperties()
protected boolean	includeContainment(javax.ws.rs.core.MultivaluedMap<String,String> preferences)
protected boolean	isReturnRepresentationPreferenceApplied(javax.ws.rs.core.MultivaluedMap<String,String> preferences)
void	patch(String resourceURI, InputStream stream, String contentType, String user)
protected void	patchResource(String resourceURI, String baseURI, InputStream stream, String contentType, String user)
String	post(InputStream stream, String contentType, String user, String nameHint, boolean isResourceInteractionModel) Post a new member to the container.
javax.ws.rs.core.Response	postNonRDFSource(InputStream content, String stripCharset, String user, String slug) Post a new LDP-NR (non-RDF source) to the container.
boolean	putCreate(String resourceURI, InputStream stream, String contentType, String user, javax.ws.rs.core.HttpHeaders requestHeaders) Creates a new resource at resourceURI with the contents of the specified stream.
void	query(OutputStream outStream, String queryString, String resultsFormat) Execute the specified SPARQL query over the container and its entries, specifying the output format.
void	setConfigParameters()

Methods inherited from class org.eclipse.lyo.ldp.server.jena.JenaLDPRDFSource

build, buildErrorResponse, buildErrorResponse, checkIfMatch, fail, failIfReadOnlyPropertyChanged, failParsingRDF, failReadOnlyProperty, get, getConfigModel, getContainerURIForResource, getETag, getGraphStore, isJSONLDPresent, options, putUpdate, readModel, updateResource

Methods inherited from class org.eclipse.lyo.ldp.server.LDPResource

getModel, getTypeURI, getURI, setModel, setURI

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.lyo.ldp.server.ILDPResource

get, getModel, getTypeURI, getURI, options, putUpdate, setModel, setURI

Field Detail

DEFAULT_RESOURCE_PREFIX

public static final String DEFAULT_RESOURCE_PREFIX

See Also:

Constant Field Values

fResourceURIPrefix

protected String fResourceURIPrefix

Constructor Detail

JenaLDPContainer

protected JenaLDPContainer(String containerURI,
                           TDBGraphStore graphStore)

Method Detail

create

public static JenaLDPContainer create(String containerURI,
                                      TDBGraphStore graphStore)

Create a LDPContainer instance for the specified URI and with the default configuration parameters}.

See Also:

#LDPContainer(String, String, GraphStore, GraphStore, InputStream)

setConfigParameters

public void setConfigParameters()

query

public void query(OutputStream outStream,
                  String queryString,
                  String resultsFormat)

Description copied from interface: ILDPContainer

Execute the specified SPARQL query over the container and its entries, specifying the output format. Supported formats are "application/sparql-results+xml" and "application/sparql-results+json".

Specified by:

query in interface ILDPContainer

Parameters:

outStream - the output stream in which to write the query result.

queryString - the SPARQL query to execute.

resultsFormat - the desired result format content type ; if null or not supported, the format will be XML.

post

public String post(InputStream stream,
                   String contentType,
                   String user,
                   String nameHint,
                   boolean isResourceInteractionModel)

Description copied from interface: ILDPContainer

Post a new member to the container.

The Content-Type of the input stream is specified by the contentType argument. Supported values are "application/rdf+xml", "text/turtle", and "application/x-turtle".

Specified by:

post in interface ILDPContainer

Parameters:

stream - the input stream containing the posted resource representation.

contentType - the Content-Type of the input stream.

user - The user URI to use for dcterms:creator

nameHint - Value from Slug header or other source, used to determine the newly created resource's URL

isResourceInteractionModel - If true, treat container as resource (don't allow POST)

Returns:

the new resource URI

putCreate

public boolean putCreate(String resourceURI,
                         InputStream stream,
                         String contentType,
                         String user,
                         javax.ws.rs.core.HttpHeaders requestHeaders)

Description copied from interface: ILDPContainer

Creates a new resource at resourceURI with the contents of the specified stream.

The Content-Type of the input stream is specified by the contentType argument.

Specified by:

putCreate in interface ILDPContainer

Parameters:

resourceURI - the URI of to-be-created resource.

stream - the input stream containing the resource representation.

contentType - the Content-Type of the input stream.

requestHeaders - the HTTP request headers

Returns:

true if a new resource was created or false if the resource already existed

patch

public void patch(String resourceURI,
                  InputStream stream,
                  String contentType,
                  String user)

Specified by:

patch in interface ILDPResource

Overrides:

patch in class JenaLDPRDFSource

createResource

protected String createResource(String resourceURI,
                                boolean addToContainer,
                                InputStream stream,
                                String contentType,
                                String user)

Create resource and add membership triples

Parameters:

resourceURI - The NEW resource being added (including any query params, etc)

addToContainer - If true, will add membership and containment triples

stream - Bytes from the request

contentType - Suggested type of the stream (turtle, rdf/xml, json, ...)

user - dcterms:creator name

Returns:

addToContainer

protected void addToContainer(String resourceURI,
                              org.apache.jena.rdf.model.Model resourceModel,
                              Calendar time)

Adds containment triples and, if a direct container, membership triples for this resource.

Parameters:

resourceURI - the URI of the resource to add

resourceModel - the RDF content or null for non-RDF source (needed for the ldp:isMemberOfRelation)

time - the current time (for dcterms:modified properties)

patchResource

protected void patchResource(String resourceURI,
                             String baseURI,
                             InputStream stream,
                             String contentType,
                             String user)

delete

public void delete()

Description copied from interface: ILDPResource

Delete the specified member resource and remove it from the container.

Specified by:

delete in interface ILDPResource

Overrides:

delete in class JenaLDPRDFSource

amendResponseGraph

protected org.apache.jena.rdf.model.Model amendResponseGraph(org.apache.jena.rdf.model.Model container,
                                                             javax.ws.rs.core.MultivaluedMap<String,String> preferences)

Description copied from class: JenaLDPRDFSource

For sub-classes to implement, given the graph for resource R, amend some triples before response set to client

Overrides:

amendResponseGraph in class JenaLDPRDFSource

Returns:

the amended model

isReturnRepresentationPreferenceApplied

protected boolean isReturnRepresentationPreferenceApplied(javax.ws.rs.core.MultivaluedMap<String,String> preferences)

amendResponse

protected void amendResponse(javax.ws.rs.core.Response.ResponseBuilder response,
                             javax.ws.rs.core.MultivaluedMap<String,String> preferences)

Overrides:

amendResponse in class JenaLDPRDFSource

getMemberRelation

public static org.apache.jena.rdf.model.Property getMemberRelation(org.apache.jena.rdf.model.Model containerGraph,
                                                                   org.apache.jena.rdf.model.Resource containerResource)

getIsMemberOfRelation

public static org.apache.jena.rdf.model.Property getIsMemberOfRelation(org.apache.jena.rdf.model.Model containerGraph,
                                                                       org.apache.jena.rdf.model.Resource containerResource)

getMembershipResourceURI

public static String getMembershipResourceURI(org.apache.jena.rdf.model.Model containerGraph,
                                              org.apache.jena.rdf.model.Resource containerResource)

appendURISegment

public static String appendURISegment(String base,
                                      String append)

getAllowedMethods

public Set<String> getAllowedMethods()

Description copied from interface: ILDPResource

Returns the allowed HTTP methods for this resource as defined in RFC 2616.

Specified by:

getAllowedMethods in interface ILDPResource

Overrides:

getAllowedMethods in class JenaLDPRDFSource

Returns:

the allowed HTTP methods, a set of strings

See Also:

RFC 2616

getReadOnlyProperties

protected Set<String> getReadOnlyProperties()

Overrides:

getReadOnlyProperties in class JenaLDPRDFSource

postNonRDFSource

public javax.ws.rs.core.Response postNonRDFSource(InputStream content,
                                                  String stripCharset,
                                                  String user,
                                                  String slug)

Description copied from interface: ILDPContainer

Post a new LDP-NR (non-RDF source) to the container.

Specified by:

postNonRDFSource in interface ILDPContainer

Returns:

the new resource URI

includeContainment

protected boolean includeContainment(javax.ws.rs.core.MultivaluedMap<String,String> preferences)