Package org.nuxeo.ecm.core.blob.binary

Class BinaryBlob

java.lang.Object

org.nuxeo.ecm.core.api.impl.blob.AbstractBlob

org.nuxeo.ecm.core.blob.binary.BinaryBlob

All Implemented Interfaces:

Serializable, Blob, ManagedBlob

public class BinaryBlob
extends AbstractBlob
implements ManagedBlob, Serializable

A Blob wrapping a Binary value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Binary	binary
protected String	key	The key, which is the binary's digest but may in addition be prefixed by a blob provider id.
protected long	length

Fields inherited from class org.nuxeo.ecm.core.api.impl.blob.AbstractBlob

digest, digestAlgorithm, encoding, filename, mimeType, TEXT_PLAIN, UTF_8

Constructor Summary

Constructors

Constructor	Description
BinaryBlob(Binary binary, String key, String filename, String mimeType, String encoding, String digest, long length)	Deprecated. since 11.5, use signature with digestAlgorithm instead
BinaryBlob(Binary binary, String key, String filename, String mimeType, String encoding, String digestAlgorithm, String digest, long length)

Method Summary

Modifier and Type	Method	Description
protected boolean	equalsStream(Blob blob)
Binary	getBinary()	Gets the Binary attached to this blob.
File	getFile()	If this blob is backed by an actual file, returns it.
String	getKey()	Gets the stored representation of this blob.
long	getLength()	Gets the data length in bytes if known.
String	getProviderId()	Gets the id of the BlobProvider managing this blob.
InputStream	getStream()	Gets an InputStream for the data of this blob.

Methods inherited from class org.nuxeo.ecm.core.api.impl.blob.AbstractBlob

equals, getByteArray, getCloseableFile, getCloseableFile, getDigest, getDigestAlgorithm, getEncoding, getFilename, getMimeType, getString, hashCode, setDigest, setDigestAlgorithm, setEncoding, setFilename, setMimeType, transferTo, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.api.Blob

getByteArray, getCloseableFile, getCloseableFile, getDigest, getDigestAlgorithm, getEncoding, getFilename, getMimeType, getString, setDigest, setDigestAlgorithm, setEncoding, setFilename, setMimeType, transferTo, transferTo

Field Detail

binary

protected final Binary binary

key

protected final String key

The key, which is the binary's digest but may in addition be prefixed by a blob provider id.

length

protected final long length

Constructor Detail

BinaryBlob

public BinaryBlob(Binary binary,
                  String key,
                  String filename,
                  String mimeType,
                  String encoding,
                  String digestAlgorithm,
                  String digest,
                  long length)

BinaryBlob

@Deprecated
public BinaryBlob(Binary binary,
                  String key,
                  String filename,
                  String mimeType,
                  String encoding,
                  String digest,
                  long length)

Deprecated.

since 11.5, use signature with digestAlgorithm instead

Method Detail

getLength

public long getLength()

Description copied from interface: Blob

Gets the data length in bytes if known.

Specified by:

getLength in interface Blob

Overrides:

getLength in class AbstractBlob

Returns:

the data length or -1 if not known

getStream

public InputStream getStream()
                      throws IOException

Description copied from interface: Blob

Gets an InputStream for the data of this blob.

The contract of Blob is that this method can be called several times and will correctly return a new InputStream each time. In other words, several reads of the Blob can be done.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Specified by:

getStream in interface Blob

Specified by:

getStream in interface ManagedBlob

Returns:

the stream

Throws:

IOException

getBinary

public Binary getBinary()

Gets the Binary attached to this blob.

Returns:

the binary

Since:

5.9.4

getKey

public String getKey()

Description copied from interface: ManagedBlob

Gets the stored representation of this blob.

Specified by:

getKey in interface ManagedBlob

Returns:

the stored representation

getProviderId

public String getProviderId()

Description copied from interface: ManagedBlob

Gets the id of the BlobProvider managing this blob.

Specified by:

getProviderId in interface ManagedBlob

Returns:

the blob provider id

getFile

public File getFile()

Description copied from interface: Blob

If this blob is backed by an actual file, returns it.

The returned file may be short-lived (temporary), so should be used immediately.

Specified by:

getFile in interface Blob

Specified by:

getFile in interface ManagedBlob

Overrides:

getFile in class AbstractBlob

Returns:

a file, or null if the blob is not backed by a file

equalsStream

protected boolean equalsStream(Blob blob)

Overrides:

equalsStream in class AbstractBlob