org.fcrepo.kernel.api.models

Interface FedoraBinary

All Superinterfaces:

FedoraResource

All Known Implementing Classes:

FedoraBinaryImpl

public interface FedoraBinary
extends FedoraResource

Since:

9/19/14

Author:

cabeer

Method Summary

Modifier and Type	Method and Description
InputStream	getContent()
URI	getContentDigest() Get the pre-calculated content digest for the binary payload
long	getContentSize()
String	getFilename() Return the file name for the binary content
RdfStream	getFixity(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator) Get the fixity of this datastream compared to metadata stored in the repository
RdfStream	getFixity(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, URI contentDigest, long size) Get the fixity of this datastream in a given repository's binary store.
String	getMimeType()
void	setContent(InputStream content, String contentType, Collection<URI> checksums, String originalFileName, StoragePolicyDecisionPoint storagePolicyDecisionPoint) Sets the content of this Datastream.

Methods inherited from interface org.fcrepo.kernel.api.models.FedoraResource

delete, disableVersioning, enableVersioning, getBaseVersion, getChild, getChildren, getChildren, getContainer, getCreatedDate, getDescribedResource, getDescription, getEtagValue, getLastModifiedDate, getPath, getTriples, getTriples, getTypes, getUnfrozenResource, getVersion, getVersionedAncestor, getVersionHistory, getVersionLabelOfFrozenResource, hasProperty, hasType, isFrozenResource, isNew, isVersioned, replaceProperties, updateProperties

Method Detail

getContent

InputStream getContent()

Returns:

The InputStream of content associated with this datastream.

setContent

void setContent(InputStream content,
                String contentType,
                Collection<URI> checksums,
                String originalFileName,
                StoragePolicyDecisionPoint storagePolicyDecisionPoint)
         throws InvalidChecksumException

Sets the content of this Datastream.

Parameters:

content - InputStream of binary content to be stored

contentType - MIME type of content (optional)

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

originalFileName - Original file name of the content (optional)

storagePolicyDecisionPoint - Policy decision point for storing the content (optional)

Throws:

InvalidChecksumException - if invalid checksum exception occurred

getContentSize

long getContentSize()

Returns:

The size in bytes of content associated with this datastream.

getContentDigest

URI getContentDigest()

Get the pre-calculated content digest for the binary payload

Returns:

a URI with the format algorithm:value

getMimeType

String getMimeType()

Returns:

The MimeType of content associated with this datastream.

getFilename

String getFilename()

Return the file name for the binary content

Returns:

original file name for the binary content, or the object's id.

getFixity

RdfStream getFixity(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator)

Get the fixity of this datastream compared to metadata stored in the repository

Parameters:

idTranslator - the id translator

Returns:

the fixity of this datastream compared to metadata stored in the repository

getFixity

RdfStream getFixity(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                    URI contentDigest,
                    long size)

Get the fixity of this datastream in a given repository's binary store.

Parameters:

idTranslator - the id translator

contentDigest - the checksum to compare against

size - the expected size of the binary

Returns:

the fixity of the datastream