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

Interface BinaryManager

All Known Implementing Classes:
AbstractBinaryManager, AbstractCloudBinaryManager, AESBinaryManager, AzureBinaryManager, AzureCDNBinaryManager, CachingBinaryManager, CloudFrontBinaryManager, DefaultBinaryManager, GoogleStorageBinaryManager, GridFSBinaryManager, LocalBinaryManager, S3BinaryManager
@Deprecated(since="2023.9") public interface BinaryManager
Deprecated.
since 2023.9, use BlobProvider instead
A binary manager stores binaries according to their digest.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROP_KEY
    Deprecated.
    In the initialization properties, the property for a generic key.
    static final String
    PROP_PATH
    Deprecated.
    In the initialization properties, the property for the store path.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Deprecated.
    Closes the binary manager and releases all resources and temporary objects held by it.
    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.
    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.
    void
    removeBinaries(Collection<String> digests)
    Deprecated.
    Remove definitively a set of binaries

  • Field Details

    • PROP_PATH

      static final String PROP_PATH
      Deprecated.
      In the initialization properties, the property for the store path.
      See Also:

    • PROP_KEY

      static final String PROP_KEY
      Deprecated.
      In the initialization properties, the property for a generic key.
      See Also:

  • Method Details

    • initialize

      void initialize(String blobProviderId, Map<String,String> properties) throws IOException
      Deprecated.
      Initializes the binary manager.
      Parameters:
      blobProviderId - the blob provider id for this binary manager
      properties - initialization properties
      Throws:
      IOException
      Since:
      7.3

    • getBinary

      Binary getBinary(Blob blob) throws IOException
      Deprecated.
      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.

      Parameters:
      blob - the blob
      Returns:
      the corresponding binary
      Throws:
      IOException
      Since:
      7.2

    • getBinary

      Binary getBinary(String digest)
      Deprecated.
      Returns a Binary corresponding to the given digest.

      A null is returned if the digest could not be found.

      Parameters:
      digest - the digest, or null
      Returns:
      the corresponding binary

    • removeBinaries

      void removeBinaries(Collection<String> digests)
      Deprecated.
      Remove definitively a set of binaries
      Parameters:
      digests - a set of digests, must not be null.
      Since:
      7.10

    • getGarbageCollector

      BinaryGarbageCollector getGarbageCollector()
      Deprecated.
      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().

      Returns:
      the binary GC

    • close

      void close()
      Deprecated.
      Closes the binary manager and releases all resources and temporary objects held by it.

    • getDigestAlgorithm

      String getDigestAlgorithm()
      Deprecated.
      Returns the digest algorithm used to store and digest binaries.
      Since:
      7.4