Spec Documentation for Simple_storage

Note the terminology applied through this interface: "file" only refers to a leaf in the hierarchical structure (containing blocks of data), "directory" only refers to a branch in the structure (containing files or directories), while "entity" is the generic term which applies to either one of these. A "key" is an orthogonal concept which represents a named meta-data entry attached to an entity (itself, containing only blocks of data).


Methods

Method: "com.openautonomy.protocols.simple_storage.getEntityListInDirectory" (XML-RPC)

Returns the list of entity tuples in the specified directoryPath or null if there was a problem. If all entities are desired, send the empty string as the mimePrefix. Note that this is a prefix and not a regex so sending something like "image/" will get all images while "image/*" will return nothing.

Arguments

Returns: entityDataArray

Method: "com.openautonomy.protocols.simple_storage.getFileSystemInfo" (XML-RPC)

(No Arguments) Returns: fileSystemInfo

Method: "com.openautonomy.protocols.simple_storage.createFile" (XML-RPC)

If the MIME is unknown, pass an empty string (it is only a hint, anyway, so the server is expected to over-ride it if it has MIME detection capability - most servers do). Returns the Url of the newly created file, on success.
"size" must be a base-10 string to avoid large number problems in XML-RPC and some languages (PHP, JS, etc).

Arguments

Returns: stringUrl

Method: "com.openautonomy.protocols.simple_storage.uploadToFile" POST

"offset" must be a base-10 string to avoid large number problems in XML-RPC and some languages (PHP, JS, etc).

Arguments

Returns: none

Method: "com.openautonomy.protocols.simple_storage.deleteEntity" (XML-RPC)

Arguments

Returns: boolean

Method: "com.openautonomy.protocols.simple_storage.setEntityTrustGroup" (XML-RPC)

Arguments

Returns: string100

Method: "com.openautonomy.protocols.simple_storage.renameEntity" (XML-RPC)

Arguments

Returns: stringUrl

Method: "com.openautonomy.protocols.simple_storage.downloadFile" GET

Arguments

Returns: none

Method: "com.openautonomy.protocols.simple_storage.createDirectory" (XML-RPC)

Arguments

Returns: boolean

Method: "com.openautonomy.protocols.simple_storage.getKeyListForEntity" (XML-RPC)

Returns the list of key tuples associated with the given file (or directory) path or null if there was a problem.

Arguments

Returns: keyDataArray

Method: "com.openautonomy.protocols.simple_storage.createKey" (XML-RPC)

Keys allow a file or directory to be decorated with a flat namespace of additional arbitrary data. They operate like files and contribute to total space used but they differ in that they strictly inherit their encompassing file's trust group and all keys are destroyed whenever the encompassing file or directory is changed.
File change: A write to the file data.
Directory change: A change to any file or directory it contains (this is recursive all the way up the directory tree), creating or deleting a file within the directory (this includes renames), changing the trust group on any file in the directory.
If the MIME is unknown, pass an empty string (it is only a hint, anyway, so the server is expected to over-ride it if it has MIME detection capability - most servers do). Returns the Url of the newly created file, on success.
"size" must be a base-10 string to avoid large number problems in XML-RPC and some languages (PHP, JS, etc).

Arguments

Returns: stringUrl

Method: "com.openautonomy.protocols.simple_storage.uploadToKey" POST

"offset" must be a base-10 string to avoid large number problems in XML-RPC and some languages (PHP, JS, etc).

Arguments

Returns: none

Method: "com.openautonomy.protocols.simple_storage.deleteKey" (XML-RPC)

Arguments

Returns: boolean

Method: "com.openautonomy.protocols.simple_storage.downloadKey" GET

Arguments

Returns: none

Variable Types

Array types

Struct types

Primitive Types

Constrained Types


Errors