org.craftercms.commons.file.blob.impl

Class AbstractBlobStore<T extends ConfigurationProfile>

java.lang.Object

org.craftercms.commons.file.blob.impl.AbstractBlobStore<T>

All Implemented Interfaces:

BlobStore

Direct Known Subclasses:

AwsS3BlobStore

public abstract class AbstractBlobStore<T extends ConfigurationProfile>
extends Object
implements BlobStore

Base class for all implementations of BlobStore

Since:

3.1.6

Author:

joseross

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBlobStore.Mapping Internal class used when loading the configuration

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id The id of the store
protected Map<String,AbstractBlobStore.Mapping>	mappings The mappings for the different environments
protected String	pattern The regex to check for compatible paths
protected T	profile The profile to connect to the remote store
protected ConfigurationMapper<T>	profileMapper The mapper to load the profile configuration
protected PublishingTargetResolver	publishingTargetResolver The publishing target resolver

Fields inherited from interface org.craftercms.commons.file.blob.BlobStore

CONFIG_KEY_CONFIGURATION, CONFIG_KEY_ID, CONFIG_KEY_MAPPING, CONFIG_KEY_MAPPING_PREFIX, CONFIG_KEY_MAPPING_PUBLISHING_TARGET, CONFIG_KEY_MAPPING_STORE_TARGET, CONFIG_KEY_PATTERN

Constructor Summary

Constructors

Constructor and Description
AbstractBlobStore()

Method Summary

Modifier and Type	Method and Description
protected abstract org.springframework.core.io.Resource	doGetContent(AbstractBlobStore.Mapping mapping, String path)
protected abstract void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
String	getId() Returns the unique id of the store
protected AbstractBlobStore.Mapping	getMapping(String publishingTarget)
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
void	setId(String id)
void	setPattern(String pattern)
void	setProfileMapper(ConfigurationMapper<T> profileMapper)
void	setPublishingTargetResolver(PublishingTargetResolver publishingTargetResolver)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

The id of the store

pattern

protected String pattern

The regex to check for compatible paths

mappings

protected Map<String,AbstractBlobStore.Mapping> mappings

The mappings for the different environments

profile

protected T extends ConfigurationProfile profile

The profile to connect to the remote store

profileMapper

protected ConfigurationMapper<T extends ConfigurationProfile> profileMapper

The mapper to load the profile configuration

publishingTargetResolver

protected PublishingTargetResolver publishingTargetResolver

The publishing target resolver

Constructor Detail

AbstractBlobStore

public AbstractBlobStore()

Method Detail

getId

public String getId()

Description copied from interface: BlobStore

Returns the unique id of the store

Specified by:

getId in interface BlobStore

Returns:

the id

setId

public void setId(String id)

setPattern

public void setPattern(String pattern)

setProfileMapper

public void setProfileMapper(ConfigurationMapper<T> profileMapper)

setPublishingTargetResolver

public void setPublishingTargetResolver(PublishingTargetResolver publishingTargetResolver)

isCompatible

public boolean isCompatible(String path)

Description copied from interface: BlobStore

Indicates if the given path is compatible with the store

Specified by:

isCompatible in interface BlobStore

Parameters:

path - path to check

Returns:

true if the path is compatible

init

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

Description copied from interface: BlobStore

Performs all setup needed with the given configuration

Specified by:

init in interface BlobStore

Parameters:

config - the configuration object

Throws:

ConfigurationException - is any error occurs

doInit

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

Throws:

ConfigurationException

getResource

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

Description copied from interface: BlobStore

Resolves the given blob to a readable resource

Specified by:

getResource in interface BlobStore

Parameters:

path - the path of the resource

blob - the blob file

Returns:

the resource object

doGetContent

protected abstract org.springframework.core.io.Resource doGetContent(AbstractBlobStore.Mapping mapping,
                                                                     String path)

getMapping

protected AbstractBlobStore.Mapping getMapping(String publishingTarget)