org.apache.flink.runtime.blob

Class BlobCacheService

java.lang.Object

org.apache.flink.runtime.blob.BlobCacheService

All Implemented Interfaces:

Closeable, AutoCloseable, BlobService, TaskExecutorBlobService

public class BlobCacheService
extends Object
implements TaskExecutorBlobService

The BLOB cache provides access to BLOB services for permanent and transient BLOBs.

Constructor Summary

Constructors

Constructor and Description
BlobCacheService(Configuration blobClientConfig, File storageDir, BlobView blobView, InetSocketAddress serverAddress)
BlobCacheService(Configuration blobClientConfig, Reference<File> storageDir, BlobView blobView, InetSocketAddress serverAddress) Instantiates a new BLOB cache.
BlobCacheService(PermanentBlobCache permanentBlobCache, TransientBlobCache transientBlobCache) Instantiates a new BLOB cache.

Method Summary

Modifier and Type	Method and Description
void	close()
PermanentBlobCache	getPermanentBlobService() Returns a BLOB service for accessing permanent BLOBs.
int	getPort() Returns the port of the BLOB server that this BLOB service is working with.
TransientBlobCache	getTransientBlobService() Returns a BLOB service for accessing transient BLOBs.
void	setBlobServerAddress(InetSocketAddress blobServerAddress) Sets the address of the BlobServer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobCacheService

public BlobCacheService(Configuration blobClientConfig,
                        File storageDir,
                        BlobView blobView,
                        @Nullable
                        InetSocketAddress serverAddress)
                 throws IOException

Throws:

IOException

BlobCacheService

public BlobCacheService(Configuration blobClientConfig,
                        Reference<File> storageDir,
                        BlobView blobView,
                        @Nullable
                        InetSocketAddress serverAddress)
                 throws IOException

Instantiates a new BLOB cache.

Parameters:

blobClientConfig - global configuration

storageDir - storage directory for the cached blobs

blobView - (distributed) blob store file system to retrieve files from first

serverAddress - address of the BlobServer to use for fetching files from or null if none yet

Throws:

IOException - thrown if the (local or distributed) file storage cannot be created or is not usable

BlobCacheService

public BlobCacheService(PermanentBlobCache permanentBlobCache,
                        TransientBlobCache transientBlobCache)

Instantiates a new BLOB cache.

Parameters:

permanentBlobCache - BLOB cache to use for permanent BLOBs

transientBlobCache - BLOB cache to use for transient BLOBs

Method Detail

getPermanentBlobService

public PermanentBlobCache getPermanentBlobService()

Description copied from interface: BlobService

Returns a BLOB service for accessing permanent BLOBs.

Specified by:

getPermanentBlobService in interface BlobService

Specified by:

getPermanentBlobService in interface TaskExecutorBlobService

Returns:

BLOB service

getTransientBlobService

public TransientBlobCache getTransientBlobService()

Description copied from interface: BlobService

Returns a BLOB service for accessing transient BLOBs.

Specified by:

getTransientBlobService in interface BlobService

Returns:

BLOB service

setBlobServerAddress

public void setBlobServerAddress(InetSocketAddress blobServerAddress)

Sets the address of the BlobServer.

Specified by:

setBlobServerAddress in interface TaskExecutorBlobService

Parameters:

blobServerAddress - address of the BlobServer.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getPort

public int getPort()

Description copied from interface: BlobService

Returns the port of the BLOB server that this BLOB service is working with.

Specified by:

getPort in interface BlobService

Returns:

the port of the blob server.