Module org.yamcs.core

Package org.yamcs.yarch

Class FileSystemBucketDatabase

java.lang.Object

org.yamcs.yarch.FileSystemBucketDatabase

All Implemented Interfaces:

BucketDatabase

public class FileSystemBucketDatabase
extends Object
implements BucketDatabase

BucketDatabase implementation that maps objects to files on a file system.

Constructor Summary

Constructors

Constructor	Description
FileSystemBucketDatabase(String yamcsInstance)
FileSystemBucketDatabase(String yamcsInstance, Map<String,Object> args)

Method Summary

Modifier and Type	Method	Description
FileSystemBucket	createBucket(String bucketName)
void	deleteBucket(String bucketName)
FileSystemBucket	getBucket(String bucketName)	Retrieve a bucket handler from the database.
Path	getRootPath()
List<Bucket>	listBuckets()
FileSystemBucket	registerBucket(String bucketName, Path location)	Manually register a bucket based on a location on the file system.

Methods inherited from class java.lang.Object

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

Constructor Details

FileSystemBucketDatabase

public FileSystemBucketDatabase(String yamcsInstance)
                         throws IOException

Throws:

IOException

FileSystemBucketDatabase

public FileSystemBucketDatabase(String yamcsInstance,
 Map<String,Object> args)
                         throws IOException

Throws:

IOException

Method Details

createBucket

public FileSystemBucket createBucket(String bucketName)
                              throws IOException

Specified by:

createBucket in interface BucketDatabase

Throws:

IOException

registerBucket

public FileSystemBucket registerBucket(String bucketName,
 Path location)
                                throws IOException

Manually register a bucket based on a location on the file system.

It is not necessary to register buckets that exist in the standard location (directly under under dataDir).

Remark that bucket registration is transient.

Parameters:

bucketName - the name of the bucket.

location - the path to the bucket. This location should already exist.

Throws:

IOException

getBucket

public FileSystemBucket getBucket(String bucketName)
                           throws IOException

Description copied from interface: BucketDatabase

Retrieve a bucket handler from the database.

Specified by:

getBucket in interface BucketDatabase

Returns:

the bucket with the given name or null if it does not exist

Throws:

IOException

listBuckets

public List<Bucket> listBuckets()
                         throws IOException

Specified by:

listBuckets in interface BucketDatabase

Throws:

IOException

deleteBucket

public void deleteBucket(String bucketName)
                  throws IOException

Specified by:

deleteBucket in interface BucketDatabase

Throws:

IOException

getRootPath

public Path getRootPath()