Class LocalStorageOperations

java.lang.Object

io.micronaut.objectstorage.local.LocalStorageOperations

All Implemented Interfaces:

ObjectStorageOperations<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

@EachBean(LocalStorageConfiguration.class)
@Requires(condition=ToggeableCondition.class) @Requires(beans=LocalStorageConfiguration.class)
@Primary
public class LocalStorageOperations
extends Object
implements ObjectStorageOperations<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

An implementation of ObjectStorageOperations that uses the local file system. Useful for testing.

Since:

2.0.0

Author:

Álvaro Sánchez-Mariscal

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	LocalStorageOperations.LocalStorageFile	A simple wrapper around a path.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
LocalStorageOperations(LocalStorageConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	copy(@NonNull String sourceKey, @NonNull String destinationKey)	Copies an object stored at sourceKey to destinationKey, within the same object storage (bucket/container).
@NonNull LocalStorageOperations.LocalStorageFile	delete(@NonNull String key)	Deletes an object from the object storage.
boolean	exists(@NonNull String key)	Checks whether an entry with the given key exists in the object storage.
@NonNull Set<String>	listObjects()	Lists the objects that exist in the object storage.
@NonNull ListObjectsResponse	listObjects(@NonNull ListObjectsRequest request)	Lists a page of objects that exist in the object storage.
@NonNull Optional<LocalStorageEntry>	retrieve(@NonNull String key)	Gets the object from object storage.
@NonNull UploadResponse<LocalStorageOperations.LocalStorageFile>	upload(@NonNull UploadRequest request)	Uploads an object to the object storage.
@NonNull UploadResponse<LocalStorageOperations.LocalStorageFile>	upload(@NonNull UploadRequest request, @NonNull Consumer<LocalStorageOperations.LocalStorageFile> requestConsumer)	Uploads an object to the object storage.

Methods inherited from class Object

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

Field Details

METADATA_DIRECTORY

public static final String METADATA_DIRECTORY

See Also:

• Constant Field Values

Constructor Details

LocalStorageOperations

public LocalStorageOperations(@Parameter
 LocalStorageConfiguration configuration)

Method Details

upload

public @NonNull UploadResponse<LocalStorageOperations.LocalStorageFile> 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<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

request - the upload request

Returns:

the upload response

upload

public @NonNull UploadResponse<LocalStorageOperations.LocalStorageFile> upload(@NonNull UploadRequest request,
 @NonNull Consumer<LocalStorageOperations.LocalStorageFile> 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<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

request - the upload request

requestConsumer - Upload request builder consumer

Returns:

the upload response

retrieve

public @NonNull Optional<LocalStorageEntry> retrieve(@NonNull String key)

Description copied from interface: ObjectStorageOperations

Gets the object from object storage.

Specified by:

retrieve in interface ObjectStorageOperations<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

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

Returns:

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

delete

public @NonNull LocalStorageOperations.LocalStorageFile delete(@NonNull String key)

Description copied from interface: ObjectStorageOperations

Deletes an object from the object storage.

Specified by:

delete in interface ObjectStorageOperations<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

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

Returns:

Cloud vendor-specific delete response.

exists

public boolean exists(@NonNull 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<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

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

Returns:

true if the entry exists, false otherwise.

listObjects

public @NonNull Set<String> listObjects()

Description copied from interface: ObjectStorageOperations

Lists the objects that exist in the object storage.

Specified by:

listObjects in interface ObjectStorageOperations<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Returns:

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

listObjects

public @NonNull ListObjectsResponse listObjects(@NonNull ListObjectsRequest request)

Description copied from interface: ObjectStorageOperations

Lists a page of objects that exist in the object storage.

Specified by:

listObjects in interface ObjectStorageOperations<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

request - the paginated listing request

Returns:

the ordered keys in the current page and an optional continuation token for the next page

copy

public void copy(@NonNull String sourceKey,
 @NonNull 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<LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile, LocalStorageOperations.LocalStorageFile>

Parameters:

sourceKey - the key of the source object

destinationKey - the key of the destination object