Package org.yamcs.buckets

Interface Bucket

All Known Implementing Classes:

FileSystemBucket, RdbBucket, RemoteYamcsBucket

public interface Bucket

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	deleteObjectAsync(String objectName)
CompletableFuture<ObjectProperties>	findObjectAsync(String objectName)	Retrieve the object properties or null if not such an object exist
BucketLocation	getLocation()	Bucket location
String	getName()	This bucket's name
CompletableFuture<byte[]>	getObjectAsync(String objectName)	Retrieve object from the bucket.
CompletableFuture<BucketProperties>	getPropertiesAsync()
default CompletableFuture<List<ObjectProperties>>	listObjectsAsync()
default CompletableFuture<List<ObjectProperties>>	listObjectsAsync(String prefix)
CompletableFuture<List<ObjectProperties>>	listObjectsAsync(String prefix, Predicate<ObjectProperties> p)	retrieve objects whose name start with prefix and that match the condition Note that searching by prefix is cheap, the condition will be evaluated for all objects that match the prefix
default CompletableFuture<List<ObjectProperties>>	listObjectsAsync(Predicate<ObjectProperties> p)
CompletableFuture<Void>	putObjectAsync(String objectName, String contentType, Map<String,String> metadata, byte[] objectData)
void	setMaxObjects(int maxObjects)	Update the object count limit for this bucket.
void	setMaxSize(long maxSize)	Update the size limit for this bucket.

Method Details

getLocation

BucketLocation getLocation()

Bucket location

getName

String getName()

This bucket's name

getPropertiesAsync

CompletableFuture<BucketProperties> getPropertiesAsync()

setMaxSize

void setMaxSize(long maxSize)
         throws IOException

Update the size limit for this bucket.

If the specified size is smaller than the current size, the bucket will no longer accept new files.

Throws:

IOException

setMaxObjects

void setMaxObjects(int maxObjects)
            throws IOException

Update the object count limit for this bucket.

If the specified count is smaller than the current count, the bucket will no longer accept new files.

Throws:

IOException

listObjectsAsync

default CompletableFuture<List<ObjectProperties>> listObjectsAsync()

listObjectsAsync

default CompletableFuture<List<ObjectProperties>> listObjectsAsync(String prefix)

listObjectsAsync

default CompletableFuture<List<ObjectProperties>> listObjectsAsync(Predicate<ObjectProperties> p)

listObjectsAsync

CompletableFuture<List<ObjectProperties>> listObjectsAsync(String prefix,
 Predicate<ObjectProperties> p)

retrieve objects whose name start with prefix and that match the condition Note that searching by prefix is cheap, the condition will be evaluated for all objects that match the prefix

Parameters:

prefix -

p - predicate to be matched by the returned objects

Returns:

list of objects

putObjectAsync

CompletableFuture<Void> putObjectAsync(String objectName,
 String contentType,
 Map<String,String> metadata,
 byte[] objectData)

getObjectAsync

CompletableFuture<byte[]> getObjectAsync(String objectName)

Retrieve object from the bucket. Returns null if object does not exist.

deleteObjectAsync

CompletableFuture<Void> deleteObjectAsync(String objectName)

findObjectAsync

CompletableFuture<ObjectProperties> findObjectAsync(String objectName)

Retrieve the object properties or null if not such an object exist