org.fcrepo.http.commons

Class AbstractResource

java.lang.Object

org.fcrepo.http.commons.AbstractResource

public abstract class AbstractResource
extends Object

Abstract superclass for Fedora JAX-RS Resources, providing convenience fields and methods.

Author:

ajs6f

Field Summary

Fields

Modifier and Type	Field and Description
protected org.fcrepo.kernel.services.DatastreamService	datastreamService The fcrepo datastream service
protected com.google.common.eventbus.EventBus	eventBus
protected static org.modeshape.jcr.api.JcrTools	jcrTools A convenience object provided by ModeShape for acting against the JCR repository.
protected org.fcrepo.kernel.services.LockService	lockService The fcrepo lock service
protected org.fcrepo.kernel.services.NodeService	nodeService The fcrepo node service
protected org.fcrepo.kernel.services.ObjectService	objectService The fcrepo object service
protected org.fcrepo.kernel.identifiers.PidMinter	pidMinter A resource that can mint new Fedora PIDs.
protected org.fcrepo.kernel.services.RepositoryService	repositoryService The fcrepo repository service
protected SessionFactory	sessions
protected javax.ws.rs.core.UriInfo	uriInfo Useful for constructing URLs
protected org.fcrepo.kernel.services.VersionService	versionService The fcrepo version service

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addCacheControlHeaders(javax.servlet.http.HttpServletResponse servletResponse, org.fcrepo.kernel.FedoraResource resource, javax.jcr.Session session) Add ETag and Last-Modified cache control headers to the response
protected void	addResponseInformationToStream(org.fcrepo.kernel.FedoraResource resource, org.fcrepo.kernel.utils.iterators.RdfStream dataset, javax.ws.rs.core.UriInfo uriInfo, org.fcrepo.kernel.rdf.IdentifierTranslator subjects)
protected static void	checkCacheControlHeaders(javax.ws.rs.core.Request request, javax.servlet.http.HttpServletResponse servletResponse, org.fcrepo.kernel.FedoraResource resource, javax.jcr.Session session) Evaluate the cache control headers for the request to see if it can be served from the cache.
protected static URI	checksumURI(String checksum) Create a checksum URI object.
protected static void	evaluateRequestPreconditions(javax.ws.rs.core.Request request, javax.servlet.http.HttpServletResponse servletResponse, org.fcrepo.kernel.FedoraResource resource, javax.jcr.Session session) Evaluate request preconditions to ensure the resource is the expected state
protected static javax.ws.rs.core.MediaType	getSimpleContentType(javax.ws.rs.core.MediaType requestContentType)
protected static boolean	isRdfContentType(String contentTypeString)
protected static String	originalFileName(String contentDisposition) Parse Content-Disposition header and extract original filename.
static String	toPath(List<javax.ws.rs.core.PathSegment> paths) Convert a JAX-RS list of PathSegments to a JCR path

Methods inherited from class java.lang.Object

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

Field Detail

uriInfo

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

Useful for constructing URLs

sessions

@Autowired
protected SessionFactory sessions

nodeService

@Autowired
protected org.fcrepo.kernel.services.NodeService nodeService

The fcrepo node service

objectService

@Autowired
protected org.fcrepo.kernel.services.ObjectService objectService

The fcrepo object service

datastreamService

@Autowired
protected org.fcrepo.kernel.services.DatastreamService datastreamService

The fcrepo datastream service

versionService

@Autowired
protected org.fcrepo.kernel.services.VersionService versionService

The fcrepo version service

repositoryService

@Autowired
protected org.fcrepo.kernel.services.RepositoryService repositoryService

The fcrepo repository service

lockService

@Autowired
protected org.fcrepo.kernel.services.LockService lockService

The fcrepo lock service

eventBus

@Autowired(required=false)
protected com.google.common.eventbus.EventBus eventBus

pidMinter

@Autowired
protected org.fcrepo.kernel.identifiers.PidMinter pidMinter

A resource that can mint new Fedora PIDs.

jcrTools

protected static final org.modeshape.jcr.api.JcrTools jcrTools

A convenience object provided by ModeShape for acting against the JCR repository.

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

toPath

public static final String toPath(List<javax.ws.rs.core.PathSegment> paths)

Convert a JAX-RS list of PathSegments to a JCR path

Parameters:

paths -

Returns:

String jcr path

checkCacheControlHeaders

protected static void checkCacheControlHeaders(javax.ws.rs.core.Request request,
                            javax.servlet.http.HttpServletResponse servletResponse,
                            org.fcrepo.kernel.FedoraResource resource,
                            javax.jcr.Session session)
                                        throws javax.jcr.RepositoryException

Evaluate the cache control headers for the request to see if it can be served from the cache.

Parameters:

request -

servletResponse -

resource -

session -

Throws:

javax.jcr.RepositoryException

addCacheControlHeaders

protected static void addCacheControlHeaders(javax.servlet.http.HttpServletResponse servletResponse,
                          org.fcrepo.kernel.FedoraResource resource,
                          javax.jcr.Session session)
                                      throws javax.jcr.RepositoryException

Add ETag and Last-Modified cache control headers to the response

Parameters:

servletResponse -

resource -

Throws:

javax.jcr.RepositoryException

evaluateRequestPreconditions

protected static void evaluateRequestPreconditions(javax.ws.rs.core.Request request,
                                javax.servlet.http.HttpServletResponse servletResponse,
                                org.fcrepo.kernel.FedoraResource resource,
                                javax.jcr.Session session)
                                            throws javax.jcr.RepositoryException

Evaluate request preconditions to ensure the resource is the expected state

Parameters:

request -

resource -

Throws:

javax.jcr.RepositoryException

getSimpleContentType

protected static javax.ws.rs.core.MediaType getSimpleContentType(javax.ws.rs.core.MediaType requestContentType)

isRdfContentType

protected static boolean isRdfContentType(String contentTypeString)

addResponseInformationToStream

protected void addResponseInformationToStream(org.fcrepo.kernel.FedoraResource resource,
                                  org.fcrepo.kernel.utils.iterators.RdfStream dataset,
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  org.fcrepo.kernel.rdf.IdentifierTranslator subjects)
                                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

originalFileName

protected static String originalFileName(String contentDisposition)
                                  throws ParseException

Parse Content-Disposition header and extract original filename.

Throws:

ParseException

checksumURI

protected static URI checksumURI(String checksum)
                          throws URISyntaxException

Create a checksum URI object.

Throws:

URISyntaxException