com.linkedin.azkaban.spi

Interface Storage

public interface Storage

The Azkaban Storage interface would facilitate getting and putting objects into a storage mechanism of choice. By default, this is set to the MySQL database. However, users can have the ability to choose between multiple storage types in future. This is different from storing Azkaban state in MySQL which would typically be maintained in a different database. Note: This is a synchronous interface.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.net.URI key) Check if key exists in storage.
void	delete(java.net.URI key) Delete an object from Storage.
java.io.InputStream	get(java.net.URI key) Get an InputStream object by providing a key.
void	put(java.net.URI key, java.io.InputStream is) Put an object into Storage against a key.

Method Detail

containsKey

boolean containsKey(java.net.URI key)

Check if key exists in storage.

Parameters:

key - The key is a URI pointing to the blob in Storage.

Returns:

true if key exists. false otherwise.

get

java.io.InputStream get(java.net.URI key)
                 throws KeyDoesNotExistException

Get an InputStream object by providing a key. Throws KeyDoesNotExistException if key is not present.

Parameters:

key - The key is a URI pointing to the blob in Storage.

Returns:

InputStream for fetching the blob.

Throws:

KeyDoesNotExistException

put

void put(java.net.URI key,
         java.io.InputStream is)
  throws KeyAlreadyExistsException

Put an object into Storage against a key. If the key already exists, then it throws KeyAlreadyExistsException;.

Parameters:

key - The key is a URI pointing to the blob in Storage.

is - The input stream from which the value is read to the store. The value is read completely

Throws:

KeyAlreadyExistsException

delete

void delete(java.net.URI key)
     throws KeyDoesNotExistException

Delete an object from Storage. Throws KeyDoesNotExistException if key is not present.

Parameters:

key - The key is a URI pointing to the blob in Storage.

Throws:

KeyDoesNotExistException