org.apache.marmotta.platform.ldp.webservices

Class LdpWebService

java.lang.Object

org.apache.marmotta.platform.ldp.webservices.LdpWebService

@ApplicationScoped
@Path(value="/ldp{local:.*}")
public class LdpWebService
extends Object

Linked Data Platform web services.

Author:

Sergio Fernández, Jakob Frank

See Also:

http://www.w3.org/TR/ldp/

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_ACCEPT_PATCH
static String	HTTP_HEADER_ACCEPT_POST
static String	HTTP_HEADER_PREFER
static String	HTTP_HEADER_PREFERENCE_APPLIED
static String	HTTP_HEADER_SLUG
static String	HTTP_METHOD_PATCH
static String	LDP_SERVER_CONSTRAINTS
static String	LINK_PARAM_ANCHOR
static String	LINK_REL_CONSTRAINEDBY
static String	LINK_REL_CONTENT
static String	LINK_REL_DESCRIBEDBY
static String	LINK_REL_META
static String	LINK_REL_TYPE
static String	PATH

Constructor Summary

Constructors

Constructor and Description
LdpWebService()

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response.ResponseBuilder	createResponse(org.openrdf.repository.RepositoryConnection connection, int status, String resource) Add all the default headers specified in LDP to the Response
protected javax.ws.rs.core.Response.ResponseBuilder	createResponse(org.openrdf.repository.RepositoryConnection connection, javax.ws.rs.core.Response.ResponseBuilder rb, String resource) Add all the default headers specified in LDP to the Response
protected javax.ws.rs.core.Response.ResponseBuilder	createResponse(org.openrdf.repository.RepositoryConnection connection, javax.ws.rs.core.Response.Status status, String resource) Add all the default headers specified in LDP to the Response
protected javax.ws.rs.core.Response.ResponseBuilder	createResponse(javax.ws.rs.core.Response.ResponseBuilder rb) Add the non-resource related headers specified in LDP to the provided ResponseBuilder
javax.ws.rs.core.Response	DELETE(javax.ws.rs.core.UriInfo uriInfo) Handle delete (Sec.
javax.ws.rs.core.Response	GET(javax.ws.rs.core.UriInfo uriInfo, String type, PreferHeader preferHeader)
javax.ws.rs.core.Response	HEAD(javax.ws.rs.core.UriInfo uriInfo, String type, PreferHeader preferHeader)
protected void	initialize(org.apache.marmotta.platform.core.events.SesameStartupEvent event)
javax.ws.rs.core.Response	OPTIONS(javax.ws.rs.core.UriInfo uriInfo) Handle OPTIONS (Sec.
javax.ws.rs.core.Response	PATCH(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.EntityTag eTag, javax.ws.rs.core.MediaType type, InputStream postBody)
javax.ws.rs.core.Response	POST(javax.ws.rs.core.UriInfo uriInfo, String slug, List<javax.ws.rs.core.Link> linkHeaders, InputStream postBody, javax.ws.rs.core.MediaType type) LDP Post Request.
javax.ws.rs.core.Response	PUT(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, List<javax.ws.rs.core.Link> linkHeaders, javax.ws.rs.core.EntityTag eTag, javax.ws.rs.core.MediaType type, InputStream postBody) Handle PUT (Sec.

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

LDP_SERVER_CONSTRAINTS

public static final String LDP_SERVER_CONSTRAINTS

See Also:

Constant Field Values

LINK_REL_DESCRIBEDBY

public static final String LINK_REL_DESCRIBEDBY

See Also:

Constant Field Values

LINK_REL_CONSTRAINEDBY

public static final String LINK_REL_CONSTRAINEDBY

See Also:

Constant Field Values

LINK_REL_CONTENT

public static final String LINK_REL_CONTENT

See Also:

Constant Field Values

LINK_REL_META

public static final String LINK_REL_META

See Also:

Constant Field Values

LINK_REL_TYPE

public static final String LINK_REL_TYPE

See Also:

Constant Field Values

LINK_PARAM_ANCHOR

public static final String LINK_PARAM_ANCHOR

See Also:

Constant Field Values

HTTP_HEADER_SLUG

public static final String HTTP_HEADER_SLUG

See Also:

Constant Field Values

HTTP_HEADER_ACCEPT_POST

public static final String HTTP_HEADER_ACCEPT_POST

See Also:

Constant Field Values

HTTP_HEADER_ACCEPT_PATCH

public static final String HTTP_HEADER_ACCEPT_PATCH

See Also:

Constant Field Values

HTTP_HEADER_PREFER

public static final String HTTP_HEADER_PREFER

See Also:

Constant Field Values

HTTP_HEADER_PREFERENCE_APPLIED

public static final String HTTP_HEADER_PREFERENCE_APPLIED

See Also:

Constant Field Values

HTTP_METHOD_PATCH

public static final String HTTP_METHOD_PATCH

See Also:

Constant Field Values

Constructor Detail

LdpWebService

public LdpWebService()

Method Detail

initialize

protected void initialize(@Observes
              org.apache.marmotta.platform.core.events.SesameStartupEvent event)

GET

@GET
public javax.ws.rs.core.Response GET(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @HeaderParam(value="Accept")@DefaultValue(value="*/*")
                                String type,
                                @HeaderParam(value="Prefer")
                                PreferHeader preferHeader)
                              throws org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.RepositoryException

HEAD

@HEAD
public javax.ws.rs.core.Response HEAD(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  @HeaderParam(value="Accept")@DefaultValue(value="*/*")
                                  String type,
                                  @HeaderParam(value="Prefer")
                                  PreferHeader preferHeader)
                               throws org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.RepositoryException

POST

@POST
public javax.ws.rs.core.Response POST(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  @HeaderParam(value="Slug")
                                  String slug,
                                  @HeaderParam(value="Link")
                                  List<javax.ws.rs.core.Link> linkHeaders,
                                  InputStream postBody,
                                  @HeaderParam(value="Content-Type")
                                  javax.ws.rs.core.MediaType type)
                               throws org.openrdf.repository.RepositoryException

LDP Post Request.

Throws:

org.openrdf.repository.RepositoryException

See Also:

5.4 LDP-R POST, 6.4 LDP-C POST

PUT

@PUT
public javax.ws.rs.core.Response PUT(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                javax.ws.rs.core.Request request,
                                @HeaderParam(value="Link")
                                List<javax.ws.rs.core.Link> linkHeaders,
                                @HeaderParam(value="If-Match")
                                javax.ws.rs.core.EntityTag eTag,
                                @HeaderParam(value="Content-Type")
                                javax.ws.rs.core.MediaType type,
                                InputStream postBody)
                              throws org.openrdf.repository.RepositoryException,
                                     IOException,
                                     InvalidModificationException,
                                     org.openrdf.rio.RDFParseException,
                                     IncompatibleResourceTypeException,
                                     URISyntaxException

Handle PUT (Sec. 4.2.4, Sec. 5.2.4)

Throws:

org.openrdf.repository.RepositoryException

IOException

InvalidModificationException

org.openrdf.rio.RDFParseException

IncompatibleResourceTypeException

URISyntaxException

DELETE

@DELETE
public javax.ws.rs.core.Response DELETE(@Context
                                      javax.ws.rs.core.UriInfo uriInfo)
                                 throws org.openrdf.repository.RepositoryException

Handle delete (Sec. 4.2.5, Sec. 5.2.5)

Throws:

org.openrdf.repository.RepositoryException

PATCH

@PATCH
public javax.ws.rs.core.Response PATCH(@Context
                                    javax.ws.rs.core.UriInfo uriInfo,
                                    @HeaderParam(value="If-Match")
                                    javax.ws.rs.core.EntityTag eTag,
                                    @HeaderParam(value="Content-Type")
                                    javax.ws.rs.core.MediaType type,
                                    InputStream postBody)
                                throws org.openrdf.repository.RepositoryException

Throws:

org.openrdf.repository.RepositoryException

OPTIONS

@OPTIONS
public javax.ws.rs.core.Response OPTIONS(@Context
                                        javax.ws.rs.core.UriInfo uriInfo)
                                  throws org.openrdf.repository.RepositoryException

Handle OPTIONS (Sec. 4.2.8, Sec. 5.2.8)

Throws:

org.openrdf.repository.RepositoryException

createResponse

protected javax.ws.rs.core.Response.ResponseBuilder createResponse(org.openrdf.repository.RepositoryConnection connection,
                                                       javax.ws.rs.core.Response.Status status,
                                                       String resource)
                                                            throws org.openrdf.repository.RepositoryException

Add all the default headers specified in LDP to the Response

Parameters:

connection - the RepositoryConnection (with active transaction) to read extra data from

status - the StatusCode

resource - the iri/uri/url of the resource

Returns:

the provided ResponseBuilder for chaining

Throws:

org.openrdf.repository.RepositoryException

createResponse

protected javax.ws.rs.core.Response.ResponseBuilder createResponse(org.openrdf.repository.RepositoryConnection connection,
                                                       int status,
                                                       String resource)
                                                            throws org.openrdf.repository.RepositoryException

Add all the default headers specified in LDP to the Response

Parameters:

connection - the RepositoryConnection (with active transaction) to read extra data from

status - the status code

resource - the uri/url of the resource

Returns:

the provided ResponseBuilder for chaining

Throws:

org.openrdf.repository.RepositoryException

createResponse

protected javax.ws.rs.core.Response.ResponseBuilder createResponse(org.openrdf.repository.RepositoryConnection connection,
                                                       javax.ws.rs.core.Response.ResponseBuilder rb,
                                                       String resource)
                                                            throws org.openrdf.repository.RepositoryException

Add all the default headers specified in LDP to the Response

Parameters:

connection - the RepositoryConnection (with active transaction) to read extra data from

rb - the ResponseBuilder

resource - the uri/url of the resource

Returns:

the provided ResponseBuilder for chaining

Throws:

org.openrdf.repository.RepositoryException

createResponse

protected javax.ws.rs.core.Response.ResponseBuilder createResponse(javax.ws.rs.core.Response.ResponseBuilder rb)

Add the non-resource related headers specified in LDP to the provided ResponseBuilder

Parameters:

rb - the ResponseBuilder to decorate

Returns:

the updated ResponseBuilder for chaining