java.lang.Object

org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

All Implemented Interfaces:: BinaryManager

Direct Known Subclasses:: CachingBinaryManager, GridFSBinaryManager, LocalBinaryManager

@Deprecated(since="2023.9") public abstract class AbstractBinaryManager extends Object implements BinaryManager

Deprecated.

since 2023.9, prefer BlobStoreBlobProvider implementation instead

Abstract BinaryManager implementation that provides a few utilities

Author:: Florent Guillaume

Field Summary

Fields

Modifier and Type

Field

Description

String

blobProviderId

Deprecated.

static final int

DEFAULT_DEPTH

Deprecated.

static final String

DEFAULT_DIGEST

Deprecated.

protected BinaryManagerRootDescriptor

descriptor

Deprecated.

protected Pattern

digestPattern

Deprecated.

static final Map<Integer,String>

DIGESTS_BY_LENGTH

Deprecated.

protected BinaryGarbageCollector

garbageCollector

Deprecated.

static final int

MAX_BUF_SIZE

Deprecated.

static final String

MD5_DIGEST

Deprecated.

static final int

MD5_DIGEST_LENGTH

Deprecated.
since 11.1, unused

static final int

MIN_BUF_SIZE

Deprecated.

protected Map<String,String>

properties

Deprecated.

static final String

SHA1_DIGEST

Deprecated.
since 11.1, unused

static final int

SHA1_DIGEST_LENGTH

Deprecated.
since 11.1, unused

static final String

SHA256_DIGEST

Deprecated.
since 11.1, unused

static final int

SHA256_DIGEST_LENGTH

Deprecated.
since 11.1, unused

Fields inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager
PROP_KEY, PROP_PATH
Constructor Summary

Constructors

Constructor

Description

AbstractBinaryManager()

Deprecated.
Method Summary

Modifier and Type

Method

Description

protected void

computeDigestPattern()

Deprecated.

protected abstract Binary

getBinary(InputStream in)

Deprecated.

Creates a binary value from the given input stream.

abstract Binary

getBinary(String digest)

Deprecated.

Returns a Binary corresponding to the given digest.

Binary

getBinary(Blob blob)

Deprecated.

Saves the given blob into a Binary.

protected String

getDefaultDigestAlgorithm()

Deprecated.

Gets the default message digest to use to hash binaries.

protected BinaryManagerRootDescriptor

getDescriptor(File configFile)

Deprecated.

Gets existing descriptor or creates a default one.

String

getDigestAlgorithm()

Deprecated.

Returns the digest algorithm used to store and digest binaries.

BinaryGarbageCollector

getGarbageCollector()

Deprecated.

Returns the Binary Garbage Collector that can be used for this binary manager.

void

initialize(String blobProviderId, Map<String,String> properties)

Deprecated.

Initializes the binary manager.

boolean

isValidDigest(String digest)

Deprecated.

void

removeBinaries(Collection<String> digests)

Deprecated.

Remove definitively a set of binaries

protected void

setDescriptor(BinaryManagerRootDescriptor descriptor)

Deprecated.

protected String

storeAndDigest(InputStream in, OutputStream out)

Deprecated.

static String

toHexString(byte[] data)

Deprecated.
since 11.1, use Hex.encodeHexString(byte[]) directly

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager
close

Field Details
- MD5_DIGEST
  
  public static final String MD5_DIGEST
  
  Deprecated.
  See Also:
  
  Constant Field Values
- SHA1_DIGEST
  
  @Deprecated public static final String SHA1_DIGEST
  
  Deprecated.
  since 11.1, unused
  See Also:
  
  Constant Field Values
- SHA256_DIGEST
  
  @Deprecated public static final String SHA256_DIGEST
  
  Deprecated.
  since 11.1, unused
  See Also:
  
  Constant Field Values
- MD5_DIGEST_LENGTH
  
  @Deprecated public static final int MD5_DIGEST_LENGTH
  
  Deprecated.
  since 11.1, unused
  See Also:
  
  Constant Field Values
- SHA1_DIGEST_LENGTH
  
  @Deprecated public static final int SHA1_DIGEST_LENGTH
  
  Deprecated.
  since 11.1, unused
  See Also:
  
  Constant Field Values
- SHA256_DIGEST_LENGTH
  
  @Deprecated public static final int SHA256_DIGEST_LENGTH
  
  Deprecated.
  since 11.1, unused
  See Also:
  
  Constant Field Values
- DIGESTS_BY_LENGTH
  
  public static final Map<Integer,String> DIGESTS_BY_LENGTH
  
  Deprecated.
  
  Since:
  
  7.4
- DEFAULT_DIGEST
  
  public static final String DEFAULT_DIGEST
  
  Deprecated.
  See Also:
  
  Constant Field Values
- DEFAULT_DEPTH
  
  public static final int DEFAULT_DEPTH
  
  Deprecated.
  See Also:
  
  Constant Field Values
- blobProviderId
  
  public String blobProviderId
  
  Deprecated.
- properties
  
  protected Map<String,String> properties
  
  Deprecated.
- descriptor
  
  protected BinaryManagerRootDescriptor descriptor
  
  Deprecated.
- garbageCollector
  
  protected BinaryGarbageCollector garbageCollector
  
  Deprecated.
- digestPattern
  
  protected Pattern digestPattern
  
  Deprecated.
- MIN_BUF_SIZE
  
  public static final int MIN_BUF_SIZE
  
  Deprecated.
  See Also:
  
  Constant Field Values
- MAX_BUF_SIZE
  
  public static final int MAX_BUF_SIZE
  
  Deprecated.
  See Also:
  
  Constant Field Values
Constructor Details
- AbstractBinaryManager
  
  public AbstractBinaryManager()
  
  Deprecated.
Method Details
- initialize
  
  public void initialize(String blobProviderId, Map<String,String> properties) throws IOException
  
  Deprecated.
  
  Description copied from interface: BinaryManager
  
  Initializes the binary manager.
  
  Specified by:
  
  initialize in interface BinaryManager
  
  Parameters:
  
  blobProviderId - the blob provider id for this binary manager
  
  properties - initialization properties
  
  Throws:
  
  IOException
- setDescriptor
  
  protected void setDescriptor(BinaryManagerRootDescriptor descriptor)
  
  Deprecated.
- getBinary
  
  protected abstract Binary getBinary(InputStream in) throws IOException
  
  Deprecated.
  
  Creates a binary value from the given input stream.
  
  Throws:
  
  IOException
- getBinary
  
  public Binary getBinary(Blob blob) throws IOException
  
  Deprecated.
  
  Description copied from interface: BinaryManager
  
  Saves the given blob into a Binary.
  Returns a Binary representing the stream. The Binary includes a digest that is a sufficient representation to persist it.
  If the blob is a temporary FileBlob, then the temporary file may be reused as the final storage location after being moved.
  
  Specified by:
  
  getBinary in interface BinaryManager
  
  Parameters:
  
  blob - the blob
  
  Returns:
  
  the corresponding binary
  
  Throws:
  
  IOException
- getBinary
  
  public abstract Binary getBinary(String digest)
  
  Deprecated.
  
  Description copied from interface: BinaryManager
  
  Returns a Binary corresponding to the given digest.
  A null is returned if the digest could not be found.
  
  Specified by:
  
  getBinary in interface BinaryManager
  
  Parameters:
  
  digest - the digest, or null
  
  Returns:
  
  the corresponding binary
- removeBinaries
  
  public void removeBinaries(Collection<String> digests)
  
  Deprecated.
  
  Description copied from interface: BinaryManager
  
  Remove definitively a set of binaries
  
  Specified by:
  
  removeBinaries in interface BinaryManager
  
  Parameters:
  
  digests - a set of digests, must not be null.
- getDescriptor
  
  protected BinaryManagerRootDescriptor getDescriptor(File configFile) throws IOException
  
  Deprecated.
  
  Gets existing descriptor or creates a default one.
  
  Throws:
  
  IOException
- storeAndDigest
  
  protected String storeAndDigest(InputStream in, OutputStream out) throws IOException
  
  Deprecated.
  
  Throws:
  
  IOException
- toHexString
  
  @Deprecated public static String toHexString(byte[] data)
  
  Deprecated.
  since 11.1, use Hex.encodeHexString(byte[]) directly
- computeDigestPattern
  
  protected void computeDigestPattern()
  
  Deprecated.
- isValidDigest
  
  public boolean isValidDigest(String digest)
  
  Deprecated.
- getGarbageCollector
  
  public BinaryGarbageCollector getGarbageCollector()
  
  Deprecated.
  
  Description copied from interface: BinaryManager
  
  Returns the Binary Garbage Collector that can be used for this binary manager.
  Several calls to this method will return the same GC, so that its status can be monitored using BinaryGarbageCollector.isInProgress().
  
  Specified by:
  
  getGarbageCollector in interface BinaryManager
  
  Returns:
  
  the binary GC
- getDigestAlgorithm
  
  public String getDigestAlgorithm()
  
  Deprecated.
  
  Description copied from interface: BinaryManager
  
  Returns the digest algorithm used to store and digest binaries.
  
  Specified by:
  
  getDigestAlgorithm in interface BinaryManager
- getDefaultDigestAlgorithm
  
  protected String getDefaultDigestAlgorithm()
  
  Deprecated.
  
  Gets the default message digest to use to hash binaries.
  
  Since:
  
  6.0

Class AbstractBinaryManager

Field Summary

Fields inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager

Field Details

MD5_DIGEST

SHA1_DIGEST

SHA256_DIGEST

MD5_DIGEST_LENGTH

SHA1_DIGEST_LENGTH

SHA256_DIGEST_LENGTH

DIGESTS_BY_LENGTH

DEFAULT_DIGEST

DEFAULT_DEPTH

blobProviderId

properties

descriptor

garbageCollector

digestPattern

MIN_BUF_SIZE

MAX_BUF_SIZE

Constructor Details

AbstractBinaryManager

Method Details

initialize

setDescriptor

getBinary

getBinary

getBinary

removeBinaries

getDescriptor

storeAndDigest

toHexString

computeDigestPattern

isValidDigest

getGarbageCollector

getDigestAlgorithm

getDefaultDigestAlgorithm