Package org.yamcs.buckets

Class Bucket

java.lang.Object

org.yamcs.buckets.Bucket

Direct Known Subclasses:

FileSystemBucket, RdbBucket, RemoteYamcsBucket

public abstract class Bucket
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Bucket.AccessRuleType

Constructor Summary

Constructors

Constructor	Description
Bucket()

Method Summary

Modifier and Type	Method	Description
abstract CompletableFuture<Void>	deleteObjectAsync(String objectName)
abstract CompletableFuture<ObjectProperties>	findObjectAsync(String objectName)	Retrieve the object properties or null if not such an object exist
Map<String,List<PathMatcher>>	getAccessRules(Bucket.AccessRuleType type)
abstract BucketLocation	getLocation()	Bucket location
abstract String	getName()	This bucket's name
abstract CompletableFuture<byte[]>	getObjectAsync(String objectName)	Retrieve object from the bucket.
abstract CompletableFuture<BucketProperties>	getPropertiesAsync()
boolean	hasAccessRules(Bucket.AccessRuleType type)
CompletableFuture<List<ObjectProperties>>	listObjectsAsync()
CompletableFuture<List<ObjectProperties>>	listObjectsAsync(String prefix)
abstract 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<List<ObjectProperties>>	listObjectsAsync(Predicate<ObjectProperties> p)
abstract CompletableFuture<Void>	putObjectAsync(String objectName, String contentType, Map<String,String> metadata, byte[] objectData)
void	setAccessRules(Map<Bucket.AccessRuleType,Map<String,List<PathMatcher>>> accessRules)	Sets bucket object access rules
abstract void	setMaxObjects(int maxObjects)	Update the object count limit for this bucket.
abstract void	setMaxSize(long maxSize)	Update the size limit for this bucket.

Methods inherited from class java.lang.Object

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

Constructor Details

Bucket

public Bucket()

Method Details

getLocation

public abstract BucketLocation getLocation()

Bucket location

getName

public abstract String getName()

This bucket's name

getPropertiesAsync

public abstract CompletableFuture<BucketProperties> getPropertiesAsync()

setMaxSize

public abstract 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

public abstract 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

public CompletableFuture<List<ObjectProperties>> listObjectsAsync()

listObjectsAsync

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

listObjectsAsync

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

listObjectsAsync

public abstract 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

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

getObjectAsync

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

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

deleteObjectAsync

public abstract CompletableFuture<Void> deleteObjectAsync(String objectName)

findObjectAsync

public abstract CompletableFuture<ObjectProperties> findObjectAsync(String objectName)

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

setAccessRules

public void setAccessRules(Map<Bucket.AccessRuleType,Map<String,List<PathMatcher>>> accessRules)

Sets bucket object access rules

Parameters:

accessRules - map of roles to a list of allowed path globs

getAccessRules

public Map<String,List<PathMatcher>> getAccessRules(Bucket.AccessRuleType type)

hasAccessRules

public boolean hasAccessRules(Bucket.AccessRuleType type)