Package org.apache.hadoop.ozone.om

Interface VolumeManager

All Superinterfaces:

IOzoneAcl

All Known Implementing Classes:

VolumeManagerImpl

public interface VolumeManager
extends IOzoneAcl

VolumeManager is responsible for read operations on a volume.

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.ozone.om.helpers.OmVolumeArgs	getVolumeInfo(String volume)	Gets the volume information.
List<org.apache.hadoop.ozone.om.helpers.OmVolumeArgs>	listVolumes(String userName, String prefix, String startKey, int maxKeys)	Returns a list of volumes owned by a given user; if user is null, returns all volumes.

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

checkAccess, getAcl

Method Details

getVolumeInfo

org.apache.hadoop.ozone.om.helpers.OmVolumeArgs getVolumeInfo(String volume)
                                                       throws IOException

Gets the volume information.

Parameters:

volume - - Volume name.

Returns:

VolumeArgs or exception is thrown.

Throws:

IOException

listVolumes

List<org.apache.hadoop.ozone.om.helpers.OmVolumeArgs> listVolumes(String userName,
 String prefix,
 String startKey,
 int maxKeys)
                                                           throws IOException

Returns a list of volumes owned by a given user; if user is null, returns all volumes.

Parameters:

userName - volume owner

prefix - the volume prefix used to filter the listing result.

startKey - the start volume name determines where to start listing from, this key is excluded from the result.

maxKeys - the maximum number of volumes to return.

Returns:

a list of OmVolumeArgs

Throws:

IOException