Package org.elasticsearch.common.blobstore.fs

Class FsBlobContainer

org.elasticsearch.common.blobstore.support.AbstractBlobContainer
org.elasticsearch.common.blobstore.fs.FsBlobContainer
All Implemented Interfaces:
BlobContainer
public class FsBlobContainer extends AbstractBlobContainer
A file system based implementation of BlobContainer. All blobs in the container are stored on a file system, the location of which is specified by the BlobPath. Note that the methods in this implementation of BlobContainer may additionally throw a if the configured does not permit read and/or write access to the underlying files.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected FsBlobStore
    blobStore
     
    protected
    path
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FsBlobContainer​(FsBlobStore blobStore, BlobPath blobPath,  path)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     blobName)
    Tests whether a blob with the given blob name exists in the container.
    <,​BlobContainer>
    children()
    Lists all child containers under this container.
    DeleteResult
    delete()
    Deletes this container and all its contents from the repository.
    void
    <> blobNames)
    Deletes the blobs with given names.
    static boolean
     blobName)
    Returns true if the blob is a leftover temporary blob.
    <,​BlobMetadata>
    listBlobs()
    Lists all blobs in the container.
    <,​BlobMetadata>
     blobNamePrefix)
    Lists all blobs in the container that match the specified prefix.
    void
     sourceBlobName,  targetBlobName, boolean failIfAlreadyExists)
     
     name)
    Creates a new for the given blob name.
     blobName, long position, long length)
    Creates a new that can be used to read the given blob starting from a specific position in the blob.
    long
    readBlobPreferredLength()
    Provides a hint to clients for a suitable length to use with BlobContainer.readBlob(String, long, long).
    static
     blobName)
     
    void
     blobName, boolean failIfAlreadyExists, boolean atomic, org.elasticsearch.core.CheckedConsumer<,​> writer)
    Write a blob by providing a consumer that will write its contents to an output stream.
    void
     blobName,  inputStream, long blobSize, boolean failIfAlreadyExists)
    Reads blob content from the input stream and writes it to the container in a new blob with the given name.
    void
     blobName, BytesReference bytes, boolean failIfAlreadyExists)
    Reads blob content from a BytesReference and writes it to the container in a new blob with the given name.
    void
     blobName, BytesReference bytes, boolean failIfAlreadyExists)
    Reads blob content from a BytesReference and writes it to the container in a new blob with the given name, using an atomic write operation if the implementation supports it.

    Methods inherited from class org.elasticsearch.common.blobstore.support.AbstractBlobContainer

    path

    Methods inherited from class java.lang.

    , , , , , , , , , ,

  • Field Details

    • blobStore

      protected final FsBlobStore blobStore

    • path

      protected final  path

  • Constructor Details

    • FsBlobContainer

      public FsBlobContainer​(FsBlobStore blobStore, BlobPath blobPath,  path)

  • Method Details

    • listBlobs

      public <,​BlobMetadata> listBlobs() throws
      Description copied from interface: BlobContainer
      Lists all blobs in the container.
      Returns:
      A map of all the blobs in the container. The keys in the map are the names of the blobs and the values are BlobMetadata, containing basic information about each blob.
      Throws:
      - if there were any failures in reading from the blob container.

    • children

      public <,​BlobContainer> children() throws
      Description copied from interface: BlobContainer
      Lists all child containers under this container. A child container is defined as a container whose BlobContainer.path() method returns a path that has this containers BlobContainer.path() return as its prefix and has one more path element than the current container's path.
      Returns:
      Map of name of the child container to child container
      Throws:
      - on failure to list child containers

    • listBlobsByPrefix

      public <,​ blobNamePrefix) throws
      Description copied from interface: BlobContainer
      Lists all blobs in the container that match the specified prefix.
      Parameters:
      blobNamePrefix - The prefix to match against blob names in the container.
      Returns:
      A map of the matching blobs in the container. The keys in the map are the names of the blobs and the values are BlobMetadata, containing basic information about each blob.
      Throws:
      - if there were any failures in reading from the blob container.

    • delete

      public DeleteResult delete() throws
      Description copied from interface: BlobContainer
      Deletes this container and all its contents from the repository.
      Returns:
      delete result
      Throws:
      - on failure

    • deleteBlobsIgnoringIfNotExists

      public void deleteBlobsIgnoringIfNotExists​(<> blobNames) throws
      Description copied from interface: BlobContainer
      Deletes the blobs with given names. This method will not throw an exception when one or multiple of the given blobs don't exist and simply ignore this case.
      Parameters:
      blobNames - the names of the blobs to delete
      Throws:
      - if a subset of blob exists but could not be deleted.

    • blobExists

      public boolean blobExists​( blobName)
      Description copied from interface: BlobContainer
      Tests whether a blob with the given blob name exists in the container.
      Parameters:
      blobName - The name of the blob whose existence is to be determined.
      Returns:
      true if a blob exists in the BlobContainer with the given name, and false otherwise.

    • readBlob

      public  readBlob​( name) throws
      Description copied from interface: BlobContainer
      Creates a new for the given blob name.
      Parameters:
      name - The name of the blob to get an for.
      Returns:
      The InputStream to read the blob.
      Throws:
      - if the blob does not exist
      - if the blob can not be read.

    • readBlob

      public  readBlob​( blobName, long position, long length) throws
      Description copied from interface: BlobContainer
      Creates a new that can be used to read the given blob starting from a specific position in the blob. The length is an indication of the number of bytes that are expected to be read from the .
      Parameters:
      blobName - The name of the blob to get an for.
      position - The position in the blob where the next byte will be read.
      length - An indication of the number of bytes to be read.
      Returns:
      The InputStream to read the blob.
      Throws:
      - if the blob does not exist
      - if the blob can not be read.

    • readBlobPreferredLength

      public long readBlobPreferredLength()
      Description copied from interface: BlobContainer
      Provides a hint to clients for a suitable length to use with BlobContainer.readBlob(String, long, long). Some blob containers have nontrivial costs attached to each readBlob call, so it is a good idea for consumers to speculatively request more data than they need right now and to re-use this stream for future needs if possible. Also, some blob containers return streams that are expensive to close before the stream has been fully consumed, and the cost may depend on the length of the data that was left unconsumed. For these containers it's best to bound the cost of a partial read by bounding the length of the data requested.
      Returns:
      a hint to consumers regarding the length of data to request if there is a good chance that future reads can be satisfied from the same stream.

    • writeBlob

      public void writeBlob​( blobName,  inputStream, long blobSize, boolean failIfAlreadyExists) throws
      Description copied from interface: BlobContainer
      Reads blob content from the input stream and writes it to the container in a new blob with the given name. This method assumes the container does not already contain a blob of the same blobName. If a blob by the same name already exists, the operation will fail and an will be thrown.
      Parameters:
      blobName - The name of the blob to write the contents of the input stream to.
      inputStream - The input stream from which to retrieve the bytes to write to the blob.
      blobSize - The size of the blob to be written, in bytes. It is implementation dependent whether this value is used in writing the blob to the repository.
      failIfAlreadyExists - whether to throw a FileAlreadyExistsException if the given blob already exists
      Throws:
      - if failIfAlreadyExists is true and a blob by the same name already exists
      - if the input stream could not be read, or the target blob could not be written to.

    • writeBlob

      public void writeBlob​( blobName, BytesReference bytes, boolean failIfAlreadyExists) throws
      Description copied from interface: BlobContainer
      Reads blob content from a BytesReference and writes it to the container in a new blob with the given name.
      Parameters:
      blobName - The name of the blob to write the contents of the input stream to.
      bytes - The bytes to write
      failIfAlreadyExists - whether to throw a FileAlreadyExistsException if the given blob already exists
      Throws:
      - if failIfAlreadyExists is true and a blob by the same name already exists
      - if the input stream could not be read, or the target blob could not be written to.

    • writeBlob

      public void writeBlob​( blobName, boolean failIfAlreadyExists, boolean atomic, org.elasticsearch.core.CheckedConsumer<,​> writer) throws
      Description copied from interface: BlobContainer
      Write a blob by providing a consumer that will write its contents to an output stream. This method allows serializing a blob's contents directly to the blob store without having to materialize the serialized version in full before writing.
      Parameters:
      blobName - the name of the blob to write
      failIfAlreadyExists - whether to throw a FileAlreadyExistsException if the given blob already exists
      atomic - whether the write should be atomic in case the implementation supports it
      writer - consumer for an output stream that will write the blob contents to the stream
      Throws:

    • writeBlobAtomic

      public void writeBlobAtomic​( blobName, BytesReference bytes, boolean failIfAlreadyExists) throws
      Description copied from interface: BlobContainer
      Reads blob content from a BytesReference and writes it to the container in a new blob with the given name, using an atomic write operation if the implementation supports it.
      Parameters:
      blobName - The name of the blob to write the contents of the input stream to.
      bytes - The bytes to write
      failIfAlreadyExists - whether to throw a FileAlreadyExistsException if the given blob already exists
      Throws:
      - if failIfAlreadyExists is true and a blob by the same name already exists
      - if the input stream could not be read, or the target blob could not be written to.

    • moveBlobAtomic

      public void moveBlobAtomic​( sourceBlobName,  targetBlobName, boolean failIfAlreadyExists) throws
      Throws:

    • tempBlobName

      public static  tempBlobName​( blobName)

    • isTempBlobName

      public static boolean isTempBlobName​( blobName)
      Returns true if the blob is a leftover temporary blob. The temporary blobs might be left after failed atomic write operation.