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	deleteProject(java.lang.String key) Delete an object from Storage.
boolean	dependencyFetchingEnabled() See if dependency fetching is enabled (required azkaban.properties were set).
java.io.InputStream	getDependency(Dependency dep) Get an InputStream object for a dependency.
java.lang.String	getDependencyRootPath() Get root path of dependency location (should be http://...) OR if thin archives is not enabled, will be null.
java.io.InputStream	getProject(java.lang.String key) Get an InputStream object for a project by providing a key.
java.lang.String	putProject(ProjectStorageMetadata metadata, java.io.File localFile) Put a project and return a key.

Method Detail

getProject

java.io.InputStream getProject(java.lang.String key)
                        throws java.io.IOException

Get an InputStream object for a project by providing a key.

Parameters:

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

Returns:

InputStream for fetching the blob. null if the key is not found.

Throws:

java.io.IOException

putProject

java.lang.String putProject(ProjectStorageMetadata metadata,
                            java.io.File localFile)

Put a project and return a key.

Parameters:

metadata - Metadata related to the input stream

localFile - Read data from a local file

Returns:

Key associated with the current object on successful put

getDependency

java.io.InputStream getDependency(Dependency dep)
                           throws java.io.IOException

Get an InputStream object for a dependency.

Parameters:

dep - the dependency to fetch

Returns:

InputStream for fetching the blob.

Throws:

java.io.IOException

getDependencyRootPath

java.lang.String getDependencyRootPath()

Get root path of dependency location (should be http://...) OR if thin archives is not enabled, will be null.

dependencyFetchingEnabled

boolean dependencyFetchingEnabled()

See if dependency fetching is enabled (required azkaban.properties were set).

deleteProject

boolean deleteProject(java.lang.String key)

Delete an object from Storage.

Parameters:

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

Returns:

true if delete was successful. false if there was nothing to delete.