org.fcrepo.http.api

Class FedoraVersioning

java.lang.Object

org.fcrepo.http.commons.AbstractResource

org.fcrepo.http.api.FedoraBaseResource

org.fcrepo.http.api.ContentExposingResource

org.fcrepo.http.api.FedoraVersioning

@Scope(value="request")
 @Path(value="/{path: .*}/fcr:versions")
public class FedoraVersioning
extends ContentExposingResource

Since:

9/25/14

Author:

cabeer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	externalPath
static String	MEMENTO_DATETIME_HEADER
protected javax.ws.rs.core.Request	request
protected javax.servlet.http.HttpServletResponse	servletResponse
protected javax.ws.rs.core.UriInfo	uriInfo

Fields inherited from class org.fcrepo.http.api.ContentExposingResource

ACCEPT_DATETIME, context, extContentHandlerFactory, lockManager, namespaceRegistry, prefer, RFC3230_SPLITTER

Fields inherited from class org.fcrepo.http.api.FedoraBaseResource

idTranslator, securityContext, session

Fields inherited from class org.fcrepo.http.commons.AbstractResource

binaryService, containerService, defaultPidMinter, headers, nodeService, pidMinter, timeMapService, versionService

Constructor Summary

Constructors

Constructor and Description
FedoraVersioning() Default JAX-RS entry point
FedoraVersioning(String externalPath) Create a new FedoraNodes instance for a given path

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addVersion(String datetimeHeader, javax.ws.rs.core.MediaType requestContentType, String digest, InputStream requestBodyStream, List<String> rawLinks) Create a new version of a resource.
protected String	externalPath()
javax.ws.rs.core.Response	getVersionList(String rangeValue, String acceptValue) Get the list of versions for the object
javax.ws.rs.core.Response	options() Outputs information about the supported HTTP methods, etc.

Methods inherited from class org.fcrepo.http.api.ContentExposingResource

addCacheControlHeaders, addExternalContentHeaders, addLinkAndOptionsHttpHeaders, addResourceHttpHeaders, buildLink, checkCacheControlHeaders, checkForInsufficientStorageException, checksumURI, createUpdateResponse, evaluateRequestPreconditions, getBinaryResourceMediaType, getChildrenLimit, getContent, getResourceTriples, getSimpleContentType, getUri, hasRestrictedPath, isRdfContentType, parseDigestHeader, patchResourcewithSparql, postConstruct, replaceResourceBinaryWithStream, replaceResourceWithStream, resource, setVaryAndPreferenceAppliedHeaders, unpackLinks

Methods inherited from class org.fcrepo.http.api.FedoraBaseResource

asNode, getResourceFromPath, getUserPrincipal, setUpJMSInfo, translator

Methods inherited from class org.fcrepo.http.commons.AbstractResource

toPath

Methods inherited from class java.lang.Object

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

Field Detail

MEMENTO_DATETIME_HEADER

public static final String MEMENTO_DATETIME_HEADER

See Also:

Constant Field Values

request

@Context
protected javax.ws.rs.core.Request request

servletResponse

@Context
protected javax.servlet.http.HttpServletResponse servletResponse

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

externalPath

@PathParam(value="path")
protected String externalPath

Constructor Detail

FedoraVersioning

public FedoraVersioning()

Default JAX-RS entry point

FedoraVersioning

public FedoraVersioning(String externalPath)

Create a new FedoraNodes instance for a given path

Parameters:

externalPath - the external path

Method Detail

addVersion

@POST
public javax.ws.rs.core.Response addVersion(@HeaderParam(value="Memento-Datetime")
                                                  String datetimeHeader,
                                                  @HeaderParam(value="Content-Type")
                                                  javax.ws.rs.core.MediaType requestContentType,
                                                  @HeaderParam(value="Digest")
                                                  String digest,
                                                  InputStream requestBodyStream,
                                                  @HeaderParam(value="Link")
                                                  List<String> rawLinks)
                                           throws InvalidChecksumException,
                                                  MementoDatetimeFormatException

Create a new version of a resource. If a memento-datetime header is provided, then the new version will be based off the provided body using that datetime. If one was not provided, then a version is created based off the current version of the resource.

Parameters:

datetimeHeader - memento-datetime header

requestContentType - Content-Type of the request body

digest - digests of the request body

requestBodyStream - request body stream

Returns:

response

Throws:

InvalidChecksumException - thrown if one of the provided digests does not match the content

MementoDatetimeFormatException - if the header value of memento-datetime is not RFC-1123 format

getVersionList

@GET
 @Produces(value={"text/turtle;charset=utf-8;qs=1.0","application/ld+json;qs=0.8","text/rdf+n3;charset=utf-8","text/n3;charset=utf-8","application/rdf+xml","application/n-triples","text/plain;charset=utf-8","application/x-turtle","text/html;charset=utf-8","application/link-format"})
public javax.ws.rs.core.Response getVersionList(@HeaderParam(value="Range")
                                                                                                                                                                                                                                                                                                                                                 String rangeValue,
                                                                                                                                                                                                                                                                                                                                                 @HeaderParam(value="Accept")
                                                                                                                                                                                                                                                                                                                                                 String acceptValue)
                                                                                                                                                                                                                                                                                                                                          throws IOException

Get the list of versions for the object

Parameters:

rangeValue - starting and ending byte offsets

acceptValue - the rdf media-type

Returns:

List of versions for the object as RDF

Throws:

IOException - in case of error extracting content

options

@OPTIONS
public javax.ws.rs.core.Response options()

Outputs information about the supported HTTP methods, etc.

Returns:

the information about the supported HTTP methods, etc.

externalPath

protected String externalPath()

Specified by:

externalPath in class ContentExposingResource