org.fcrepo.kernel.api.services

Interface VersionService

All Known Implementing Classes:

VersionServiceImpl

public interface VersionService

Service for creating versions of resources

Since:

Feb 19, 2014

Author:

bbpennel, whikloj

Field Summary

Fields

Modifier and Type	Field and Description
static DateTimeFormatter	MEMENTO_LABEL_FORMATTER To format a datetime for use as a Memento path.
static DateTimeFormatter	MEMENTO_RFC_1123_FORMATTER To format a datetime as RFC-1123 with correct timezone.

Method Summary

Modifier and Type	Method and Description
FedoraBinary	createBinaryVersion(FedoraSession session, FedoraBinary resource, Instant dateTime, InputStream contentStream, Collection<URI> checksums, StoragePolicyDecisionPoint storagePolicyDecisionPoint) Explicitly creates a version of a binary resource.
FedoraBinary	createBinaryVersion(FedoraSession session, FedoraBinary resource, Instant dateTime, StoragePolicyDecisionPoint storagePolicyDecisionPoint) Explicitly creates a version of a binary resource from the current state of that binary.
FedoraBinary	createExternalBinaryVersion(FedoraSession session, FedoraBinary resource, Instant dateTime, Collection<URI> checksums, String externalHandling, String externalUrl)
FedoraResource	createVersion(FedoraSession session, FedoraResource resource, IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, Instant dateTime) Explicitly creates a version for the resource at the path provided.
FedoraResource	createVersion(FedoraSession session, FedoraResource resource, IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, Instant dateTime, InputStream rdfInputStream, org.apache.jena.riot.Lang rdfFormat) Explicitly creates a version for the resource at the path provided for the date/time provided.

Field Detail

MEMENTO_LABEL_FORMATTER

static final DateTimeFormatter MEMENTO_LABEL_FORMATTER

To format a datetime for use as a Memento path.

MEMENTO_RFC_1123_FORMATTER

static final DateTimeFormatter MEMENTO_RFC_1123_FORMATTER

To format a datetime as RFC-1123 with correct timezone.

Method Detail

createVersion

FedoraResource createVersion(FedoraSession session,
                             FedoraResource resource,
                             IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                             Instant dateTime)

Explicitly creates a version for the resource at the path provided.

Parameters:

session - the session in which the resource resides

resource - the resource to version

idTranslator - translator for producing URI of resources

dateTime - the date/time of the version

Returns:

the version

createVersion

FedoraResource createVersion(FedoraSession session,
                             FedoraResource resource,
                             IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                             Instant dateTime,
                             InputStream rdfInputStream,
                             org.apache.jena.riot.Lang rdfFormat)

Explicitly creates a version for the resource at the path provided for the date/time provided.

Parameters:

session - the session in which the resource resides

resource - the resource to version

idTranslator - translator for producing URI of resources

dateTime - the date/time of the version

rdfInputStream - if provided, this stream will provide the properties of the new memento. If null, then the state of the current resource will be used.

rdfFormat - RDF language format name

Returns:

the version

createBinaryVersion

FedoraBinary createBinaryVersion(FedoraSession session,
                                 FedoraBinary resource,
                                 Instant dateTime,
                                 InputStream contentStream,
                                 Collection<URI> checksums,
                                 StoragePolicyDecisionPoint storagePolicyDecisionPoint)
                          throws InvalidChecksumException

Explicitly creates a version of a binary resource. If contentStream is provided, then it will be used as the content of the binary memento. Otherwise, the current state of the binary will be used.

Parameters:

session - the session in which the resource resides

resource - the binary resource to version

dateTime - the date/time of the version

contentStream - if provided, the content in this stream will be used as the content of the new binary memento. If null, then the current state of the binary will be used.

checksums - Collection of checksum URIs of the content (optional)

storagePolicyDecisionPoint - optional storage policy

Returns:

the version

Throws:

InvalidChecksumException - if there are errors applying checksums

createBinaryVersion

FedoraBinary createBinaryVersion(FedoraSession session,
                                 FedoraBinary resource,
                                 Instant dateTime,
                                 StoragePolicyDecisionPoint storagePolicyDecisionPoint)
                          throws InvalidChecksumException

Explicitly creates a version of a binary resource from the current state of that binary.

Parameters:

session - the session in which the resource resides

resource - the binary resource to version

dateTime - the date/time of the version

storagePolicyDecisionPoint - optional storage policy

Returns:

the version

Throws:

InvalidChecksumException - on error

createExternalBinaryVersion

FedoraBinary createExternalBinaryVersion(FedoraSession session,
                                         FedoraBinary resource,
                                         Instant dateTime,
                                         Collection<URI> checksums,
                                         String externalHandling,
                                         String externalUrl)
                                  throws InvalidChecksumException

Parameters:

session - the session in which the resource resides

resource - the binary resource to version

dateTime - the date/time of the version

checksums - Collection of checksum URIs of the content (optional)

externalHandling - What type of handling the external resource needs (proxy or redirect)

externalUrl - Url for the external resourcej

Returns:

the version

Throws:

InvalidChecksumException - if there are errors applying checksums