Package org.apache.hadoop.ozone.om

Interface BucketManager

All Superinterfaces:

IOzoneAcl

All Known Implementing Classes:

BucketManagerImpl

public interface BucketManager
extends IOzoneAcl

BucketManager handles all the bucket level operations.

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.ozone.om.helpers.OmBucketInfo	getBucketInfo(String volumeName, String bucketName)	Returns Bucket Information.
List<org.apache.hadoop.ozone.om.helpers.OmBucketInfo>	listBuckets(String volumeName, String startBucket, String bucketPrefix, int maxNumOfBuckets, boolean hasSnapshot)	Returns a list of buckets represented by OmBucketInfo in the given volume.

Methods inherited from interface org.apache.hadoop.ozone.om.IOzoneAcl

checkAccess, getAcl

Method Details

getBucketInfo

org.apache.hadoop.ozone.om.helpers.OmBucketInfo getBucketInfo(String volumeName,
 String bucketName)
                                                       throws IOException

Returns Bucket Information.

Parameters:

volumeName - - Name of the Volume.

bucketName - - Name of the Bucket.

Throws:

IOException

listBuckets

List<org.apache.hadoop.ozone.om.helpers.OmBucketInfo> listBuckets(String volumeName,
 String startBucket,
 String bucketPrefix,
 int maxNumOfBuckets,
 boolean hasSnapshot)
                                                           throws IOException

Returns a list of buckets represented by OmBucketInfo in the given volume.

Parameters:

volumeName - Required parameter volume name determines buckets in which volume to return.

startBucket - Optional start bucket name parameter indicating where to start the bucket listing from, this key is excluded from the result.

bucketPrefix - Optional start key parameter, restricting the response to buckets that begin with the specified name.

maxNumOfBuckets - The maximum number of buckets to return. It ensures the size of the result will not exceed this limit.

hasSnapshot - Set the flag to list buckets which have snapshots.

Returns:

a list of buckets.

Throws:

IOException