org.apache.flink.runtime.blob

Class BlobServer

java.lang.Object

java.lang.Thread

org.apache.flink.runtime.blob.BlobServer

All Implemented Interfaces:

Runnable, BlobService

public final class BlobServer
extends Thread
implements BlobService

This class implements the BLOB server. The BLOB server is responsible for listening for incoming requests and spawning threads to handle these requests. Furthermore, it takes care of creating the directory structure to store the BLOBs or temporarily cache them.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
BlobServer(Configuration config) Instantiates a new BLOB server and binds it to a free network port.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(BlobKey blobKey) This method deletes the file associated to the blob key if it exists in the local storage of the blob server.
void	deleteJobDirectory(JobID jobID) Method which deletes all files associated with the given jobID.
int	getPort() Returns the port on which the server is listening.
int	getServerPort() Returns the network port the BLOB server is bound to.
File	getStorageLocation(BlobKey key) Returns a file handle to the file associated with the given blob key on the blob server.
File	getStorageLocation(JobID jobID, String key) Returns a file handle to the file identified by the given jobID and key.
URL	getURL(BlobKey requiredBlob) Method which retrieves the URL of a file associated with a blob key.
void	run()
void	shutdown() Shuts down the BLOB server.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobServer

public BlobServer(Configuration config)
           throws IOException

Instantiates a new BLOB server and binds it to a free network port.

Throws:

IOException - thrown if the BLOB server cannot bind to a free network port

Method Detail

getServerPort

public int getServerPort()

Returns the network port the BLOB server is bound to. The return value of this method is undefined after the BLOB server has been shut down.

Returns:

the network port the BLOB server is bound to

getStorageLocation

public File getStorageLocation(BlobKey key)

Returns a file handle to the file associated with the given blob key on the blob server.

Parameters:

key - identifying the file

Returns:

file handle to the file

getStorageLocation

public File getStorageLocation(JobID jobID,
                      String key)

Returns a file handle to the file identified by the given jobID and key.

Parameters:

jobID - to which the file is associated

key - to identify the file within the job context

Returns:

file handle to the file

deleteJobDirectory

public void deleteJobDirectory(JobID jobID)
                        throws IOException

Method which deletes all files associated with the given jobID.

Parameters:

jobID - all files associated to this jobID will be deleted

Throws:

IOException

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

shutdown

public void shutdown()

Shuts down the BLOB server.

Specified by:

shutdown in interface BlobService

getURL

public URL getURL(BlobKey requiredBlob)
           throws IOException

Method which retrieves the URL of a file associated with a blob key. The blob server looks the blob key up in its local storage. If the file exists, then the URL is returned. If the file does not exist, then a FileNotFoundException is thrown.

Specified by:

getURL in interface BlobService

Parameters:

requiredBlob - blob key associated with the requested file

Returns:

URL of the file

Throws:

IOException

delete

public void delete(BlobKey blobKey)
            throws IOException

This method deletes the file associated to the blob key if it exists in the local storage of the blob server.

Specified by:

delete in interface BlobService

Parameters:

blobKey - associated with the file to be deleted

Throws:

IOException

getPort

public int getPort()

Returns the port on which the server is listening.

Specified by:

getPort in interface BlobService

Returns:

port on which the server is listening