org.osgl.storage

Interface IStorageService

All Known Implementing Classes:

AzureService, BlobService, FileSystemService, S3Service, StorageServiceBase

public interface IStorageService

Provide persistent service for ISObject

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IStorageService.f

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONF_CONTEXT_PATH
static String	CONF_ID
static String	CONF_KEY_GEN
static String	DEFAULT
static osgl.version.Version	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
String	contextPath() alias of getContextPath()
ISObject	forceGet(String key) Deprecated.
ISObject	get(String key) Retrieve the stuff from the storage by key
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()
String	getKey(String key)
ISObject	getLazy(String key, Map<String,String> attrs) Returns lazy SObject with attributes set.
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
ISObject	loadContent(ISObject sobj) Load content of an sobject.
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.
IStorageService	subFolder(String path) Returns a storage service whose root is a sub folder of this storage service

Field Detail

VERSION

static final osgl.version.Version VERSION

DEFAULT

static final String DEFAULT

See Also:

Constant Field Values

CONF_KEY_GEN

static final String CONF_KEY_GEN

See Also:

Constant Field Values

CONF_CONTEXT_PATH

static final String CONF_CONTEXT_PATH

See Also:

Constant Field Values

CONF_ID

static final String CONF_ID

See Also:

Constant Field Values

Method Detail

id

String id()

Return the ID of the service.

Returns:

the service id

contextPath

String contextPath()

alias of getContextPath()

Returns:

the context path

get

ISObject get(String key)

Retrieve the stuff from the storage by key

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

Parameters:

key -

Returns:

the file associated with key or null if not found

getLazy

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

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 loadContent(ISObject)

Parameters:

key -

attrs -

Returns:

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

forceGet

ISObject forceGet(String key)

Deprecated.

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

Parameters:

key -

Returns:

the storage stuff

See Also:

getFull(String)

getFull

ISObject getFull(String key)

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

Parameters:

key -

Returns:

the storage stuff

See Also:

loadContent(ISObject)

loadContent

ISObject loadContent(ISObject sobj)

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

Parameters:

sobj -

Returns:

the sobject with content presented

put

ISObject put(String key,
           ISObject stuff)
             throws org.osgl.exception.UnexpectedIOException

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

Parameters:

key -

stuff -

Returns:

The new SObject representing the persistent data

Throws:

org.osgl.exception.UnexpectedIOException

isManaged

boolean isManaged(ISObject sobj)

Report if a storage object is managed by this service

Parameters:

sobj - the sobject

Returns:

true if the sobject is managed by this service

remove

void remove(String key)

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

Parameters:

key -

getContextPath

String getContextPath()

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

Returns:

the context path

getStaticWebEndpoint

String getStaticWebEndpoint()

Return the static web endpoint configured

Returns:

the configured static web endpoint

getUrl

String getUrl(String key)

Return the URL to access a stored resource by key

Parameters:

key -

Returns:

the URL

getKey

String getKey(String key)

getKey

String getKey()

subFolder

IStorageService subFolder(String path)

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

Parameters:

path - the path to sub folder

Returns:

the new storage service instance as described above