org.apache.flink.runtime.blob

Class BlobClient

java.lang.Object

org.apache.flink.runtime.blob.BlobClient

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BlobClient
extends Object
implements Closeable

The BLOB client can communicate with the BLOB server and either upload (PUT), download (GET), or delete (DELETE) BLOBs.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
BlobClient(InetSocketAddress serverAddress) Instantiates a new BLOB client.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	delete(JobID jobId, String key) Deletes the BLOB identified by the given job ID and key from the BLOB server.
void	deleteAll(JobID jobId) Deletes all BLOBs belonging to the job with the given ID from the BLOB server
InputStream	get(BlobKey blobKey) Downloads the BLOB identified by the given BLOB key from the BLOB server.
InputStream	get(JobID jobID, String key) Downloads the BLOB identified by the given job ID and key from the BLOB server.
BlobKey	put(byte[] value) Uploads the data of the given byte array to the BLOB server in a content-addressable manner.
BlobKey	put(byte[] value, int offset, int len) Uploads data from the given byte array to the BLOB server in a content-addressable manner.
BlobKey	put(InputStream inputStream) Uploads the data from the given input stream to the BLOB server in a content-addressable manner.
void	put(JobID jobId, String key, byte[] value) Uploads the data of the given byte array to the BLOB server and stores it under the given job ID and key.
void	put(JobID jobId, String key, byte[] value, int offset, int len) Uploads data from the given byte array to the BLOB server and stores it under the given job ID and key.
void	put(JobID jobId, String key, InputStream inputStream) Uploads data from the given input stream to the BLOB server and stores it under the given job ID and key.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobClient

public BlobClient(InetSocketAddress serverAddress)
           throws IOException

Instantiates a new BLOB client.

Parameters:

serverAddress - the network address of the BLOB server

Throws:

IOException - thrown if the connection to the BLOB server could not be established

Method Detail

put

public BlobKey put(byte[] value)
            throws IOException

Uploads the data of the given byte array to the BLOB server in a content-addressable manner.

Parameters:

value - the buffer to upload

Returns:

the computed BLOB key identifying the BLOB on the server

Throws:

IOException - thrown if an I/O error occurs while uploading the data to the BLOB server

put

public BlobKey put(byte[] value,
          int offset,
          int len)
            throws IOException

Uploads data from the given byte array to the BLOB server in a content-addressable manner.

Parameters:

value - the buffer to upload data from

offset - the read offset within the buffer

len - the number of bytes to upload from the buffer

Returns:

the computed BLOB key identifying the BLOB on the server

Throws:

IOException - thrown if an I/O error occurs while uploading the data to the BLOB server

put

public void put(JobID jobId,
       String key,
       byte[] value)
         throws IOException

Uploads the data of the given byte array to the BLOB server and stores it under the given job ID and key.

Parameters:

jobId - the job ID to identify the uploaded data

key - the key to identify the uploaded data

value - the buffer to upload

Throws:

IOException - thrown if an I/O error occurs while uploading the data to the BLOB server

put

public void put(JobID jobId,
       String key,
       byte[] value,
       int offset,
       int len)
         throws IOException

Uploads data from the given byte array to the BLOB server and stores it under the given job ID and key.

Parameters:

jobId - the job ID to identify the uploaded data

key - the key to identify the uploaded data

value - the buffer to upload data from

offset - the read offset within the buffer

len - the number of bytes to upload from the buffer

Throws:

IOException - thrown if an I/O error occurs while uploading the data to the BLOB server

put

public void put(JobID jobId,
       String key,
       InputStream inputStream)
         throws IOException

Uploads data from the given input stream to the BLOB server and stores it under the given job ID and key.

Parameters:

jobId - the job ID to identify the uploaded data

key - the key to identify the uploaded data

inputStream - the input stream to read the data from

Throws:

IOException - thrown if an I/O error occurs while reading the data from the input stream or uploading the data to the BLOB server

put

public BlobKey put(InputStream inputStream)
            throws IOException

Uploads the data from the given input stream to the BLOB server in a content-addressable manner.

Parameters:

inputStream - the input stream to read the data from

Returns:

the computed BLOB key identifying the BLOB on the server

Throws:

IOException - thrown if an I/O error occurs while reading the data from the input stream or uploading the data to the BLOB server

delete

public void delete(JobID jobId,
          String key)
            throws IOException

Deletes the BLOB identified by the given job ID and key from the BLOB server.

Parameters:

jobId - the job ID to identify the BLOB

key - the key to identify the BLOB

Throws:

IOException - thrown if an I/O error occurs while transferring the request to the BLOB server

deleteAll

public void deleteAll(JobID jobId)
               throws IOException

Deletes all BLOBs belonging to the job with the given ID from the BLOB server

Parameters:

jobId - the job ID to identify the BLOBs to be deleted

Throws:

IOException - thrown if an I/O error occurs while transferring the request to the BLOB server

get

public InputStream get(JobID jobID,
              String key)
                throws IOException

Downloads the BLOB identified by the given job ID and key from the BLOB server. If no such BLOB exists on the server, a FileNotFoundException is thrown.

Parameters:

jobID - the job ID identifying the BLOB to download

key - the key identifying the BLOB to download

Returns:

an input stream to read the retrieved data from

Throws:

IOException - thrown if an I/O error occurs during the download

get

public InputStream get(BlobKey blobKey)
                throws IOException

Downloads the BLOB identified by the given BLOB key from the BLOB server. If no such BLOB exists on the server, a FileNotFoundException is thrown.

Parameters:

blobKey - the BLOB key identifying the BLOB to download

Returns:

an input stream to read the retrieved data from

Throws:

IOException - thrown if an I/O error occurs during the download

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException