|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Universe
Universe interface.
Version History
EPG - Adapted from another project - 16 MAY 04 EPG - Add Make-Local concept - 2 SEP 06
Field Summary | |
---|---|
static java.lang.String |
CONFIG_CLEARANCE
|
static java.lang.String |
CONFIG_LIST
|
static java.lang.String |
CONFIG_NAME
|
static java.lang.String |
CONFIG_PATH
|
static java.lang.String |
CONFIG_ROOT
|
static java.lang.String |
CONFIG_TYPE
|
static java.lang.String |
CONFIG_TYPE_LOCAL
|
Method Summary | |
---|---|
void |
delete(java.lang.String... name)
Delete an object. |
void |
deleteByKey(java.lang.String key)
Delete an object by Key. |
boolean |
exists(java.lang.String... name)
Check to see if an object exists |
java.lang.String |
feature(java.lang.String name,
ThingsPropertyView params)
Activate a feature by name. |
java.lang.String |
featureByKey(java.lang.String key,
ThingsPropertyView params)
Activate a feature by name. |
void |
finalizeUniverse()
This will always be called when the universe is accessor is destroyed. |
UniverseID |
getId()
Get the id for this universe. |
Accessor |
getObjectAccessor(java.lang.String... name)
Get an object accessor for the named object. |
java.io.InputStream |
getStream(java.lang.String... name)
Get an InputStream that can read from the universe object |
java.io.InputStream |
getStreamByKey(java.lang.String key)
Get an InputStream that can read from the universe object. |
java.lang.String |
getValidatedName(java.lang.String... name)
Get a validated name for the object. |
boolean |
isLocked(java.lang.String... name)
Check to see if the object is locked |
long |
lastModifiedDate(java.lang.String... name)
Get the last modified date in milliseconds from epoch time. |
java.lang.String |
lock(java.lang.String... name)
Lock an object. |
java.io.File |
makeLocal(java.lang.String... name)
Make a local reference or copy of the object in a FILE. |
java.util.Collection<java.lang.String> |
match(java.lang.String... name)
Get all the object names that match the path. |
java.io.OutputStream |
putStream(java.lang.String... name)
Get an OutputStream that can write to the universe object. |
java.io.OutputStream |
putStreamAppender(java.lang.String... name)
Get an OutputStream that can write to the universe object. |
java.io.OutputStream |
putStreamAppenderByKey(java.lang.String key)
Get an OutputStream that can write to the universe object. |
java.io.OutputStream |
putStreamByKey(java.lang.String key)
Get an OutputStream that can write to the universe object. |
void |
releaseLocal(java.io.File theLocalFile)
Release a local reference or copy of the object in a FILE. |
java.lang.String |
reserveUnique(java.lang.String base)
Reserve unique object in the universe. |
long |
size(java.lang.String... name)
Report the size object from the universe in bytes. |
boolean |
unlock(java.lang.String key)
Unlock an object using a key for this operation only. |
Field Detail |
---|
static final java.lang.String CONFIG_PATH
static final java.lang.String CONFIG_LIST
static final java.lang.String CONFIG_ROOT
static final java.lang.String CONFIG_TYPE
static final java.lang.String CONFIG_TYPE_LOCAL
static final java.lang.String CONFIG_NAME
static final java.lang.String CONFIG_CLEARANCE
Method Detail |
---|
UniverseID getId() throws UniverseException
UniverseException
UniverseID
java.lang.String getValidatedName(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
Accessor getObjectAccessor(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
java.io.InputStream getStream(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
java.io.InputStream getStreamByKey(java.lang.String key) throws UniverseException
key
- a valid key for the object
UniverseException
java.io.OutputStream putStream(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
java.io.OutputStream putStreamByKey(java.lang.String key) throws UniverseException
key
- a valid key for the object
UniverseException
java.io.OutputStream putStreamAppender(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
java.io.OutputStream putStreamAppenderByKey(java.lang.String key) throws UniverseException
key
- a valid key for the object
UniverseException
java.lang.String reserveUnique(java.lang.String base) throws UniverseException
base
- base path for the object (including root object name)
UniverseException
java.lang.String lock(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
boolean unlock(java.lang.String key) throws UniverseException
key
- a key that can unlock it
UniverseException
boolean isLocked(java.lang.String... name) throws UniverseException
name
- universe object name (name components will be appended).
UniverseException
java.io.File makeLocal(java.lang.String... name) throws UniverseException
This will lock the object until released. No other operations will be allowed.
This could be a good way to subvert security, if the implementation allows it. It is up to the implementation to keep the world safe from local files.
name
- universe object name (path components will be appended).
UniverseException
void releaseLocal(java.io.File theLocalFile) throws UniverseException
theLocalFile
- the file. If nonsensical, it will quietly return.
UniverseException
boolean exists(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
void delete(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
void deleteByKey(java.lang.String key) throws UniverseException
key
- a key that can unlock it
UniverseException
long size(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
long lastModifiedDate(java.lang.String... name) throws UniverseException
name
- universe object name (path components will be appended).
UniverseException
java.util.Collection<java.lang.String> match(java.lang.String... name) throws UniverseException
name
- universe object name, partial name, and/or path (path components will be appended)
UniverseException
java.lang.String feature(java.lang.String name, ThingsPropertyView params) throws UniverseException
name
- name of the featureparams
- parameters for the feature expressed as a view
UniverseException
ThingsPropertyView
java.lang.String featureByKey(java.lang.String key, ThingsPropertyView params) throws UniverseException
key
- key to the objectparams
- parameters for the feature expressed as a view
UniverseException
ThingsPropertyView
void finalizeUniverse() throws UniverseException
UniverseException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |