SObject (Java Storage Service 1.5.0 API)

java.lang.Object
- org.osgl.storage.impl.SObject

All Implemented Interfaces:

Serializable, ISObject

Direct Known Subclasses:

StorageObject
```
public abstract class SObject
extends Object
implements ISObject
```
The implementation of ISObject

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Throwable cause

protected boolean valid
- Fields inherited from interface org.osgl.storage.ISObject
  ATTR_CONTENT_LENGTH, ATTR_CONTENT_TYPE, ATTR_FILE_NAME, ATTR_SS_CTX, ATTR_SS_ID, ATTR_URL, VERSION

Fields
Modifier and Type	Field and Description
`protected Throwable`	`cause`
`protected boolean`	`valid`

Method Summary

Methods
Modifier and Type	Method and Description
`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
`static SObject`	`getInvalidObject(String key, Throwable cause)`
`String`	`getKey()`
`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.
`static SObject`	`lazyLoad(String key, IStorageService ss)`
`static SObject`	`lazyLoad(String key, IStorageService ss, Map<String,String> conf)`
`static SObject`	`lazyLoad(String key, IStorageService ss, String... attrs)`
`static SObject`	`loadResource(String url)` Load an sobject from classpath by given url path
`static SObject`	`of(byte[] buf)` Construct an sobject with content in byte array and a random generated key
`static SObject`	`of(byte[] buf, int len)` Construct an SObject with random generated key, byte array and number of bytes
`static SObject`	`of(File file)` Construct an SObject with file specified.
`static SObject`	`of(InputStream is)` Construct an sobject with specified input stream and a randomly generated key.
`static SObject`	`of(String content)` Construct an sobject with specified content in String and a randomly generated key
`static SObject`	`of(String key, byte[] buf)` Construct an sobject with specified key and byte array.
`static SObject`	`of(String key, byte[] buf, int len)` Construct an SObject with specified key, byte array and number of bytes
`static SObject`	`of(String key, byte[] buf, Map<String,String> attrs)` Construct an sobject with specified key, content as byte array and attributes in `Map`
`static SObject`	`of(String key, byte[] buf, String... attrs)` Construct an sobject with specified key, content in byte array and attributes in sequence of key1, val1, key1, val2, …
`static SObject`	`of(String key, File file)` Construct an SObject with key and file specified
`static SObject`	`of(String key, File file, Map<String,String> attributes)` Construct an SObject with specified key, file and attributes specified in `Map`
`static SObject`	`of(String key, File file, String... attrs)` Construct an SObject with key, file and attributes specified in key1, val1, key2, val2… sequence
`static SObject`	`of(String key, InputStream is)` Construct an SObject with key and input stream.
`static SObject`	`of(String key, InputStream is, Map<String,String> conf)` Construct a sobject with key, input stream and attributes specified in a `Map`.
`static SObject`	`of(String key, InputStream is, String... attrs)` Construct a sobject with key, input stream and attributes specified in a sequence like key1, val1, key2, val2, …
`static SObject`	`of(String key, String content)` Construct an sobject with content and key specified
`static SObject`	`of(String key, String content, Map<String,String> attrs)` Construct an sobject with content, key and attributes specified in `Map`
`static SObject`	`of(String key, String content, String... attrs)` Construct an sobject with key, content and attributes specified in sequence key1, val1, key2, val2, …
`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
`protected void`	`setAttrs(Map<String,String> attrs)`
`void`	`setContentType(String contentType)` Set `content type` attribute
`void`	`setFilename(String filename)` Set `filename` attribute
`protected String`	`suffix()`
`static SObject`	`valueOf(String key, byte[] buf)` Deprecated.
`static SObject`	`valueOf(String key, byte[] buf, Map<String,String> attrs)` Deprecated.
`static SObject`	`valueOf(String key, byte[] buf, String... attrs)` Deprecated.
`static SObject`	`valueOf(String key, File f)` Deprecated.
`static SObject`	`valueOf(String key, File file, Map<String,String> conf)` Deprecated.
`static SObject`	`valueOf(String key, File file, String... attrs)` Deprecated.
`static SObject`	`valueOf(String key, InputStream is)` Deprecated.
`static SObject`	`valueOf(String key, InputStream is, Map<String,String> conf)` Deprecated.
`static SObject`	`valueOf(String key, InputStream is, String... attrs)` Deprecated.
`static SObject`	`valueOf(String key, ISObject copy)`
`static SObject`	`valueOf(String key, String content)` Deprecated.
`static SObject`	`valueOf(String key, String content, Map<String,String> attrs)` Deprecated.
`static SObject`	`valueOf(String key, String content, String... attrs)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.osgl.storage.ISObject
asByteArray, asFile, asInputStream, asString, asString, getLength

- Field Detail
  - valid
```
protected boolean valid
```
  - cause
```
protected Throwable cause
```
- Method Detail
  - isDumb
```
public boolean isDumb()
```
    Description copied from interface: ISObject
    
    Returns true if this SObject is dumb
    
    Specified by:
    
    isDumb in interface ISObject
    
    Returns:
    true if this instance is dumb
  - getInvalidObject
```
public static SObject getInvalidObject(String key,
                       Throwable cause)
```
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface ISObject
    
    Returns:
    key of this object
  - setAttrs
```
protected void setAttrs(Map<String,String> attrs)
```
  - getUrl
```
public String getUrl()
```
    Description copied from interface: ISObject
    Returns URL set to this SObject.
    
    Calling to this method shall have the same result as calling ISObject.getAttribute(String) using ISObject.ATTR_URL:
```
    String url = sobj.getAttribute(ISObject.ATTR_URL);
```
    Specified by:
    
    getUrl in interface ISObject
    
    Returns:
    the url to this SObject
  - getFilename
```
public String getFilename()
```
    Description copied from interface: ISObject
    
    Returns filename attribute
    
    Specified by:
    
    getFilename in interface ISObject
    
    Returns:
    filename
  - getContentType
```
public String getContentType()
```
    Description copied from interface: ISObject
    
    Return content type attribute
    
    Specified by:
    
    getContentType in interface ISObject
    
    Returns:
    content type
  - setFilename
```
public void setFilename(String filename)
```
    Description copied from interface: ISObject
    
    Set filename attribute
    
    Specified by:
    
    setFilename in interface ISObject
    
    Parameters:
    filename - the filename to be set
  - setContentType
```
public void setContentType(String contentType)
```
    Description copied from interface: ISObject
    
    Set content type attribute
    
    Specified by:
    
    setContentType in interface ISObject
    
    Parameters:
    contentType - the content type to be set
  - getAttribute
```
public String getAttribute(String key)
```
    Description copied from interface: ISObject
    
    Return attribute associated with this storage object by key. If there is no such attribute found then null is returned
    
    Specified by:
    
    getAttribute in interface ISObject
    
    Returns:
    the attribute if found or null if not found
  - setAttribute
```
public ISObject setAttribute(String key,
                    String val)
```
    Description copied from interface: ISObject
    
    Set an attribute to the storage object associated by key specified.
    
    Specified by:
    
    setAttribute in interface ISObject
    
    Parameters:
    key - attribute key
    val - attribute value
  - setAttributes
```
public ISObject setAttributes(Map<String,String> attrs)
```
    Description copied from interface: ISObject
    
    Set attributes to the storage object
    
    Specified by:
    
    setAttributes in interface ISObject
    
    Returns:
    the object with attributes set
  - hasAttribute
```
public boolean hasAttribute()
```
    Specified by:
    
    hasAttribute in interface ISObject
    
    Returns:
    true if the storage object has attributes
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface ISObject
    
    Returns:
    a copy of attributes of this storage object
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ISObject
    
    Is content is empty
    
    Specified by:
    
    isEmpty in interface ISObject
    
    Returns:
    if the instance is empty
  - isValid
```
public boolean isValid()
```
    Description copied from interface: ISObject
    
    Is this storage object valid. A storage object is not valid if the file/input stream is not readable
    
    Specified by:
    
    isValid in interface ISObject
    
    Returns:
    true if this instance is valid or false otherwise
  - getException
```
public Throwable getException()
```
    Description copied from interface: ISObject
    
    Return previous exception that cause the sobject invalid
    
    Specified by:
    
    getException in interface ISObject
    
    Returns:
    the previous exception
  - consumeOnce
```
public void consumeOnce(org.osgl.Osgl.Function<InputStream,?> consumer)
```
    Description copied from interface: ISObject
    
    Consume the inputstream of this storage object one time and then close the input stream
    
    Specified by:
    
    consumeOnce in interface ISObject
    
    Parameters:
    consumer - the consumer function
  - suffix
```
protected final String suffix()
```
  - of
```
public static SObject of(File file)
```
    Construct an SObject with file specified. The key to the sobject is the file’s path
    
    Parameters:
    file -
    
    Returns:
    an SObject
  - of
```
public static SObject of(String key,
         File file)
```
    Construct an SObject with key and file specified
    
    See Also:
    of(String, java.io.File, java.util.Map)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         File f)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, java.io.File)
  - of
```
public static SObject of(String key,
         File file,
         Map<String,String> attributes)
```
    Construct an SObject with specified key, file and attributes specified in Map
    
    See Also:
    of(String, java.io.File, String...)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         File file,
                         Map<String,String> conf)
```
    Deprecated.
    
    See Also:
    of(String, java.io.File, java.util.Map)
  - of
```
public static SObject of(String key,
         File file,
         String... attrs)
```
    Construct an SObject with key, file and attributes specified in key1, val1, key2, val2… sequence
    
    See Also:
    of(String, java.io.File, java.util.Map)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         File file,
                         String... attrs)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, java.io.File, String...)
  - of
```
public static SObject of(InputStream is)
```
    Construct an sobject with specified input stream and a randomly generated key.
    
    Node the sobject constrcuted from input stream has limits please see the comment to of(String, java.io.InputStream)
    
    See Also:
    of(String, java.io.InputStream)
  - loadResource
```
public static SObject loadResource(String url)
```
    Load an sobject from classpath by given url path
    
    This method will call Class.getResource(String) method to open an inputstream to the resource and then construct an SObject with the inputstream
    
    Parameters:
    url - the resource url path
    
    Returns:
    the sobject instance if loaded successfully or null if cannot load resource from the url
  - of
```
public static SObject of(String key,
         InputStream is)
```
    Construct an SObject with key and input stream. Note unlike sobject constructed with String, byte array or file, the sobject constructed with input stream can only be read for one time. If the program tries to access the Sobject the second time, it will encountered an UnexpectedIOException. Another limit of this sobject is it does not support ISObject.getLength() method
    
    If it needs to construct an SObject without these limits from an input stream, then it shall first read the inputstream into a bytearray, and use the byte array to construct the sobject like following code
```
 InputStream is = … … ISObject sobj = SObject.of(IO.readContent(is)) 
```
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         InputStream is)
```
    Deprecated.
    
    deprecated
    
    See Also:
    of(String, java.io.InputStream)
  - of
```
public static SObject of(String key,
         InputStream is,
         Map<String,String> conf)
```
    Construct a sobject with key, input stream and attributes specified in a Map.
    
    Node the sobject constrcuted from input stream has limits please see the comment to of(String, java.io.InputStream)
    
    See Also:
    of(String, java.io.InputStream)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         InputStream is,
                         Map<String,String> conf)
```
    Deprecated.
    
    deprecated
    
    See Also:
    of(String, java.io.InputStream, java.util.Map)
  - of
```
public static SObject of(String key,
         InputStream is,
         String... attrs)
```
    Construct a sobject with key, input stream and attributes specified in a sequence like key1, val1, key2, val2, …
    
    Node the sobject constrcuted from input stream has limits please see the comment to of(String, java.io.InputStream)
    
    See Also:
    of(String, java.io.InputStream)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         InputStream is,
                         String... attrs)
```
    Deprecated.
    
    deprecated
    
    See Also:
    of(String, java.io.File, String...)
  - of
```
public static SObject of(String content)
```
    Construct an sobject with specified content in String and a randomly generated key
    
    See Also:
    of(String, String)
  - of
```
public static SObject of(String key,
         String content)
```
    Construct an sobject with content and key specified
    
    See Also:
    of(String, String, Map)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         String content)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, String)
  - of
```
public static SObject of(String key,
         String content,
         Map<String,String> attrs)
```
    Construct an sobject with content, key and attributes specified in Map
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         String content,
                         Map<String,String> attrs)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, String, java.util.Map)
  - of
```
public static SObject of(String key,
         String content,
         String... attrs)
```
    Construct an sobject with key, content and attributes specified in sequence key1, val1, key2, val2, …
    
    See Also:
    of(String, String, java.util.Map)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         String content,
                         String... attrs)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, String, String...)
  - of
```
public static SObject of(byte[] buf)
```
    Construct an sobject with content in byte array and a random generated key
    
    See Also:
    of(String, byte[])
  - of
```
public static SObject of(String key,
         byte[] buf)
```
    Construct an sobject with specified key and byte array.
    
    Note the byte array will be used directly without copying into an new array.
    
    See Also:
    of(String, byte[], java.util.Map)
  - of
```
public static SObject of(byte[] buf,
         int len)
```
    Construct an SObject with random generated key, byte array and number of bytes
    
    Parameters:
    buf - the source byte array
    len - the number of bytes in the array should be stored in the returing object
    
    Returns:
    an SObject as described above
  - of
```
public static SObject of(String key,
         byte[] buf,
         int len)
```
    Construct an SObject with specified key, byte array and number of bytes
    
    Parameters:
    key - the key
    buf - the source byte array
    len - the number of bytes in the array should be stored in the returing object
    
    Returns:
    an SObject as described above
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         byte[] buf)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, byte[])
  - of
```
public static SObject of(String key,
         byte[] buf,
         Map<String,String> attrs)
```
    Construct an sobject with specified key, content as byte array and attributes in Map
    
    See Also:
    of(String, byte[], String...)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         byte[] buf,
                         Map<String,String> attrs)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, byte[], java.util.Map)
  - of
```
public static SObject of(String key,
         byte[] buf,
         String... attrs)
```
    Construct an sobject with specified key, content in byte array and attributes in sequence of key1, val1, key1, val2, …
    
    See Also:
    of(String, byte[], java.util.Map)
  - valueOf
```
@Deprecated
public static SObject valueOf(String key,
                         byte[] buf,
                         String... attrs)
```
    Deprecated.
    
    Deprecated
    
    See Also:
    of(String, byte[], String...)
  - valueOf
```
public static SObject valueOf(String key,
              ISObject copy)
```
  - lazyLoad
```
public static SObject lazyLoad(String key,
               IStorageService ss)
```
  - lazyLoad
```
public static SObject lazyLoad(String key,
               IStorageService ss,
               Map<String,String> conf)
```
  - lazyLoad
```
public static SObject lazyLoad(String key,
               IStorageService ss,
               String... attrs)
```

Class SObject

Field Summary

Fields inherited from interface org.osgl.storage.ISObject

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.osgl.storage.ISObject

Field Detail

valid

cause

Method Detail

isDumb

getInvalidObject

getKey

setAttrs

getUrl

getFilename

getContentType

setFilename

setContentType

getAttribute

setAttribute

setAttributes

hasAttribute

getAttributes

isEmpty

isValid

getException

consumeOnce

suffix

of

of

valueOf

of

valueOf

of

valueOf

of

loadResource

of

valueOf

of

valueOf

of

valueOf

of

of

valueOf

of

valueOf

of

valueOf

of

of

of

of

valueOf

of

valueOf

of

valueOf

valueOf

lazyLoad

lazyLoad

lazyLoad