org.osgl.storage

Interface ISObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

SObject, StorageObject

public interface ISObject
extends Serializable

Represent an item stored in an IStorageService

Author:

greenl

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_CONTENT_LENGTH Store the content length
static String	ATTR_CONTENT_TYPE A standard attribute: content-type
static String	ATTR_FILE_NAME A standard attribute: filename
static String	ATTR_SS_CTX The storage service context path
static String	ATTR_SS_ID The storage service ID
static String	ATTR_URL Store the URL point to this sobject
static osgl.version.Version	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	asByteArray()
File	asFile()
InputStream	asInputStream() Returns an InputStream connect to the sobject.
String	asString()
String	asString(Charset charset)
void	consumeOnce(org.osgl.Osgl.Function<InputStream,?> consumer) Consume the inputstream of this storage object one time and then close the input stream
String	getAttribute(String key) Return attribute associated with this storage object by key.
Map<String,String>	getAttributes()
String	getContentType() Return content type attribute
Throwable	getException() Return previous exception that cause the sobject invalid
String	getFilename() Returns filename attribute
String	getKey()
long	getLength()
String	getUrl() Returns URL set to this SObject.
boolean	hasAttribute()
boolean	isDumb() Returns true if this SObject is dumb
boolean	isEmpty() Is content is empty
boolean	isValid() Is this storage object valid.
ISObject	setAttribute(String key, String val) Set an attribute to the storage object associated by key specified.
ISObject	setAttributes(Map<String,String> attrs) Set attributes to the storage object
void	setContentType(String contentType) Set content type attribute
void	setFilename(String filename) Set filename attribute

Field Detail

VERSION

static final osgl.version.Version VERSION

ATTR_CONTENT_TYPE

static final String ATTR_CONTENT_TYPE

A standard attribute: content-type

See Also:

Constant Field Values

ATTR_FILE_NAME

static final String ATTR_FILE_NAME

A standard attribute: filename

See Also:

Constant Field Values

ATTR_SS_ID

static final String ATTR_SS_ID

The storage service ID

See Also:

Constant Field Values

ATTR_SS_CTX

static final String ATTR_SS_CTX

The storage service context path

See Also:

Constant Field Values

ATTR_URL

static final String ATTR_URL

Store the URL point to this sobject

See Also:

Constant Field Values

ATTR_CONTENT_LENGTH

static final String ATTR_CONTENT_LENGTH

Store the content length

See Also:

Constant Field Values

Method Detail

getKey

String getKey()

Returns:

key of this object

getLength

long getLength()

Returns:

length of the object

getUrl

String getUrl()

Returns URL set to this SObject.

Calling to this method shall have the same result as calling getAttribute(String) using ATTR_URL:

    String url = sobj.getAttribute(ISObject.ATTR_URL);

Returns:

the url to this SObject

getFilename

String getFilename()

Returns filename attribute

Returns:

filename

getContentType

String getContentType()

Return content type attribute

Returns:

content type

setFilename

void setFilename(String filename)

Set filename attribute

Parameters:

filename - the filename to be set

setContentType

void setContentType(String contentType)

Set content type attribute

Parameters:

contentType - the content type to be set

getAttribute

String getAttribute(String key)

Return attribute associated with this storage object by key. If there is no such attribute found then null is returned

Returns:

the attribute if found or null if not found

setAttribute

ISObject setAttribute(String key,
                    String val)

Set an attribute to the storage object associated by key specified.

Parameters:

key - attribute key

val - attribute value

setAttributes

ISObject setAttributes(Map<String,String> attrs)

Set attributes to the storage object

Parameters:

attrs -

Returns:

the object with attributes set

hasAttribute

boolean hasAttribute()

Returns:

true if the storage object has attributes

getAttributes

Map<String,String> getAttributes()

Returns:

a copy of attributes of this storage object

isEmpty

boolean isEmpty()

Is content is empty

Returns:

if the instance is empty

isValid

boolean isValid()

Is this storage object valid. A storage object is not valid if the file/input stream is not readable

Returns:

true if this instance is valid or false otherwise

getException

Throwable getException()

Return previous exception that cause the sobject invalid

Returns:

the previous exception

asFile

File asFile()
            throws org.osgl.exception.UnexpectedIOException

Returns:

the the stuff content as an file

Throws:

org.osgl.exception.UnexpectedIOException

asString

String asString()
                throws org.osgl.exception.UnexpectedIOException

Returns:

the stuff content as a string

Throws:

org.osgl.exception.UnexpectedIOException

asString

String asString(Charset charset)
                throws org.osgl.exception.UnexpectedIOException

Returns:

the stuff content as a string using the charset to encode

Throws:

org.osgl.exception.UnexpectedIOException

asByteArray

byte[] asByteArray()
                   throws org.osgl.exception.UnexpectedIOException

Returns:

the stuff content as a byte array

Throws:

org.osgl.exception.UnexpectedIOException

asInputStream

InputStream asInputStream()
                          throws org.osgl.exception.UnexpectedIOException

Returns an InputStream connect to the sobject. Note it is caller’s responsibility to close the inputStream

Returns:

the stuff content as an input stream

Throws:

org.osgl.exception.UnexpectedIOException

consumeOnce

void consumeOnce(org.osgl.Osgl.Function<InputStream,?> consumer)
                 throws org.osgl.exception.UnexpectedIOException

Consume the inputstream of this storage object one time and then close the input stream

Parameters:

consumer - the consumer function

Throws:

org.osgl.exception.UnexpectedIOException

isDumb

boolean isDumb()

Returns true if this SObject is dumb

Returns:

true if this instance is dumb