me.adaptive.arp.api

Class FileSystemBridge

java.lang.Object

me.adaptive.arp.api.BaseDataBridge

me.adaptive.arp.api.FileSystemBridge

All Implemented Interfaces:

APIBridge, IAdaptiveRP, IBaseData, IFileSystem

public class FileSystemBridge
extends BaseDataBridge
implements IFileSystem, APIBridge

Interface for Managing the File System operations Auto-generated implementation of IFileSystem specification.

Field Summary

Fields inherited from class me.adaptive.arp.api.BaseDataBridge

apiGroup

Constructor Summary

Constructors

Constructor and Description
FileSystemBridge(IFileSystem delegate) Constructor with delegate.

Method Summary

Modifier and Type	Method and Description
FileDescriptor	createFileDescriptor(FileDescriptor parent, java.lang.String name) Creates a new reference to a new or existing location in the filesystem.
FileDescriptor	getApplicationCacheFolder() Returns a reference to the cache folder for the current application.
FileDescriptor	getApplicationCloudFolder() Returns a reference to the cloud synchronizable folder for the current application.
FileDescriptor	getApplicationDocumentsFolder() Returns a reference to the documents folder for the current application.
FileDescriptor	getApplicationFolder() Returns a reference to the application installation folder.
FileDescriptor	getApplicationProtectedFolder() Returns a reference to the protected storage folder for the current application.
IFileSystem	getDelegate() Get the delegate implementation.
char	getSeparator() Returns the file system dependent file separator.
FileDescriptor	getSystemExternalFolder() Returns a reference to the external storage folder provided by the OS.
APIResponse	invoke(APIRequest request) Invokes the given method specified in the API request object.
void	setDelegate(IFileSystem delegate) Set the delegate implementation.

Methods inherited from class me.adaptive.arp.api.BaseDataBridge

getAPIGroup, getAPIVersion, getJSONParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Constructor Detail

FileSystemBridge

public FileSystemBridge(IFileSystem delegate)

Constructor with delegate.

Parameters:

delegate - The delegate implementing platform specific functions.

Method Detail

getDelegate

public final IFileSystem getDelegate()

Get the delegate implementation.

Returns:

IFileSystem delegate that manages platform specific functions..

setDelegate

public final void setDelegate(IFileSystem delegate)

Set the delegate implementation.

Parameters:

delegate - The delegate implementing platform specific functions.

createFileDescriptor

public FileDescriptor createFileDescriptor(FileDescriptor parent,
                                           java.lang.String name)

Creates a new reference to a new or existing location in the filesystem. This method does not create the actual file in the specified folder.

Specified by:

createFileDescriptor in interface IFileSystem

Parameters:

parent - Parent directory.

name - Name of new file or directory.

Returns:

A reference to a new or existing location in the filesystem.

Since:

v2.0

getApplicationCacheFolder

public FileDescriptor getApplicationCacheFolder()

Returns a reference to the cache folder for the current application. This path must always be writable by the current application. This path is volatile and may be cleaned by the OS periodically.

Specified by:

getApplicationCacheFolder in interface IFileSystem

Returns:

Path to the application's cache folder.

Since:

v2.0

getApplicationCloudFolder

public FileDescriptor getApplicationCloudFolder()

Returns a reference to the cloud synchronizable folder for the current application. This path must always be writable by the current application.

Specified by:

getApplicationCloudFolder in interface IFileSystem

Returns:

Path to the application's cloud storage folder.

Since:

v2.0

getApplicationDocumentsFolder

public FileDescriptor getApplicationDocumentsFolder()

Returns a reference to the documents folder for the current application. This path must always be writable by the current application.

Specified by:

getApplicationDocumentsFolder in interface IFileSystem

Returns:

Path to the application's documents folder.

Since:

v2.0

getApplicationFolder

public FileDescriptor getApplicationFolder()

Returns a reference to the application installation folder. This path may or may not be directly readable or writable - it usually contains the app binary and data.

Specified by:

getApplicationFolder in interface IFileSystem

Returns:

Path to the application folder.

Since:

v2.0

getApplicationProtectedFolder

public FileDescriptor getApplicationProtectedFolder()

Returns a reference to the protected storage folder for the current application. This path must always be writable by the current application.

Specified by:

getApplicationProtectedFolder in interface IFileSystem

Returns:

Path to the application's protected storage folder.

Since:

v2.0

getSeparator

public char getSeparator()

Returns the file system dependent file separator.

Specified by:

getSeparator in interface IFileSystem

Returns:

char with the directory/file separator.

Since:

v2.0

getSystemExternalFolder

public FileDescriptor getSystemExternalFolder()

Returns a reference to the external storage folder provided by the OS. This may be an external SSD card or similar. This type of storage is removable and by definition, not secure. This path may or may not be writable by the current application.

Specified by:

getSystemExternalFolder in interface IFileSystem

Returns:

Path to the application's documents folder.

Since:

v2.0

invoke

public APIResponse invoke(APIRequest request)

Invokes the given method specified in the API request object.

Specified by:

invoke in interface APIBridge

Overrides:

invoke in class BaseDataBridge

Parameters:

request - APIRequest object containing method name and parameters.

Returns:

APIResponse with status code, message and JSON response or a JSON null string for void functions. Status code 200 is OK, all others are HTTP standard error conditions.