Package it.pagopa.swclient.mil.azureservices.storageblob.client

Interface AzureStorageBlobClient

@RegisterRestClient(configKey="azure-storage-blob") @ClientHeaderParam(name="x-ms-version",value="${azure-storage-blob.version}") @ClientHeaderParam(name="Authorization",value="Bearer {accessToken}") public interface AzureStorageBlobClient

REST client for Azure Storage Blob.

To use this client, the application.properties must have the definition of the following properties:

  • quarkus.rest-client.azure-storage-blob.url must be set with the URL of Azure Storage Blob;
  • azure-storage-blob.api-version must be 2019-07-07.
Author:
Antonio Tarricone

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String filename)
    Returns a blob with the given file name.
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String segment1, String filename)
    Returns a blob with the given file name and path.
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String segment1, String segment2, String filename)
    Returns a blob with the given file name and path.
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String segment1, String segment2, String segment3, String filename)
    Returns a blob with the given file name and path.
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String segment1, String segment2, String segment3, String segment4, String filename)
    Returns a blob with the given file name and path.
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String segment1, String segment2, String segment3, String segment4, String segment5, String filename)
    Returns a blob with the given file name and path.
    jakarta.ws.rs.core.Response
    getBlob(String accessToken, String segment1, String segment2, String segment3, String segment4, String segment5, String segment6, String filename)
    Returns a blob with the given file name and path.

  • Method Details

    • getBlob

      @Path("{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("filename") String filename)

      Returns a blob with the given file name.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.

    • getBlob

      @Path("{segment1}/{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("segment1") String segment1, @PathParam("filename") String filename)

      Returns a blob with the given file name and path.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      segment1 - Segment of the path to file to retrieve.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.

    • getBlob

      @Path("{segment1}/{segment2}/{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("segment1") String segment1, @PathParam("segment2") String segment2, @PathParam("filename") String filename)

      Returns a blob with the given file name and path.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      segment1 - Segment of the path to file to retrieve.
      segment2 - Segment of the path to file to retrieve.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.

    • getBlob

      @Path("{segment1}/{segment2}/{segment3}/{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("segment1") String segment1, @PathParam("segment2") String segment2, @PathParam("segment3") String segment3, @PathParam("filename") String filename)

      Returns a blob with the given file name and path.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      segment1 - Segment of the path to file to retrieve.
      segment2 - Segment of the path to file to retrieve.
      segment3 - Segment of the path to file to retrieve.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.

    • getBlob

      @Path("{segment1}/{segment2}/{segment3}/{segment4}/{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("segment1") String segment1, @PathParam("segment2") String segment2, @PathParam("segment3") String segment3, @PathParam("segment4") String segment4, @PathParam("filename") String filename)

      Returns a blob with the given file name and path.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      segment1 - Segment of the path to file to retrieve.
      segment2 - Segment of the path to file to retrieve.
      segment3 - Segment of the path to file to retrieve.
      segment4 - Segment of the path to file to retrieve.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.

    • getBlob

      @Path("{segment1}/{segment2}/{segment3}/{segment4}/{segment5}/{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("segment1") String segment1, @PathParam("segment2") String segment2, @PathParam("segment3") String segment3, @PathParam("segment4") String segment4, @PathParam("segment5") String segment5, @PathParam("filename") String filename)

      Returns a blob with the given file name and path.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      segment1 - Segment of the path to file to retrieve.
      segment2 - Segment of the path to file to retrieve.
      segment3 - Segment of the path to file to retrieve.
      segment4 - Segment of the path to file to retrieve.
      segment5 - Segment of the path to file to retrieve.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.

    • getBlob

      @Path("{segment1}/{segment2}/{segment3}/{segment4}/{segment5}/{segment6}/{filename}") @GET jakarta.ws.rs.core.Response getBlob(@NotBody String accessToken, @PathParam("segment1") String segment1, @PathParam("segment2") String segment2, @PathParam("segment3") String segment3, @PathParam("segment4") String segment4, @PathParam("segment5") String segment5, @PathParam("segment6") String segment6, @PathParam("filename") String filename)

      Returns a blob with the given file name and path.

      Parameters:
      accessToken - The value of access token got by Microsoft Entra ID.
      segment1 - Segment of the path to file to retrieve.
      segment2 - Segment of the path to file to retrieve.
      segment3 - Segment of the path to file to retrieve.
      segment4 - Segment of the path to file to retrieve.
      segment5 - Segment of the path to file to retrieve.
      segment6 - Segment of the path to file to retrieve.
      filename - The name of file to retrieve.
      Returns:
      If the file is retrieved successfully, the response body contains it.