Package org.yamcs.yarch

Interface Bucket

All Known Implementing Classes:

FileSystemBucket, RdbBucket

public interface Bucket

Method Summary

Modifier and Type	Method	Description
void	deleteObject(String objectName)
Tablespace.ObjectProperties	findObject(String objectName)	retrieve the object properties or null if not such an object exist
String	getName()	This bucket's name
byte[]	getObject(String objectName)	Retrieve object from the bucket.
Tablespace.BucketProperties	getProperties()
default List<Tablespace.ObjectProperties>	listObjects()
default List<Tablespace.ObjectProperties>	listObjects(String prefix)
List<Tablespace.ObjectProperties>	listObjects(String prefix, Predicate<Tablespace.ObjectPropertiesOrBuilder> 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 List<Tablespace.ObjectProperties>	listObjects(Predicate<Tablespace.ObjectPropertiesOrBuilder> p)
void	putObject(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

getName

String getName()

This bucket's name

getProperties

Tablespace.BucketProperties getProperties()
                                   throws IOException

Throws:

IOException

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

listObjects

default List<Tablespace.ObjectProperties> listObjects()
                                               throws IOException

Throws:

IOException

listObjects

default List<Tablespace.ObjectProperties> listObjects(String prefix)
                                               throws IOException

Throws:

IOException

listObjects

default List<Tablespace.ObjectProperties> listObjects(Predicate<Tablespace.ObjectPropertiesOrBuilder> p)
                                               throws IOException

Throws:

IOException

listObjects

List<Tablespace.ObjectProperties> listObjects(String prefix,
 Predicate<Tablespace.ObjectPropertiesOrBuilder> p)
                                       throws IOException

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

Throws:

IOException

putObject

void putObject(String objectName,
 String contentType,
 Map<String,String> metadata,
 byte[] objectData)
        throws IOException

Throws:

IOException

getObject

byte[] getObject(String objectName)
          throws IOException

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

Parameters:

objectName -

Returns:

Throws:

IOException

deleteObject

void deleteObject(String objectName)
           throws IOException

Throws:

IOException

findObject

Tablespace.ObjectProperties findObject(String objectName)
                                throws IOException

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

Parameters:

objectName -

Returns:

Throws:

IOException