alluxio.client.file.cache

Interface PageMetaStore

All Known Implementing Classes:

DefaultPageMetaStore, QuotaPageMetaStore

public interface PageMetaStore

The metadata store for pages stored in cache.

Method Summary

Modifier and Type	Method and Description
void	addPage(PageId pageId, PageInfo pageInfo) Adds a new page to the cache.
void	addTempPage(PageId pageId, PageInfo pageInfo) Adds a new temp page to the cache.
PageStoreDir	allocate(java.lang.String fileId, long fileLength)
long	bytes()
void	commitFile(java.lang.String fileId, java.lang.String newFileId) Commits a temp file so that all its pages become permanent.
static PageMetaStore	create(CacheManagerOptions options)
PageInfo	evict(CacheScope cacheScope, PageStoreDir pageStoreDir)
default PageInfo	evict(PageStoreDir pageStoreDir)
java.util.concurrent.locks.ReadWriteLock	getLock()
PageInfo	getPageInfo(PageId pageId)
java.util.List<PageStoreDir>	getStoreDirs() Gets the storage directories.
boolean	hasPage(PageId pageId)
long	numPages()
PageInfo	removePage(PageId pageId) Removes a page.
void	reset() Resets the meta store.

Method Detail

create

static PageMetaStore create(CacheManagerOptions options)
                     throws java.io.IOException

Parameters:

options - the options of cache

Returns:

an instance of MetaStore

Throws:

java.io.IOException

getLock

java.util.concurrent.locks.ReadWriteLock getLock()

Returns:

the associated lock

hasPage

boolean hasPage(PageId pageId)

Parameters:

pageId - page identifier

Returns:

if a page is stored in cache

addPage

void addPage(PageId pageId,
             PageInfo pageInfo)

Adds a new page to the cache.

Parameters:

pageId - page identifier

pageInfo - info of the page

addTempPage

void addTempPage(PageId pageId,
                 PageInfo pageInfo)

Adds a new temp page to the cache.

Parameters:

pageId - page identifier

pageInfo - info of the page

commitFile

void commitFile(java.lang.String fileId,
                java.lang.String newFileId)
         throws PageNotFoundException

Commits a temp file so that all its pages become permanent.

Parameters:

fileId - the temp file to commit

newFileId - the new file name of the file after committing

Throws:

PageNotFoundException

getStoreDirs

java.util.List<PageStoreDir> getStoreDirs()

Gets the storage directories.

Returns:

the storage directories

allocate

PageStoreDir allocate(java.lang.String fileId,
                      long fileLength)

Parameters:

fileId -

fileLength -

Returns:

the storage directory

getPageInfo

PageInfo getPageInfo(PageId pageId)
              throws PageNotFoundException

Parameters:

pageId - page identifier

Returns:

page info

Throws:

PageNotFoundException

removePage

PageInfo removePage(PageId pageId)
             throws PageNotFoundException

Removes a page.

Parameters:

pageId - page identifier

Returns:

page info removed

Throws:

PageNotFoundException

bytes

long bytes()

Returns:

the total size of pages stored in bytes

numPages

long numPages()

Returns:

the number of pages stored

reset

void reset()

Resets the meta store.

evict

default PageInfo evict(PageStoreDir pageStoreDir)

Parameters:

pageStoreDir -

Returns:

a page to evict

evict

PageInfo evict(CacheScope cacheScope,
               PageStoreDir pageStoreDir)

Parameters:

cacheScope -

pageStoreDir -

Returns:

a page to evict