com.sdl.delivery.deployer.api.binarystorage

Interface BinaryStorageAdapter<T extends BinaryStorage>

Type Parameters:

T - BinaryStorage implementation

public interface BinaryStorageAdapter<T extends BinaryStorage>

The adapter for any Binary Storage type. An instance of an implementation of this interface, once configured is capable of producing a Binary Storage of a certain type. For instance, one implementation of this adapter could be used to provide a FS-based Binary Storage.

Method Summary

Modifier and Type	Method and Description
void	configure(com.sdl.delivery.configuration.Configuration configuration) Configure the Binary Storage Adapter.
T	getBinaryStorage() Provides a Binary Storage based on the Binary Storage configuration supplied earlier to the Adapter.

Method Detail

configure

void configure(com.sdl.delivery.configuration.Configuration configuration)
        throws com.sdl.delivery.configuration.ConfigurationException

Configure the Binary Storage Adapter.

Parameters:

configuration - The Binary Storage configuration (can not be null).

Throws:

com.sdl.delivery.configuration.ConfigurationException - In case something goes wrong reading the configuration.

IllegalStateException - if Configuration is null.

getBinaryStorage

T getBinaryStorage()

Provides a Binary Storage based on the Binary Storage configuration supplied earlier to the Adapter. This means that before invoking this method, the adapter must be configured.

Returns:

The provided Binary Storage (or null if configure(Configuration) was not called).