org.osgl.storage.impl

Class StorageServiceBase<SOBJ_TYPE extends SObject>

java.lang.Object

org.osgl.storage.impl.StorageServiceBase<SOBJ_TYPE>

All Implemented Interfaces:

IStorageService

Direct Known Subclasses:

AzureService, FileSystemService, S3Service

public abstract class StorageServiceBase<SOBJ_TYPE extends SObject>
extends Object
implements IStorageService

The implementation base of IStorageService

Nested Class Summary

Nested classes/interfaces inherited from interface org.osgl.storage.IStorageService

IStorageService.f

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	conf
static String	CONF_GET_META_ONLY Get Meta Data only
static String	CONF_GET_NO_GET For certain case for example, gallery application, it doesn’t need the GET operation because end user can access the object directly from aws’ static web service
static String	CONF_KEY_NAME_PROVIDER User supplied KeyNameProvider
static String	CONF_STATIC_WEB_ENDPOINT The static URL to retrieve cloud object
static String	CONF_STORE_SUFFIX Whether it shall ignore the suffix in the key or not
protected String	contextPath
protected KeyGenerator	keygen
protected static org.osgl.logging.Logger	logger
protected Map<String,IStorageService>	subFolders

Fields inherited from interface org.osgl.storage.IStorageService

CONF_CONTEXT_PATH, CONF_ID, CONF_KEY_GEN, DEFAULT, VERSION

Constructor Summary

Constructors

Constructor and Description
StorageServiceBase(Map<String,String> conf, Class<SOBJ_TYPE> sobjType)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure(Map<String,String> conf)
protected void	configure(Map<String,String> conf, String prefix)
String	contextPath() alias of IStorageService.getContextPath()
protected IStorageService	createSubFolder(String path)
protected abstract InputStream	doGetInputStream(String fullPath) Returns the input stream from fullPath specified.
protected abstract Map<String,String>	doGetMeta(String fullPath) Returns the meta attributes from fullPath specified.
protected abstract void	doPut(String fullPath, ISObject stuff, Map<String,String> attrs) Put the storage object specified by fullPath into the storage service.
protected abstract void	doRemove(String fullPath) Remove the storage object specified by fullPath.
ISObject	forceGet(String key) Force retrieving the stuff with content from storage without regarding to the configuration
ISObject	get(String key) Retrieve the stuff from the storage by key
protected String	getConfValue(Map<String,String> conf, String key, String def)
String	getContextPath() Return the context path.
ISObject	getFull(String key) Force retrieving the stuff with content from storage without regarding to the configuration
String	getKey() Returns a full path key with a generated unique key name
String	getKey(String keyName) Returns the full path key from the key name
ISObject	getLazy(String key, Map<String,String> attrs) Returns lazy SObject with attributes set.
protected Map<String,String>	getMeta(String key)
protected Map<String,String>	getMeta(String key, boolean force)
String	getStaticWebEndpoint() Return the static web endpoint configured
String	getUrl(String key) Return the URL to access a stored resource by key
String	id() Return the ID of the service.
boolean	isManaged(ISObject sobj) Report if a storage object is managed by this service
protected String	keyWithContextPath(String key)
ISObject	loadContent(ISObject sobj) Load content of an sobject.
protected abstract StorageServiceBase	newService(Map<String,String> conf)
protected abstract ISObject	newSObject(String key)
ISObject	put(String key, ISObject stuff) Update the stuff in the storage.
void	remove(String key) Remove the file from the storage by key and return it to caller.
void	setKeyGenerator(KeyGenerator keygen) Allow framework to set the KeyGenerator directly
void	setKeyNameProvider(KeyNameProvider keyNameProvider) Allow framework to set the KeyNameProvider directly
IStorageService	subFolder(String path) Returns a storage service whose root is a sub folder of this storage service

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.osgl.logging.Logger logger

CONF_GET_NO_GET

public static final String CONF_GET_NO_GET

For certain case for example, gallery application, it doesn’t need the GET operation because end user can access the object directly from aws’ static web service

See Also:

Constant Field Values

CONF_GET_META_ONLY

public static final String CONF_GET_META_ONLY

Get Meta Data only

See Also:

Constant Field Values

CONF_STATIC_WEB_ENDPOINT

public static final String CONF_STATIC_WEB_ENDPOINT

The static URL to retrieve cloud object

See Also:

Constant Field Values

CONF_STORE_SUFFIX

public static final String CONF_STORE_SUFFIX

Whether it shall ignore the suffix in the key or not

See Also:

Constant Field Values

CONF_KEY_NAME_PROVIDER

public static final String CONF_KEY_NAME_PROVIDER

User supplied KeyNameProvider

See Also:

Constant Field Values

keygen

protected KeyGenerator keygen

contextPath

protected String contextPath

conf

protected Map<String,String> conf

subFolders

protected Map<String,IStorageService> subFolders

Constructor Detail

StorageServiceBase

public StorageServiceBase(Map<String,String> conf,
                  Class<SOBJ_TYPE> sobjType)

Method Detail

configure

protected void configure(Map<String,String> conf)

configure

protected void configure(Map<String,String> conf,
             String prefix)

setKeyNameProvider

public void setKeyNameProvider(KeyNameProvider keyNameProvider)

Allow framework to set the KeyNameProvider directly

Parameters:

keyNameProvider - the key name provider instance

setKeyGenerator

public void setKeyGenerator(KeyGenerator keygen)

Allow framework to set the KeyGenerator directly

Parameters:

keygen - the key generator instance

id

public String id()

Description copied from interface: IStorageService

Return the ID of the service.

Specified by:

id in interface IStorageService

Returns:

the service id

contextPath

public String contextPath()

Description copied from interface: IStorageService

alias of IStorageService.getContextPath()

Specified by:

contextPath in interface IStorageService

Returns:

the context path

getKey

public String getKey(String keyName)

Returns the full path key from the key name

Specified by:

getKey in interface IStorageService

Parameters:

keyName - the key name (which does not contains the hierarchical path)

Returns:

the full path key

getKey

public String getKey()

Returns a full path key with a generated unique key name

Specified by:

getKey in interface IStorageService

Returns:

a full path key

forceGet

public ISObject forceGet(String key)

Description copied from interface: IStorageService

Force retrieving the stuff with content from storage without regarding to the configuration

Specified by:

forceGet in interface IStorageService

Returns:

the storage stuff

See Also:

IStorageService.getFull(String)

getLazy

public ISObject getLazy(String key,
               Map<String,String> attrs)

Description copied from interface: IStorageService

Returns lazy SObject with attributes set. This method is useful when user application choose to store attributes and key of SObject into database, and lazy load SObject content later one by calling IStorageService.loadContent(ISObject)

Specified by:

getLazy in interface IStorageService

Returns:

a sobject with meta attributes and key only. content of the sobject is not loaded

getContextPath

public String getContextPath()

Description copied from interface: IStorageService

Return the context path. A context path is the path from where all the storage should happen. By default context path is ""

Specified by:

getContextPath in interface IStorageService

Returns:

the context path

getStaticWebEndpoint

public String getStaticWebEndpoint()

Description copied from interface: IStorageService

Return the static web endpoint configured

Specified by:

getStaticWebEndpoint in interface IStorageService

Returns:

the configured static web endpoint

keyWithContextPath

protected String keyWithContextPath(String key)

subFolder

public IStorageService subFolder(String path)

Description copied from interface: IStorageService

Returns a storage service whose root is a sub folder of this storage service

Specified by:

subFolder in interface IStorageService

Parameters:

path - the path to sub folder

Returns:

the new storage service instance as described above

get

public final ISObject get(String key)

Description copied from interface: IStorageService

Retrieve the stuff from the storage by key

If file cannot be find by key, then null is returned

Specified by:

get in interface IStorageService

Returns:

the file associated with key or null if not found

getFull

public final ISObject getFull(String key)

Description copied from interface: IStorageService

Force retrieving the stuff with content from storage without regarding to the configuration

Specified by:

getFull in interface IStorageService

Returns:

the storage stuff

See Also:

IStorageService.loadContent(ISObject)

loadContent

public ISObject loadContent(ISObject sobj)

Description copied from interface: IStorageService

Load content of an sobject. If the content is already loaded, then the object should be returned directly

Specified by:

loadContent in interface IStorageService

Returns:

the sobject with content presented

put

public ISObject put(String key,
           ISObject stuff)

Description copied from interface: IStorageService

Update the stuff in the storage. If the existing file cannot be find in the storage then it will be added.

Specified by:

put in interface IStorageService

Returns:

The new SObject representing the persistent data

isManaged

public boolean isManaged(ISObject sobj)

Description copied from interface: IStorageService

Report if a storage object is managed by this service

Specified by:

isManaged in interface IStorageService

Parameters:

sobj - the sobject

Returns:

true if the sobject is managed by this service

getUrl

public String getUrl(String key)

Description copied from interface: IStorageService

Return the URL to access a stored resource by key

Specified by:

getUrl in interface IStorageService

Returns:

the URL

createSubFolder

protected final IStorageService createSubFolder(String path)

getMeta

protected Map<String,String> getMeta(String key)

getMeta

protected Map<String,String> getMeta(String key,
                         boolean force)

remove

public final void remove(String key)

Description copied from interface: IStorageService

Remove the file from the storage by key and return it to caller.

Specified by:

remove in interface IStorageService

getConfValue

protected final String getConfValue(Map<String,String> conf,
                  String key,
                  String def)

doRemove

protected abstract void doRemove(String fullPath)

Remove the storage object specified by fullPath. The fullPath is composed of * contextPath() * ISObject.getKey()

Parameters:

fullPath - the full path to locate the storage object

doGetMeta

protected abstract Map<String,String> doGetMeta(String fullPath)

Returns the meta attributes from fullPath specified. The fullPath is composed of * contextPath() * ISObject.getKey()

Parameters:

fullPath - the full path to locate the storage object

Returns:

the meta attributes of the storage object

doGetInputStream

protected abstract InputStream doGetInputStream(String fullPath)

Returns the input stream from fullPath specified. The fullPath is composed of * contextPath() * ISObject.getKey()

Parameters:

fullPath - the full path to locate the storage object

Returns:

the input stream to get the storage object

doPut

protected abstract void doPut(String fullPath,
         ISObject stuff,
         Map<String,String> attrs)

Put the storage object specified by fullPath into the storage service. The fullPath is composed of * contextPath() * ISObject.getKey()

Parameters:

fullPath - the full path to locate the storage object

attrs - the meta attributes of the storage object

newSObject

protected abstract ISObject newSObject(String key)

newService

protected abstract StorageServiceBase newService(Map<String,String> conf)