alluxio.client.file.cache.store

Class LocalPageStoreDir

java.lang.Object

alluxio.client.file.cache.store.LocalPageStoreDir

All Implemented Interfaces:

CacheStatus, PageStoreDir

public class LocalPageStoreDir
extends Object

Constructor Summary

Constructors

Constructor and Description
LocalPageStoreDir(PageStoreOptions pageStoreOptions, PageStore pageStore, CacheEvictor evictor) Constructor for LocalCacheDir.

Method Summary

Modifier and Type	Method and Description
void	abort(String fileId) Abort a temporary file.
void	close() Close the page store dir.
void	commit(String fileId, String newFileId) Commit a temporary file with a new file ID.
long	deletePage(PageInfo pageInfo)
void	deleteTempPage(PageInfo pageInfo)
long	getCachedBytes()
long	getCapacityBytes()
CacheEvictor	getEvictor()
PageStore	getPageStore() Getter for pageStore.
Path	getRootPath()
Optional<CacheUsage>	getUsage() Gets cache usage.
boolean	hasFile(String fileId)
boolean	hasTempFile(String fileId)
void	putPage(PageInfo pageInfo)
boolean	putTempFile(String fileId)
void	putTempPage(PageInfo pageInfo)
long	release(long bytes) Release the pre-reserved space.
boolean	reserve(long bytes)
void	reset() Reset page store.
void	scanPages(java.util.function.Consumer<Optional<PageInfo>> pageInfoConsumer) Gets a stream of all pages from the page store.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.client.file.cache.store.PageStoreDir

clear, commit, createPageStoreDir, createPageStoreDirs, getFileBucket

Constructor Detail

LocalPageStoreDir

public LocalPageStoreDir(PageStoreOptions pageStoreOptions,
                         PageStore pageStore,
                         CacheEvictor evictor)

Constructor for LocalCacheDir.

Parameters:

pageStoreOptions -

pageStore -

evictor -

Method Detail

getPageStore

public PageStore getPageStore()

Getter for pageStore.

Returns:

pageStore

reset

public void reset()
           throws IOException

Reset page store.

Throws:

IOException

scanPages

public void scanPages(java.util.function.Consumer<Optional<PageInfo>> pageInfoConsumer)
               throws IOException

Gets a stream of all pages from the page store. This stream needs to be closed as it may open IO resources.

Throws:

IOException - if any error occurs

getUsage

public Optional<CacheUsage> getUsage()

Description copied from interface: CacheStatus

Gets cache usage.

Returns:

cache usage, or none if reporting usage info is not supported

getRootPath

public Path getRootPath()

Specified by:

getRootPath in interface PageStoreDir

Returns:

root path

getCapacityBytes

public long getCapacityBytes()

Specified by:

getCapacityBytes in interface PageStoreDir

Returns:

capacity

getCachedBytes

public long getCachedBytes()

Specified by:

getCachedBytes in interface PageStoreDir

Returns:

cached bytes in this directory

putPage

public void putPage(PageInfo pageInfo)

Specified by:

putPage in interface PageStoreDir

putTempPage

public void putTempPage(PageInfo pageInfo)

Specified by:

putTempPage in interface PageStoreDir

deletePage

public long deletePage(PageInfo pageInfo)

Specified by:

deletePage in interface PageStoreDir

Returns:

the bytes used after release

deleteTempPage

public void deleteTempPage(PageInfo pageInfo)

Specified by:

deleteTempPage in interface PageStoreDir

putTempFile

public boolean putTempFile(String fileId)

Specified by:

putTempFile in interface PageStoreDir

Parameters:

fileId - file id

Returns:

if the temp file is added successfully

reserve

public boolean reserve(long bytes)

Specified by:

reserve in interface PageStoreDir

Returns:

if the bytes requested could be reserved

release

public long release(long bytes)

Description copied from interface: PageStoreDir

Release the pre-reserved space.

Specified by:

release in interface PageStoreDir

Returns:

the bytes used after the release

hasFile

public boolean hasFile(String fileId)

Specified by:

hasFile in interface PageStoreDir

Returns:

true if the file is contained, false otherwise

hasTempFile

public boolean hasTempFile(String fileId)

Specified by:

hasTempFile in interface PageStoreDir

Returns:

true if the temp file is contained, false otherwise

getEvictor

public CacheEvictor getEvictor()

Specified by:

getEvictor in interface PageStoreDir

Returns:

the evictor of this dir

close

public void close()

Description copied from interface: PageStoreDir

Close the page store dir.

Specified by:

close in interface PageStoreDir

commit

public void commit(String fileId,
                   String newFileId)
            throws IOException

Description copied from interface: PageStoreDir

Commit a temporary file with a new file ID.

Specified by:

commit in interface PageStoreDir

Throws:

IOException

abort

public void abort(String fileId)
           throws IOException

Description copied from interface: PageStoreDir

Abort a temporary file.

Specified by:

abort in interface PageStoreDir

Throws:

IOException