org.fcrepo.kernel.impl

Class FedoraBinaryImpl

java.lang.Object

org.modeshape.jcr.api.JcrTools

org.fcrepo.kernel.impl.FedoraResourceImpl

org.fcrepo.kernel.impl.FedoraBinaryImpl

All Implemented Interfaces:

FedoraJcrTypes, FedoraBinary, FedoraResource, NonRdfSource

public class FedoraBinaryImpl
extends FedoraResourceImpl
implements FedoraBinary

Since:

9/19/14

Author:

cabeer

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.api.JcrTools

org.modeshape.jcr.api.JcrTools.BasicOperation, org.modeshape.jcr.api.JcrTools.BrowseContent, org.modeshape.jcr.api.JcrTools.CountNodes, org.modeshape.jcr.api.JcrTools.NodeOperation, org.modeshape.jcr.api.JcrTools.Operation, org.modeshape.jcr.api.JcrTools.PrintNodes, org.modeshape.jcr.api.JcrTools.Variable

Field Summary

Fields inherited from class org.fcrepo.kernel.impl.FedoraResourceImpl

node

Fields inherited from interface org.fcrepo.kernel.FedoraJcrTypes

CONTENT_DIGEST, CONTENT_SIZE, EXPOSED_PROTECTED_JCR_TYPES, FCR_METADATA, FCR_VERSIONS, FEDORA_BINARY, FEDORA_BLANKNODE, FEDORA_CONTAINER, FEDORA_NON_RDF_SOURCE_DESCRIPTION, FEDORA_PAIRTREE, FEDORA_RESOURCE, FEDORA_TOMBSTONE, FROZEN_MIXIN_TYPES, FROZEN_NODE, JCR_CREATED, JCR_CREATEDBY, JCR_FROZEN_NODE, JCR_LASTMODIFIED, JCR_MIXIN_TYPES, JCR_PRIMARY_TYPE, JCR_UUID, LDP_BASIC_CONTAINER, LDP_DIRECT_CONTAINER, LDP_HAS_MEMBER_RELATION, LDP_INDIRECT_CONTAINER, LDP_INSERTED_CONTENT_RELATION, LDP_IS_MEMBER_OF_RELATION, LDP_MEMBER_RESOURCE, PREMIS_FILE_NAME, ROOT, VERSIONABLE

Constructor Summary

Constructors

Constructor and Description
FedoraBinaryImpl(javax.jcr.Node node) Wrap an existing Node as a Fedora Binary

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() When deleting the binary, we also need to clean up the description document.
void	disableVersioning() Disable versioning
void	enableVersioning() Enable versioning
javax.jcr.version.Version	getBaseVersion() Get the JCR Base version for the node
javax.jcr.Binary	getBinaryContent()
InputStream	getContent()
URI	getContentDigest() Get the pre-calculated content digest for the binary payload
long	getContentSize()
NonRdfSourceDescription	getDescription() Get the description for this binary
String	getFilename() Return the file name for the binary content
RdfStream	getFixity(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator) Get the fixity of this datastream compared to metadata stored in the repository
RdfStream	getFixity(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator, URI digestUri, long size) Get the fixity of this datastream in a given repository's binary store.
String	getMimeType()
javax.jcr.version.VersionHistory	getVersionHistory() Get JCR VersionHistory for the node.
static boolean	hasMixin(javax.jcr.Node node) Check if the given node is a Fedora binary
boolean	isVersioned() Check if a resource is versioned
void	setContent(InputStream content, String contentType, URI checksum, String originalFileName, StoragePolicyDecisionPoint storagePolicyDecisionPoint) Sets the content of this Datastream.

Methods inherited from class org.fcrepo.kernel.impl.FedoraResourceImpl

equals, getChild, getChildren, getContainer, getCreatedDate, getEtagValue, getLastModifiedDate, getNode, getNodeVersion, getPath, getProperty, getSession, getTriples, getTriples, getUnfrozenResource, getVersionedAncestor, hashCode, hasProperty, hasType, isFrozenResource, isNew, replaceProperties, toString, updateProperties

Methods inherited from class org.modeshape.jcr.api.JcrTools

findOrCreateChild, findOrCreateChild, findOrCreateNode, findOrCreateNode, findOrCreateNode, findOrCreateNode, getNode, getReadable, getStringValue, importContent, importContent, importContent, importContent, importContent, importContent, importContent, isDebug, onEachNode, onEachNodeBelow, print, printNode, printQuery, printQuery, printQuery, printQuery, printSubgraph, printSubgraph, printSubgraph, registerNodeTypes, removeAllChildren, removeAllChildren, repeatedlyWithSession, resourceUrl, setDebug, uploadFile, uploadFile, uploadFile, uploadFileAndBlock, uploadFileAndBlock, uploadFileAndBlock, uploadFilesAndBlock, var, vars, withSession

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getChild, getChildren, getContainer, getCreatedDate, getEtagValue, getLastModifiedDate, getNode, getNodeVersion, getPath, getProperty, getTriples, getTriples, getUnfrozenResource, getVersionedAncestor, hasProperty, hasType, isFrozenResource, isNew, replaceProperties, updateProperties

Constructor Detail

FedoraBinaryImpl

public FedoraBinaryImpl(javax.jcr.Node node)

Wrap an existing Node as a Fedora Binary

Parameters:

node - the node

Method Detail

getDescription

public NonRdfSourceDescription getDescription()

Description copied from interface: NonRdfSource

Get the description for this binary

Specified by:

getDescription in interface NonRdfSource

Returns:

the description for this binary

getContent

public InputStream getContent()

Specified by:

getContent in interface FedoraBinary

Returns:

The InputStream of content associated with this datastream.

getBinaryContent

public javax.jcr.Binary getBinaryContent()

Specified by:

getBinaryContent in interface FedoraBinary

Returns:

The Binary content associated with this datastream.

setContent

public void setContent(InputStream content,
              String contentType,
              URI checksum,
              String originalFileName,
              StoragePolicyDecisionPoint storagePolicyDecisionPoint)
                throws InvalidChecksumException

Description copied from interface: FedoraBinary

Sets the content of this Datastream.

Specified by:

setContent in interface FedoraBinary

Parameters:

content - InputStream of binary content to be stored

contentType - MIME type of content (optional)

checksum - Checksum URI 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

public long getContentSize()

Specified by:

getContentSize in interface FedoraBinary

Returns:

The size in bytes of content associated with this datastream.

getContentDigest

public URI getContentDigest()

Description copied from interface: FedoraBinary

Get the pre-calculated content digest for the binary payload

Specified by:

getContentDigest in interface FedoraBinary

Returns:

a URI with the format algorithm:value

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface FedoraBinary

Returns:

The MimeType of content associated with this datastream.

getFilename

public String getFilename()

Description copied from interface: FedoraBinary

Return the file name for the binary content

Specified by:

getFilename in interface FedoraBinary

Returns:

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

getFixity

public RdfStream getFixity(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator)

Description copied from interface: FedoraBinary

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

Specified by:

getFixity in interface FedoraBinary

Parameters:

idTranslator - the id translator

Returns:

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

getFixity

public RdfStream getFixity(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator,
                  URI digestUri,
                  long size)

Description copied from interface: FedoraBinary

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

Specified by:

getFixity in interface FedoraBinary

Parameters:

idTranslator - the id translator

digestUri - the checksum to compare against

size - the expected size of the binary

Returns:

the fixity of the datastream

delete

public void delete()

When deleting the binary, we also need to clean up the description document.

Specified by:

delete in interface FedoraResource

Overrides:

delete in class FedoraResourceImpl

getBaseVersion

public javax.jcr.version.Version getBaseVersion()

Description copied from interface: FedoraResource

Get the JCR Base version for the node

Specified by:

getBaseVersion in interface FedoraResource

Overrides:

getBaseVersion in class FedoraResourceImpl

Returns:

base version

getVersionHistory

public javax.jcr.version.VersionHistory getVersionHistory()

Description copied from interface: FedoraResource

Get JCR VersionHistory for the node.

Specified by:

getVersionHistory in interface FedoraResource

Overrides:

getVersionHistory in class FedoraResourceImpl

Returns:

version history

isVersioned

public boolean isVersioned()

Description copied from interface: FedoraResource

Check if a resource is versioned

Specified by:

isVersioned in interface FedoraResource

Overrides:

isVersioned in class FedoraResourceImpl

Returns:

whether the resource is versioned

enableVersioning

public void enableVersioning()

Description copied from interface: FedoraResource

Enable versioning

Specified by:

enableVersioning in interface FedoraResource

Overrides:

enableVersioning in class FedoraResourceImpl

disableVersioning

public void disableVersioning()

Description copied from interface: FedoraResource

Disable versioning

Specified by:

disableVersioning in interface FedoraResource

Overrides:

disableVersioning in class FedoraResourceImpl

hasMixin

public static boolean hasMixin(javax.jcr.Node node)

Check if the given node is a Fedora binary

Parameters:

node - the given node

Returns:

whether the given node is a Fedora binary