io.micronaut.objectstorage.azure

Class AzureBlobStorageOperations

java.lang.Object

io.micronaut.objectstorage.azure.AzureBlobStorageOperations

All Implemented Interfaces:

ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

@EachBean(value=com.azure.storage.blob.BlobContainerClient.class)
 @Singleton
public class AzureBlobStorageOperations
extends java.lang.Object
implements ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Azure implementation of ObjectStorageOperations.

Since:

1.0

Author:

Pavol Gressa

Constructor Summary

Constructors

Constructor and Description
AzureBlobStorageOperations(com.azure.storage.blob.BlobContainerClient blobContainerClient)

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String sourceKey, java.lang.String destinationKey) Copies an object stored at sourceKey to destinationKey, within the same object storage (bucket/container).
com.azure.core.http.rest.Response<java.lang.Void>	delete(java.lang.String key) Deletes an object from the object storage.
boolean	exists(java.lang.String key) Checks whether an entry with the given key exists in the object storage.
protected com.azure.storage.blob.options.BlobParallelUploadOptions	getUploadOptions(UploadRequest request)
java.util.Set<java.lang.String>	listObjects() Lists the objects that exist in the object storage.
java.util.Optional<AzureBlobStorageEntry>	retrieve(java.lang.String key) Gets the object from object storage.
UploadResponse<com.azure.storage.blob.models.BlockBlobItem>	upload(UploadRequest request) Uploads an object to the object storage.
UploadResponse<com.azure.storage.blob.models.BlockBlobItem>	upload(UploadRequest request, java.util.function.Consumer<com.azure.storage.blob.options.BlobParallelUploadOptions> requestConsumer) Uploads an object to the object storage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AzureBlobStorageOperations

public AzureBlobStorageOperations(@Parameter
                                  com.azure.storage.blob.BlobContainerClient blobContainerClient)

Method Detail

upload

@NonNull
public UploadResponse<com.azure.storage.blob.models.BlockBlobItem> upload(@NonNull
                                                                                   UploadRequest request)

Description copied from interface: ObjectStorageOperations

Uploads an object to the object storage. If there is an existing entry, it will be updated.

Specified by:

upload in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Parameters:

request - the upload request

Returns:

the upload response

upload

@NonNull
public UploadResponse<com.azure.storage.blob.models.BlockBlobItem> upload(@NonNull
                                                                                   UploadRequest request,
                                                                                   @NonNull
                                                                                   java.util.function.Consumer<com.azure.storage.blob.options.BlobParallelUploadOptions> requestConsumer)

Description copied from interface: ObjectStorageOperations

Uploads an object to the object storage. If there is an existing entry, it will be updated.

Specified by:

upload in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Parameters:

request - the upload request

requestConsumer - Upload request builder consumer

Returns:

the upload response

retrieve

@NonNull
public java.util.Optional<AzureBlobStorageEntry> retrieve(@NonNull
                                                                   java.lang.String key)

Description copied from interface: ObjectStorageOperations

Gets the object from object storage.

Specified by:

retrieve in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Parameters:

key - the object path in the format /foo/bar/file

Returns:

the object, or empty optional if the object does not exist

delete

@NonNull
public com.azure.core.http.rest.Response<java.lang.Void> delete(@NonNull
                                                                         java.lang.String key)

Description copied from interface: ObjectStorageOperations

Deletes an object from the object storage.

Specified by:

delete in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Parameters:

key - object path in the format /foo/bar/file

Returns:

Cloud vendor-specific delete response.

exists

public boolean exists(@NonNull
                      java.lang.String key)

Description copied from interface: ObjectStorageOperations

Checks whether an entry with the given key exists in the object storage.

Specified by:

exists in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Parameters:

key - object path in the format /foo/bar/file

Returns:

true if the entry exists, false otherwise.

listObjects

@NonNull
public java.util.Set<java.lang.String> listObjects()

Description copied from interface: ObjectStorageOperations

Lists the objects that exist in the object storage.

Specified by:

listObjects in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Returns:

a list of keys (paths) of the existing objects, if any, or an empty list otherwise.

copy

@NonNull
public void copy(@NonNull
                          java.lang.String sourceKey,
                          @NonNull
                          java.lang.String destinationKey)

Description copied from interface: ObjectStorageOperations

Copies an object stored at sourceKey to destinationKey, within the same object storage (bucket/container). If the destination exists, it will be overwritten.

Specified by:

copy in interface ObjectStorageOperations<com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.storage.blob.models.BlockBlobItem,com.azure.core.http.rest.Response<java.lang.Void>>

Parameters:

sourceKey - the key of the source object

destinationKey - the key of the destination object

getUploadOptions

@NonNull
protected com.azure.storage.blob.options.BlobParallelUploadOptions getUploadOptions(@NonNull
                                                                                             UploadRequest request)

Parameters:

request - the upload request

Returns:

An Azure's BlobParallelUploadOptions from a Micronaut's UploadRequest.