alluxio.worker.block.meta

Interface StorageDir

All Known Implementing Classes:

DefaultStorageDir

public interface StorageDir

Represents a directory in a storage tier. It has a fixed capacity allocated to it on instantiation. It contains the set of blocks currently in the storage directory.

Method Summary

Modifier and Type	Method and Description
void	addBlockMeta(BlockMeta blockMeta) Adds the metadata of a new block into this storage dir.
void	addTempBlockMeta(TempBlockMeta tempBlockMeta) Adds the metadata of a new block into this storage dir.
void	cleanupSessionTempBlocks(long sessionId, List<Long> tempBlockIds) Cleans up the temp block metadata for each block id passed in.
long	getAvailableBytes() Gets the total available capacity of this StorageDir in bytes.
List<Long>	getBlockIds() Returns the list of block ids in this dir.
BlockMeta	getBlockMeta(long blockId) Gets the BlockMeta from this storage dir by its block id.
List<BlockMeta>	getBlocks() Returns the list of blocks stored in this dir.
long	getCapacityBytes() Gets the total capacity of this StorageDir in bytes, which is a constant once this StorageDir has been initialized.
long	getCommittedBytes() Gets the total size of committed blocks in this StorageDir in bytes.
int	getDirIndex() Returns the zero-based index of this dir in its parent StorageTier.
String	getDirMedium()
String	getDirPath()
StorageTier	getParentTier() Returns the StorageTier containing this StorageDir.
long	getReservedBytes()
List<TempBlockMeta>	getSessionTempBlocks(long sessionId) Gets the temporary blocks associated with a session in this StorageDir, an empty list is returned if the session has no temporary blocks in this StorageDir.
TempBlockMeta	getTempBlockMeta(long blockId) Gets the TempBlockMeta from this storage dir by its block id.
boolean	hasBlockMeta(long blockId) Checks if a block is in this storage dir.
boolean	hasTempBlockMeta(long blockId) Checks if a temp block is in this storage dir.
void	removeBlockMeta(BlockMeta blockMeta) Removes a block from this storage dir.
void	removeTempBlockMeta(TempBlockMeta tempBlockMeta) Removes a temp block from this storage dir.
void	resizeTempBlockMeta(TempBlockMeta tempBlockMeta, long newSize) Changes the size of a temp block.
BlockStoreLocation	toBlockStoreLocation()

Method Detail

getCapacityBytes

long getCapacityBytes()

Gets the total capacity of this StorageDir in bytes, which is a constant once this StorageDir has been initialized.

Returns:

the total capacity of this StorageDir in bytes

getAvailableBytes

long getAvailableBytes()

Gets the total available capacity of this StorageDir in bytes. This value equals the total capacity of this StorageDir, minus the used bytes by committed blocks and temp blocks.

Returns:

available capacity in bytes

getCommittedBytes

long getCommittedBytes()

Gets the total size of committed blocks in this StorageDir in bytes.

Returns:

number of committed bytes

getDirPath

String getDirPath()

Returns:

the path of the directory

getDirMedium

String getDirMedium()

Returns:

the medium of the storage dir

getParentTier

StorageTier getParentTier()

Returns the StorageTier containing this StorageDir.

Returns:

StorageTier

getDirIndex

int getDirIndex()

Returns the zero-based index of this dir in its parent StorageTier.

Returns:

index

getBlockIds

List<Long> getBlockIds()

Returns the list of block ids in this dir.

Returns:

a list of block ids

getBlocks

List<BlockMeta> getBlocks()

Returns the list of blocks stored in this dir.

Returns:

a list of blocks

hasBlockMeta

boolean hasBlockMeta(long blockId)

Checks if a block is in this storage dir.

Parameters:

blockId - the block id

Returns:

true if the block is in this storage dir, false otherwise

hasTempBlockMeta

boolean hasTempBlockMeta(long blockId)

Checks if a temp block is in this storage dir.

Parameters:

blockId - the block id

Returns:

true if the block is in this storage dir, false otherwise

getBlockMeta

BlockMeta getBlockMeta(long blockId)
                throws BlockDoesNotExistException

Gets the BlockMeta from this storage dir by its block id.

Parameters:

blockId - the block id

Returns:

BlockMeta of the given block or null

Throws:

BlockDoesNotExistException - if no block is found

getTempBlockMeta

TempBlockMeta getTempBlockMeta(long blockId)

Gets the TempBlockMeta from this storage dir by its block id.

Parameters:

blockId - the block id

Returns:

TempBlockMeta of the given block or null

addBlockMeta

void addBlockMeta(BlockMeta blockMeta)
           throws WorkerOutOfSpaceException,
                  BlockAlreadyExistsException

Adds the metadata of a new block into this storage dir.

Parameters:

blockMeta - the metadata of the block

Throws:

BlockAlreadyExistsException - if blockId already exists

WorkerOutOfSpaceException - when not enough space to hold block

addTempBlockMeta

void addTempBlockMeta(TempBlockMeta tempBlockMeta)
               throws WorkerOutOfSpaceException,
                      BlockAlreadyExistsException

Adds the metadata of a new block into this storage dir.

Parameters:

tempBlockMeta - the metadata of a temp block to add

Throws:

BlockAlreadyExistsException - if blockId already exists

WorkerOutOfSpaceException - when not enough space to hold block

removeBlockMeta

void removeBlockMeta(BlockMeta blockMeta)
              throws BlockDoesNotExistException

Removes a block from this storage dir.

Parameters:

blockMeta - the metadata of the block

Throws:

BlockDoesNotExistException - if no block is found

removeTempBlockMeta

void removeTempBlockMeta(TempBlockMeta tempBlockMeta)
                  throws BlockDoesNotExistException

Removes a temp block from this storage dir.

Parameters:

tempBlockMeta - the metadata of the temp block to remove

Throws:

BlockDoesNotExistException - if no temp block is found

resizeTempBlockMeta

void resizeTempBlockMeta(TempBlockMeta tempBlockMeta,
                         long newSize)
                  throws InvalidWorkerStateException

Changes the size of a temp block.

Parameters:

tempBlockMeta - the metadata of the temp block to resize

newSize - the new size after change in bytes

Throws:

InvalidWorkerStateException - when newSize is smaller than oldSize

cleanupSessionTempBlocks

void cleanupSessionTempBlocks(long sessionId,
                              List<Long> tempBlockIds)

Cleans up the temp block metadata for each block id passed in.

Parameters:

sessionId - the id of the client associated with the temporary blocks

tempBlockIds - the list of temporary blocks to clean up, non temporary blocks or nonexistent blocks will be ignored

getSessionTempBlocks

List<TempBlockMeta> getSessionTempBlocks(long sessionId)

Gets the temporary blocks associated with a session in this StorageDir, an empty list is returned if the session has no temporary blocks in this StorageDir.

Parameters:

sessionId - the id of the session

Returns:

A list of temporary blocks the session is associated with in this StorageDir

toBlockStoreLocation

BlockStoreLocation toBlockStoreLocation()

Returns:

the block store location of this directory

getReservedBytes

long getReservedBytes()

Returns:

amount of reserved bytes for this dir