|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IVSD
IVSD defines the HQME Virtual Storage Device (VSD) plugin interface. It abstracts object-data and meta-data storage and indexing facilities for a variety of storage devices. Storage is hierarchical and easily mapped to different file systems..
Nested Class Summary | |
---|---|
static class |
IVSD.Stub
Local-side IPC implementation stub class. |
Method Summary | |
---|---|
java.lang.String[] |
allObjects(java.lang.String filter)
The purpose of this method is to retrieve all objects matching the optional filter, substring of the interested objects' name, if they are visible to the calling client's origin. |
IContentObject |
createObject(java.lang.String name)
Create a ContentObject object. |
long[] |
functionGroups()
The functionGroups is a read-only data member and is an array of longs where each value describes a function group of the VSD to which the VSD Interface is associated. |
Property[] |
getCommandStatus(int commandId)
Retrieve the status for a previously submitted VSD command. |
IContentObject |
getObject(java.lang.String name)
Retrieve a ContentObject instance which provides additional information and access to the underlying object. |
java.lang.String |
getProperty(java.lang.String key)
Retrieve a specific property associated with a VSD, as visible and relevant to the calling origin. |
java.lang.String[] |
getPropertyKeys()
Retrieve the current VSD property keys. |
int |
issueCommand(int commandId,
Property[] arguments)
Issue a VSD a command. |
java.lang.String |
name()
The name is a read only-data member and is the VSD name to which the VSD interface is associated. |
int |
removeObject(java.lang.String name)
Remove a ContentObject object. |
int |
removeProperty(java.lang.String key)
Remove a specific property associated with a VSD. |
int |
setProperty(java.lang.String key,
java.lang.String value)
Set a property key associated with a VSD |
int |
storageId()
The storageId is a read-only data member and is the VSD identifier, assigned by VSD storage manager, platform unique and persistent once assigned. |
Method Detail |
---|
int storageId() throws android.os.RemoteException
android.os.RemoteException
java.lang.String name() throws android.os.RemoteException
android.os.RemoteException
long[] functionGroups() throws android.os.RemoteException
android.os.RemoteException
java.lang.String[] allObjects(java.lang.String filter) throws android.os.RemoteException
filter
- The optional current "working" folder for the search. For example, "myFolder1/",
"myFolder1/mySubFolder1/" are valid filter, and NULL or empty string is treated as
the VSD root "folder".
android.os.RemoteException
IContentObject getObject(java.lang.String name) throws android.os.RemoteException
name
- of the content object. It is the complete "path" including the object name to be accessed.
android.os.RemoteException
IContentObject createObject(java.lang.String name) throws android.os.RemoteException
name
- The name of the object to be created. The object logical hierarchy is indicated if a relative path included.
Valid name example: "myObject1", "myFolder1/myObject1.mp3". The old object with the same name
will be overwritten.
android.os.RemoteException
int removeObject(java.lang.String name) throws android.os.RemoteException
name
- The name of the object to be remove. The object logical hierarchy is indicated if a relative path included.
Valid name example: "myObject1", "myFolder1/myObject1.mp3".
android.os.RemoteException
java.lang.String[] getPropertyKeys() throws android.os.RemoteException
android.os.RemoteException
java.lang.String getProperty(java.lang.String key) throws android.os.RemoteException
key
- Property key name. The following VSD properties are defined for all VSDs:
"VS_FN_GROUPS",
"VS_TOTAL_CAPACITY",
"VS_AVAILABLE_CAPACITY",
"VS_OBJECT_COUNT"
android.os.RemoteException
int setProperty(java.lang.String key, java.lang.String value) throws android.os.RemoteException
key
- Property keyvalue
- Property value. If the value is a binary chunk, it must be BASE64 encoded.
android.os.RemoteException
int removeProperty(java.lang.String key) throws android.os.RemoteException
key
- Property key name
android.os.RemoteException
int issueCommand(int commandId, Property[] arguments) throws android.os.RemoteException
commandId
- Command idarguments
- property array as arguments.
android.os.RemoteException
Property[] getCommandStatus(int commandId) throws android.os.RemoteException
commandId
- Command idresults
- Property array as results.
android.os.RemoteException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |