alluxio.client.file.cache

Interface PageStore

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LocalPageStore, MemoryPageStore, TimeBoundPageStore

public interface PageStore
extends AutoCloseable

A simple abstraction on the storage to put, get and delete pages. The implementation of this class does not need to provide thread-safety.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PageStore.Metrics Metrics.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
default void	abort(String fileId) Abort a temporary file.
default void	commit(String fileId) Commit a temporary file.
default void	commit(String fileId, String newFileId) Commit a temporary file with a new file ID.
static PageStore	create(PageStoreOptions options) Create an instance of PageStore.
default void	delete(PageId pageId) Deletes a page from the store.
default void	delete(PageId pageId, boolean isTemporary) Deletes a temporary page from the store.
default int	get(PageId pageId, int pageOffset, int bytesToRead, ReadTargetBuffer buffer) Gets part of a page from the store to the destination buffer.
int	get(PageId pageId, int pageOffset, int bytesToRead, ReadTargetBuffer buffer, boolean isTemporary) Gets part of a page from the store to the destination buffer.
default int	get(PageId pageId, ReadTargetBuffer buffer) Gets a page from the store to the destination buffer.
default DataFileChannel	getDataFileChannel(PageId pageId, int pageOffset, int bytesToRead, boolean isTemporary) Get a DataFileChannel which wraps a FileRegion.
default void	put(PageId pageId, byte[] page) Writes a new page from a source channel to the store.
default void	put(PageId pageId, byte[] page, boolean isTemporary) Writes a new page from a source channel to the store.
void	put(PageId pageId, ByteBuffer page, boolean isTemporary) Writes a new page from a source channel to the store.
default void	putTemporary(PageId pageId, byte[] page) Writes a new temporary page from a source channel to the store.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

create

static PageStore create(PageStoreOptions options)

Create an instance of PageStore.

Parameters:

options - the options to instantiate the page store

Returns:

a PageStore instance

putTemporary

default void putTemporary(PageId pageId,
                          byte[] page)
                   throws ResourceExhaustedException,
                          IOException

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

Parameters:

pageId - page identifier

page - page data

Throws:

ResourceExhaustedException - when there is not enough space found on disk

IOException - when the store fails to write this page

put

default void put(PageId pageId,
                 byte[] page)
          throws ResourceExhaustedException,
                 IOException

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

Parameters:

pageId - page identifier

page - page data

Throws:

ResourceExhaustedException - when there is not enough space found on disk

IOException - when the store fails to write this page

put

default void put(PageId pageId,
                 byte[] page,
                 boolean isTemporary)
          throws ResourceExhaustedException,
                 IOException

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

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

put

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

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

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

default int get(PageId pageId,
                ReadTargetBuffer buffer)
         throws IOException,
                PageNotFoundException

Gets a page from the store to the destination buffer.

Parameters:

pageId - page identifier

buffer - destination buffer

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

get

default int get(PageId pageId,
                int pageOffset,
                int bytesToRead,
                ReadTargetBuffer buffer)
         throws IOException,
                PageNotFoundException

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

Parameters:

pageId - page identifier

pageOffset - offset within page

bytesToRead - bytes to read in this page

buffer - destination buffer

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

IllegalArgumentException - when the page offset exceeds the page size

get

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

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

Parameters:

pageId - page identifier

pageOffset - offset within page

bytesToRead - bytes to read in this page

buffer - 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

IllegalArgumentException - when the page offset exceeds the page size

delete

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

Deletes a temporary page from the store.

Parameters:

pageId - page identifier

isTemporary - whether is to delete the temporary page or not

Throws:

IOException - when the store fails to delete this page

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

delete

default void delete(PageId pageId)
             throws IOException,
                    PageNotFoundException

Deletes a page from the store.

Parameters:

pageId - page identifier

Throws:

IOException - when the store fails to delete this page

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

commit

default void commit(String fileId)
             throws IOException

Commit a temporary file.

Parameters:

fileId -

Throws:

IOException

commit

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

Commit a temporary file with a new file ID.

Parameters:

fileId -

newFileId -

Throws:

IOException

abort

default void abort(String fileId)
            throws IOException

Abort a temporary file.

Parameters:

fileId -

Throws:

IOException

getDataFileChannel

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

Get a DataFileChannel which wraps a FileRegion.

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