alluxio.client.file.cache.store

Class LocalPageStore

java.lang.Object

alluxio.client.file.cache.store.LocalPageStore

All Implemented Interfaces:

PageStore, AutoCloseable

@NotThreadSafe
public class LocalPageStore
extends Object
implements PageStore

The LocalPageStore is an implementation of PageStore which stores all pages in a directory somewhere on the local disk.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.client.file.cache.PageStore

PageStore.Metrics

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMP_DIR

Fields inherited from interface alluxio.client.file.cache.PageStore

LOG

Constructor Summary

Constructors

Constructor and Description
LocalPageStore(PageStoreOptions options) Creates a new instance of LocalPageStore.

Method Summary

Modifier and Type	Method and Description
void	abort(String fileId) Abort a temporary file.
void	close()
void	commit(String fileId, String newFileId) Commit a temporary file with a new file ID.
void	delete(PageId pageId, boolean isTemporary) Deletes a temporary page from the store.
int	get(PageId pageId, int pageOffset, int bytesToRead, ReadTargetBuffer target, boolean isTemporary) Gets part of a page from the store to the destination buffer.
DataFileChannel	getDataFileChannel(PageId pageId, int pageOffset, int bytesToRead, boolean isTemporary) Get a DataFileChannel which wraps a FileRegion.
Path	getPagePath(PageId pageId, boolean isTemporary)
void	put(PageId pageId, ByteBuffer page, boolean isTemporary) Writes a new page from a source channel to the 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.PageStore

commit, create, delete, get, get, put, put, putTemporary

Field Detail

TEMP_DIR

public static final String TEMP_DIR

See Also:

Constant Field Values

Constructor Detail

LocalPageStore

public LocalPageStore(PageStoreOptions options)

Creates a new instance of LocalPageStore.

Parameters:

options - options for the local page store

Method Detail

put

public void put(PageId pageId,
                ByteBuffer page,
                boolean isTemporary)
         throws ResourceExhaustedException,
                IOException

Description copied from interface: PageStore

Writes a new page from a source channel to the store.

Specified by:

put in interface PageStore

Parameters:

pageId - page identifier

page - page data

isTemporary - is page data temporary

Throws:

ResourceExhaustedException - when there is not enough space found on disk

IOException - when the store fails to write this page

get

public int get(PageId pageId,
               int pageOffset,
               int bytesToRead,
               ReadTargetBuffer target,
               boolean isTemporary)
        throws IOException,
               PageNotFoundException

Description copied from interface: PageStore

Gets part of a page from the store to the destination buffer.

Specified by:

get in interface PageStore

Parameters:

pageId - page identifier

pageOffset - offset within page

bytesToRead - bytes to read in this page

target - destination buffer

isTemporary - is page data temporary

Returns:

the number of bytes read

Throws:

IOException - when the store fails to read this page

PageNotFoundException - when the page isn't found in the store

delete

public void delete(PageId pageId,
                   boolean isTemporary)
            throws IOException,
                   PageNotFoundException

Description copied from interface: PageStore

Deletes a temporary page from the store.

Specified by:

delete in interface PageStore

Parameters:

pageId - page identifier

isTemporary - whether is to delete a temporary page or not

Throws:

IOException

PageNotFoundException

commit

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

Description copied from interface: PageStore

Commit a temporary file with a new file ID.

Specified by:

commit in interface PageStore

Throws:

IOException

abort

public void abort(String fileId)
           throws IOException

Description copied from interface: PageStore

Abort a temporary file.

Specified by:

abort in interface PageStore

Throws:

IOException

getPagePath

public Path getPagePath(PageId pageId,
                        boolean isTemporary)

Parameters:

pageId - page Id

isTemporary -

Returns:

the local file system path to store this page

getDataFileChannel

public DataFileChannel getDataFileChannel(PageId pageId,
                                          int pageOffset,
                                          int bytesToRead,
                                          boolean isTemporary)
                                   throws PageNotFoundException

Description copied from interface: PageStore

Get a DataFileChannel which wraps a FileRegion.

Specified by:

getDataFileChannel in interface PageStore

Parameters:

pageId - the page id

pageOffset - the offset inside the page

bytesToRead - the bytes to read

isTemporary - whether it is temporary or not

Returns:

an object of DataFileChannel

Throws:

PageNotFoundException

close

public void close()

Specified by:

close in interface AutoCloseable