org.fcrepo.kernel.api.models

Interface FedoraBinary

All Superinterfaces:

FedoraResource

public interface FedoraBinary
extends FedoraResource

Since:

9/19/14

Author:

cabeer

Method Summary

Modifier and Type	Method and Description
Collection<URI>	checkFixity(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, Collection<String> algorithms) Digest this datastream with the digest algorithms provided
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()
String	getProxyURL() Get the URL that this resource is a Proxy for
default URI	getRedirectURI() Get URL as a URI
String	getRedirectURL() Get the URL this resource should redirect to
Boolean	isProxy()
Boolean	isRedirect()
void	setContent(InputStream content, String contentType, Collection<URI> checksums, String originalFileName, StoragePolicyDecisionPoint storagePolicyDecisionPoint) Sets the content of this Datastream.
void	setExternalContent(String contentType, Collection<URI> checksums, String originalFileName, String externalHandling, String externalUrl) Sets the external content reference for this datastream
void	setProxyURL(String url) Set the URL that this resource is a proxy for
void	setRedirectURL(String url) Set the URL that this is a redirect to

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

addType, delete, findMementoByDatetime, findOrCreateAcl, getAcl, getChild, getChildren, getChildren, getContainer, getCreatedDate, getDescribedResource, getDescription, getEtagValue, getLastModifiedDate, getMementoDatetime, getOriginalResource, getPath, getTimeMap, getTriples, getTriples, getTypes, hasProperty, hasType, isAcl, isMemento, isNew, isOriginalResource, 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

setExternalContent

void setExternalContent(String contentType,
                        Collection<URI> checksums,
                        String originalFileName,
                        String externalHandling,
                        String externalUrl)
                 throws InvalidChecksumException

Sets the external content reference for this datastream

Parameters:

contentType - MIME type of content (optional)

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

originalFileName - Original file name of the content (optional)

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

externalUrl - Url for the external resourcej

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

isProxy

Boolean isProxy()

Returns:

Whether or not this binary is a proxy to another resource

isRedirect

Boolean isRedirect()

Returns:

Whether or not this binary is a redirect to another resource

getProxyURL

String getProxyURL()

Get the URL that this resource is a Proxy for

Returns:

String containing URL of object to proxy

setProxyURL

void setProxyURL(String url)

Set the URL that this resource is a proxy for

Parameters:

url - - the url of the resource this is a proxy for

getRedirectURL

String getRedirectURL()

Get the URL this resource should redirect to

Returns:

String containing URL of object to redirect to

getRedirectURI

default URI getRedirectURI()

Get URL as a URI

Returns:

URI containing the object to redirect to.

setRedirectURL

void setRedirectURL(String url)

Set the URL that this is a redirect to

Parameters:

url - - the url of the resource this redirects to

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

checkFixity

Collection<URI> checkFixity(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                            Collection<String> algorithms)
                     throws UnsupportedAlgorithmException

Digest this datastream with the digest algorithms provided

Parameters:

idTranslator - the id translator

algorithms - the digest algorithms to be used

Returns:

the checksums of this datastream

Throws:

UnsupportedAlgorithmException - if unsupported digest algorithm occurred