me.adaptive.arp.api

Class FileBridge

java.lang.Object

me.adaptive.arp.api.BaseDataBridge

me.adaptive.arp.api.FileBridge

All Implemented Interfaces:

APIBridge, IAdaptiveRP, IBaseData, IFile

public class FileBridge
extends BaseDataBridge
implements IFile, APIBridge

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

Field Summary

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

apiGroup

Constructor Summary

Constructors

Constructor and Description
FileBridge(IFile delegate) Constructor with delegate.

Method Summary

Modifier and Type	Method and Description
boolean	canRead(FileDescriptor descriptor) Determine whether the current file/folder can be read from.
boolean	canWrite(FileDescriptor descriptor) Determine whether the current file/folder can be written to.
void	create(FileDescriptor descriptor, IFileResultCallback callback) Creates a file with the specified name.
boolean	delete(FileDescriptor descriptor, boolean cascade) Deletes the given file or path.
boolean	exists(FileDescriptor descriptor) Check whether the file/path exists.
void	getContent(FileDescriptor descriptor, IFileDataLoadResultCallback callback) Loads the content of the file.
IFile	getDelegate() Get the delegate implementation.
IFileSystemStorageType	getFileStorageType(FileDescriptor descriptor) Returns the file storage type of the file
IFileSystemType	getFileType(FileDescriptor descriptor) Returns the file type
IFileSystemSecurity	getSecurityType(FileDescriptor descriptor) Returns the security type of the file
APIResponse	invoke(APIRequest request) Invokes the given method specified in the API request object.
boolean	isDirectory(FileDescriptor descriptor) Check whether this is a path of a file.
void	listFiles(FileDescriptor descriptor, IFileListResultCallback callback) List all the files contained within this file/path reference.
void	listFilesForRegex(FileDescriptor descriptor, java.lang.String regex, IFileListResultCallback callback) List all the files matching the speficied regex filter within this file/path reference.
boolean	mkDir(FileDescriptor descriptor, boolean recursive) Creates the parent path (or paths, if recursive) to the given file/path if it doesn't already exist.
void	move(FileDescriptor source, FileDescriptor destination, boolean createPath, boolean overwrite, IFileResultCallback callback) Moves the current file to the given file destination, optionally overwriting and creating the path to the new destination file.
void	setContent(FileDescriptor descriptor, byte[] content, IFileDataStoreResultCallback callback) Sets the content of the file.
void	setDelegate(IFile 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

FileBridge

public FileBridge(IFile delegate)

Constructor with delegate.

Parameters:

delegate - The delegate implementing platform specific functions.

Method Detail

getDelegate

public final IFile getDelegate()

Get the delegate implementation.

Returns:

IFile delegate that manages platform specific functions..

setDelegate

public final void setDelegate(IFile delegate)

Set the delegate implementation.

Parameters:

delegate - The delegate implementing platform specific functions.

canRead

public boolean canRead(FileDescriptor descriptor)

Determine whether the current file/folder can be read from.

Specified by:

canRead in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

True if the folder/file is readable, false otherwise.

Since:

v2.0

canWrite

public boolean canWrite(FileDescriptor descriptor)

Determine whether the current file/folder can be written to.

Specified by:

canWrite in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

True if the folder/file is writable, false otherwise.

Since:

v2.0

create

public void create(FileDescriptor descriptor,
                   IFileResultCallback callback)

Creates a file with the specified name.

Specified by:

create in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

callback - Result of the operation.

Since:

v2.0

delete

public boolean delete(FileDescriptor descriptor,
                      boolean cascade)

Deletes the given file or path. If the file is a directory and contains files and or subdirectories, these will be deleted if the cascade parameter is set to true.

Specified by:

delete in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

cascade - Whether to delete sub-files and sub-folders.

Returns:

True if files (and sub-files and folders) whether deleted.

Since:

v2.0

exists

public boolean exists(FileDescriptor descriptor)

Check whether the file/path exists.

Specified by:

exists in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

True if the file exists in the filesystem, false otherwise.

Since:

v2.0

getContent

public void getContent(FileDescriptor descriptor,
                       IFileDataLoadResultCallback callback)

Loads the content of the file.

Specified by:

getContent in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

callback - Result of the operation.

Since:

v2.0

getFileStorageType

public IFileSystemStorageType getFileStorageType(FileDescriptor descriptor)

Returns the file storage type of the file

Specified by:

getFileStorageType in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

Storage Type file

Since:

v2.0

getFileType

public IFileSystemType getFileType(FileDescriptor descriptor)

Returns the file type

Specified by:

getFileType in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

Returns the file type of the file

Since:

v2.0

getSecurityType

public IFileSystemSecurity getSecurityType(FileDescriptor descriptor)

Returns the security type of the file

Specified by:

getSecurityType in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

Security Level of the file

Since:

v2.0

isDirectory

public boolean isDirectory(FileDescriptor descriptor)

Check whether this is a path of a file.

Specified by:

isDirectory in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

Returns:

true if this is a path to a folder/directory, false if this is a path to a file.

Since:

v2.0

listFiles

public void listFiles(FileDescriptor descriptor,
                      IFileListResultCallback callback)

List all the files contained within this file/path reference. If the reference is a file, it will not yield any results.

Specified by:

listFiles in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

callback - Result of operation.

Since:

v2.0

listFilesForRegex

public void listFilesForRegex(FileDescriptor descriptor,
                              java.lang.String regex,
                              IFileListResultCallback callback)

List all the files matching the speficied regex filter within this file/path reference. If the reference is a file, it will not yield any results.

Specified by:

listFilesForRegex in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

regex - Filter (eg. *.jpg, *.png, Fil*) name string.

callback - Result of operation.

Since:

v2.0

mkDir

public boolean mkDir(FileDescriptor descriptor,
                     boolean recursive)

Creates the parent path (or paths, if recursive) to the given file/path if it doesn't already exist.

Specified by:

mkDir in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

recursive - Whether to create all parent path elements.

Returns:

True if the path was created, false otherwise (or it exists already).

Since:

v2.0

move

public void move(FileDescriptor source,
                 FileDescriptor destination,
                 boolean createPath,
                 boolean overwrite,
                 IFileResultCallback callback)

Moves the current file to the given file destination, optionally overwriting and creating the path to the new destination file.

Specified by:

move in interface IFile

Parameters:

source - File descriptor of file or folder used for operation as source.

destination - File descriptor of file or folder used for operation as destination.

createPath - True to create the path if it does not already exist.

callback - Result of the operation.

overwrite - True to create the path if it does not already exist.

Since:

v2.0

setContent

public void setContent(FileDescriptor descriptor,
                       byte[] content,
                       IFileDataStoreResultCallback callback)

Sets the content of the file.

Specified by:

setContent in interface IFile

Parameters:

descriptor - File descriptor of file or folder used for operation.

content - Binary content to store in the file.

callback - Result of the operation.

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.