Package org.yamcs.buckets

Class RemoteYamcsBucket

java.lang.Object

org.yamcs.buckets.Bucket

org.yamcs.buckets.RemoteYamcsBucket

public class RemoteYamcsBucket
extends Bucket

Nested Class Summary

Nested classes/interfaces inherited from class org.yamcs.buckets.Bucket

Bucket.AccessRuleType

Field Summary

Fields

Modifier and Type	Field	Description
static final BucketLocation	LOCATION

Constructor Summary

Constructors

Constructor	Description
RemoteYamcsBucket(String localName, Bucket bucketClient)

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()
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
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.

Methods inherited from class org.yamcs.buckets.Bucket

getAccessRules, hasAccessRules, listObjectsAsync, listObjectsAsync, listObjectsAsync, setAccessRules

Methods inherited from class java.lang.Object

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

Field Details

LOCATION

public static final BucketLocation LOCATION

Constructor Details

RemoteYamcsBucket

public RemoteYamcsBucket(String localName,
 Bucket bucketClient)

Method Details

getLocation

public BucketLocation getLocation()

Description copied from class: Bucket

Bucket location

Specified by:

getLocation in class Bucket

getName

public String getName()

Description copied from class: Bucket

This bucket's name

Specified by:

getName in class Bucket

getPropertiesAsync

public CompletableFuture<BucketProperties> getPropertiesAsync()

Specified by:

getPropertiesAsync in class Bucket

setMaxSize

public void setMaxSize(long maxSize)
                throws IOException

Description copied from class: Bucket

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.

Specified by:

setMaxSize in class Bucket

Throws:

IOException

setMaxObjects

public void setMaxObjects(int maxObjects)
                   throws IOException

Description copied from class: Bucket

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.

Specified by:

setMaxObjects in class Bucket

Throws:

IOException

listObjectsAsync

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

Description copied from class: Bucket

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

Specified by:

listObjectsAsync in class Bucket

p - predicate to be matched by the returned objects

Returns:

list of objects

putObjectAsync

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

Specified by:

putObjectAsync in class Bucket

getObjectAsync

public CompletableFuture<byte[]> getObjectAsync(String objectName)

Description copied from class: Bucket

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

Specified by:

getObjectAsync in class Bucket

deleteObjectAsync

public CompletableFuture<Void> deleteObjectAsync(String objectName)

Specified by:

deleteObjectAsync in class Bucket

findObjectAsync

public CompletableFuture<ObjectProperties> findObjectAsync(String objectName)

Description copied from class: Bucket

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

Specified by:

findObjectAsync in class Bucket