Interface BlobRequestSigner

All Known Implementing Classes:
AtmosBlobRequestSigner, AWSS3BlobRequestSignerV4, AzureBlobRequestSigner, GoogleCloudStorageBlobRequestSigner, LocalBlobRequestSigner, RegionScopedTemporaryUrlBlobSigner, RequestSigningUnsupported, S3BlobRequestSigner

public interface BlobRequestSigner
Generates signed requests for blobs. useful in other tools such as backup utilities.
  • Method Summary

    Modifier and Type
    Method
    Description
    signGetBlob(String container, String name)
    gets a signed request, including headers as necessary, to access a blob from an external client.
    signGetBlob(String container, String name, long timeInSeconds)
    gets a signed request, including headers as necessary, to allow access to a blob from an external client for a limited period of time
    signGetBlob(String container, String name, GetOptions options)
     
    signPutBlob(String container, Blob blob)
    gets a signed request, including headers as necessary, to upload a blob from an external client.
    signPutBlob(String container, Blob blob, long timeInSeconds)
    gets a signed request, including headers as necessary, to upload a blob from an external client for a limited period of time
  • Method Details

    • signGetBlob

      HttpRequest signGetBlob(String container, String name)
      gets a signed request, including headers as necessary, to access a blob from an external client.
      Parameters:
      container - container where the blob resides
      directory - full path to the blob
      Throws:
      UnsupportedOperationException - if not supported by the provider
    • signGetBlob

      @Beta HttpRequest signGetBlob(String container, String name, long timeInSeconds)
      gets a signed request, including headers as necessary, to allow access to a blob from an external client for a limited period of time
      Parameters:
      timeInSeconds - validity time in seconds for the generated request
      See Also:
    • signGetBlob

      HttpRequest signGetBlob(String container, String name, GetOptions options)
      Parameters:
      options -
      See Also:
    • signPutBlob

      HttpRequest signPutBlob(String container, Blob blob)
      gets a signed request, including headers as necessary, to upload a blob from an external client.
       Blob blob = context.getBlobStore.blobBuilder().name("name").forSigning().contentType("text/plain")
                .contentLength(length).build();
       
      Parameters:
      container - container where the blob resides
      blob - what to upload
      Throws:
      UnsupportedOperationException - if not supported by the provider
      See Also:
      • invalid reference
        BlobBuilder#forSigning
    • signPutBlob

      @Beta HttpRequest signPutBlob(String container, Blob blob, long timeInSeconds)
      gets a signed request, including headers as necessary, to upload a blob from an external client for a limited period of time
      Parameters:
      timeInSeconds - validity time in seconds for the generated request
      See Also: