org.fcrepo.kernel.services

Interface DatastreamService

All Superinterfaces:

Service

public interface DatastreamService
extends Service

Since:

Feb 20, 2014

Author:

bbpennel

Method Summary

Methods

Modifier and Type	Method and Description
Datastream	asDatastream(javax.jcr.Node node) Retrieve a Datastream instance by pid and dsid
Datastream	createDatastream(javax.jcr.Session session, String dsPath) Create a stub datastream without content
Datastream	createDatastream(javax.jcr.Session session, String dsPath, String contentType, String originalFileName, InputStream requestBodyStream) Create a new Datastream node in the repository
Datastream	createDatastream(javax.jcr.Session session, String dsPath, String contentType, String originalFileName, InputStream requestBodyStream, URI checksum) Create a new Datastream node in the repository
Datastream	getDatastream(javax.jcr.Session session, String path) Retrieve a Datastream instance by pid and dsid
javax.jcr.Node	getDatastreamNode(javax.jcr.Session session, String path) Retrieve the JCR node for a Datastream by pid and dsid
Collection<FixityResult>	getFixity(javax.jcr.Node resource, URI dsChecksum, long dsSize) Get the fixity results for this datastream's bitstream, and compare it against the given checksum and size.
RdfStream	getFixityResultsModel(IdentifierTranslator subjects, Datastream datastream) Get the fixity results for the datastream as a RDF Dataset
Collection<FixityResult>	runFixityAndFixProblems(Datastream datastream) Run the fixity check on the datastream and attempt to automatically correct failures if additional copies of the bitstream are available

Methods inherited from interface org.fcrepo.kernel.services.Service

exists, setRepository

Method Detail

createDatastream

Datastream createDatastream(javax.jcr.Session session,
                          String dsPath)
                            throws javax.jcr.RepositoryException

Create a stub datastream without content

Parameters:

session -

dsPath -

Returns:

created datastream

Throws:

javax.jcr.RepositoryException

createDatastream

Datastream createDatastream(javax.jcr.Session session,
                          String dsPath,
                          String contentType,
                          String originalFileName,
                          InputStream requestBodyStream)
                            throws javax.jcr.RepositoryException,
                                   InvalidChecksumException

Create a new Datastream node in the repository

Parameters:

session -

dsPath - the absolute path to put the datastream

contentType - the mime-type for the requestBodyStream

originalFileName - the original file name for the input stream

requestBodyStream - binary payload for the datastream

Returns:

created datastream

Throws:

javax.jcr.RepositoryException

InvalidChecksumException

createDatastream

Datastream createDatastream(javax.jcr.Session session,
                          String dsPath,
                          String contentType,
                          String originalFileName,
                          InputStream requestBodyStream,
                          URI checksum)
                            throws javax.jcr.RepositoryException,
                                   InvalidChecksumException

Create a new Datastream node in the repository

Parameters:

session -

dsPath - the absolute path to put the datastream

contentType - the mime-type for the requestBodyStream

originalFileName - the original file name for the input stream

requestBodyStream - binary payload for the datastream

checksum - the digest for the binary payload (as urn:sha1:xyz) @return

Throws:

javax.jcr.RepositoryException

InvalidChecksumException

getDatastreamNode

javax.jcr.Node getDatastreamNode(javax.jcr.Session session,
                               String path)
                                 throws javax.jcr.RepositoryException

Retrieve the JCR node for a Datastream by pid and dsid

Parameters:

path -

Returns:

retrieved jcr node

Throws:

javax.jcr.RepositoryException

getDatastream

Datastream getDatastream(javax.jcr.Session session,
                       String path)
                         throws javax.jcr.RepositoryException

Retrieve a Datastream instance by pid and dsid

Parameters:

path - jcr path to the datastream

Returns:

retrieved Datastream

Throws:

javax.jcr.RepositoryException

asDatastream

Datastream asDatastream(javax.jcr.Node node)
                        throws ResourceTypeException,
                               javax.jcr.RepositoryException

Retrieve a Datastream instance by pid and dsid

Parameters:

node - datastream node

Returns:

node as a Datastream

Throws:

ResourceTypeException

javax.jcr.RepositoryException

getFixityResultsModel

RdfStream getFixityResultsModel(IdentifierTranslator subjects,
                              Datastream datastream)
                                throws javax.jcr.RepositoryException

Get the fixity results for the datastream as a RDF Dataset

Parameters:

subjects -

datastream -

Returns:

fixity results for datastream

Throws:

javax.jcr.RepositoryException

runFixityAndFixProblems

Collection<FixityResult> runFixityAndFixProblems(Datastream datastream)
                                                 throws javax.jcr.RepositoryException

Run the fixity check on the datastream and attempt to automatically correct failures if additional copies of the bitstream are available

Parameters:

datastream -

Returns:

results

Throws:

javax.jcr.RepositoryException

getFixity

Collection<FixityResult> getFixity(javax.jcr.Node resource,
                                 URI dsChecksum,
                                 long dsSize)
                                   throws javax.jcr.RepositoryException

Get the fixity results for this datastream's bitstream, and compare it against the given checksum and size.

Parameters:

resource -

dsChecksum - -the checksum and algorithm represented as a URI

dsSize -

Returns:

fixity results for datastream's bitstream

Throws:

javax.jcr.RepositoryException