Package org.craftercms.commons.file.blob

Interface BlobStore

All Known Implementing Classes:

AbstractBlobStore, AwsS3BlobStore

public interface BlobStore

Defines the operations to handle blob files

Since:

3.1.6

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_KEY_CONFIGURATION
static String	CONFIG_KEY_ID
static String	CONFIG_KEY_MAPPING
static String	CONFIG_KEY_MAPPING_PREFIX
static String	CONFIG_KEY_MAPPING_PUBLISHING_TARGET
static String	CONFIG_KEY_MAPPING_STORE_TARGET
static String	CONFIG_KEY_PATTERN

Method Summary

Modifier and Type	Method	Description
String	getId()	Returns the unique id of the store
org.springframework.core.io.Resource	getResource(String path, Blob blob)	Resolves the given blob to a readable resource
void	init(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)	Performs all setup needed with the given configuration
boolean	isCompatible(String path)	Indicates if the given path is compatible with the store

Field Detail

CONFIG_KEY_ID

static final String CONFIG_KEY_ID

See Also:

Constant Field Values

CONFIG_KEY_PATTERN

static final String CONFIG_KEY_PATTERN

See Also:

Constant Field Values

CONFIG_KEY_MAPPING

static final String CONFIG_KEY_MAPPING

See Also:

Constant Field Values

CONFIG_KEY_MAPPING_PUBLISHING_TARGET

static final String CONFIG_KEY_MAPPING_PUBLISHING_TARGET

See Also:

Constant Field Values

CONFIG_KEY_MAPPING_STORE_TARGET

static final String CONFIG_KEY_MAPPING_STORE_TARGET

See Also:

Constant Field Values

CONFIG_KEY_MAPPING_PREFIX

static final String CONFIG_KEY_MAPPING_PREFIX

See Also:

Constant Field Values

CONFIG_KEY_CONFIGURATION

static final String CONFIG_KEY_CONFIGURATION

See Also:

Constant Field Values

Method Detail

init

void init(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
   throws ConfigurationException

Performs all setup needed with the given configuration

Parameters:

config - the configuration object

Throws:

ConfigurationException - is any error occurs

getId

String getId()

Returns the unique id of the store

Returns:

the id

isCompatible

boolean isCompatible(String path)

Indicates if the given path is compatible with the store

Parameters:

path - path to check

Returns:

true if the path is compatible

getResource

org.springframework.core.io.Resource getResource(String path,
                                                 Blob blob)

Resolves the given blob to a readable resource

Parameters:

path - the path of the resource

blob - the blob file

Returns:

the resource object