Package org.apache.flink.state.forst

Class ForStResourceContainer

java.lang.Object

org.apache.flink.state.forst.ForStResourceContainer

All Implemented Interfaces:

AutoCloseable

public final class ForStResourceContainer
extends Object
implements AutoCloseable

The container for ForSt resources, including option factory and shared resource among instances.

This should be the only entrance for ForStStateBackend to get ForSt options, and should be properly (and necessarily) closed to prevent resource leak.

Constructor Summary

Constructors

Constructor	Description
ForStResourceContainer()
ForStResourceContainer(org.apache.flink.configuration.ReadableConfig configuration, ForStOptionsFactory optionsFactory, org.apache.flink.runtime.memory.OpaqueMemoryResource<org.apache.flink.state.forst.ForStSharedResources> sharedResources, File localBasePath, org.apache.flink.core.fs.Path remoteBasePath, boolean enableStatistics)
ForStResourceContainer(ForStOptionsFactory optionsFactory)
ForStResourceContainer(ForStOptionsFactory optionsFactory, org.apache.flink.runtime.memory.OpaqueMemoryResource<org.apache.flink.state.forst.ForStSharedResources> sharedResources)

Method Summary

Modifier and Type	Method	Description
void	clearDirectories()	Clear local and remote directories.
void	close()
org.rocksdb.ColumnFamilyOptions	getColumnOptions()	Gets the ForSt ColumnFamilyOptions to be used for all ForSt instances.
org.rocksdb.DBOptions	getDbOptions()	Gets the ForSt DBOptions to be used for ForSt instances.
File	getLocalBasePath()
File	getLocalForStPath()
org.rocksdb.ReadOptions	getReadOptions()	Gets the ForSt ReadOptions to be used for read operations.
org.apache.flink.core.fs.Path	getRemoteBasePath()
org.apache.flink.core.fs.Path	getRemoteForStPath()
org.rocksdb.WriteOptions	getWriteOptions()	Gets the ForSt WriteOptions to be used for write operations.
void	prepareDirectories()	Prepare local and remote directories.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForStResourceContainer

@VisibleForTesting
public ForStResourceContainer()

ForStResourceContainer

@VisibleForTesting
public ForStResourceContainer(@Nullable
                              ForStOptionsFactory optionsFactory)

ForStResourceContainer

@VisibleForTesting
public ForStResourceContainer(@Nullable
                              ForStOptionsFactory optionsFactory,
                              @Nullable
                              org.apache.flink.runtime.memory.OpaqueMemoryResource<org.apache.flink.state.forst.ForStSharedResources> sharedResources)

ForStResourceContainer

public ForStResourceContainer(org.apache.flink.configuration.ReadableConfig configuration,
                              @Nullable
                              ForStOptionsFactory optionsFactory,
                              @Nullable
                              org.apache.flink.runtime.memory.OpaqueMemoryResource<org.apache.flink.state.forst.ForStSharedResources> sharedResources,
                              @Nullable
                              File localBasePath,
                              @Nullable
                              org.apache.flink.core.fs.Path remoteBasePath,
                              boolean enableStatistics)

Method Detail

getDbOptions

public org.rocksdb.DBOptions getDbOptions()

Gets the ForSt DBOptions to be used for ForSt instances.

getColumnOptions

public org.rocksdb.ColumnFamilyOptions getColumnOptions()

Gets the ForSt ColumnFamilyOptions to be used for all ForSt instances.

getWriteOptions

public org.rocksdb.WriteOptions getWriteOptions()

Gets the ForSt WriteOptions to be used for write operations.

getReadOptions

public org.rocksdb.ReadOptions getReadOptions()

Gets the ForSt ReadOptions to be used for read operations.

getLocalBasePath

@Nullable
public File getLocalBasePath()

getLocalForStPath

@Nullable
public File getLocalForStPath()

getRemoteBasePath

@Nullable
public org.apache.flink.core.fs.Path getRemoteBasePath()

getRemoteForStPath

@Nullable
public org.apache.flink.core.fs.Path getRemoteForStPath()

prepareDirectories

public void prepareDirectories()
                        throws Exception

Prepare local and remote directories.

Throws:

Exception - if any unexpected behaviors.

clearDirectories

public void clearDirectories()
                      throws Exception

Clear local and remote directories.

Throws:

Exception - if any unexpected behaviors.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception