com.etherios.connector.core.facilities.messaging

Interface IFileSystemImplementation

public interface IFileSystemImplementation

This interface defines all the methods that should be implemented by the different platform connector implementations so that Cloud Connector knows how to perform the file system operations in that platform.

Method Summary

Modifier and Type	Method and Description
void	addDataToFile(java.lang.String path, byte[] data, int offset, boolean truncate) Writes new contents to an existing file.
boolean	createFileFromByteArray(java.lang.String path, byte[] payload) Creates a File from a byte array and returns true if success, false otherwise.
boolean	enoughStorageSizeAvailable(java.lang.String dir, int fileSize) Checks whether there is enough storage space available for the given file size in the given directory.
boolean	fileExists(java.lang.String path) Retrieves whether the given file exists or not.
byte[]	getByteArrayFromFile(java.lang.String path) Returns the byte array associated to the File object.
java.io.InputStream	getFileInputStream(java.lang.String path) Retrieves the File input stream.
long	getFileSize(java.lang.String path) Retrieves the the given file size.
long	getLastModified(java.lang.String path) Retrieves the last modified date of the given file.
java.lang.String	getName(java.lang.String path) Retrieves the given file name.
java.lang.String	getStorageRootDir() Retrieves the directory path where file system storage root point is located.
boolean	isDirectory(java.lang.String path) Retrieves whether the given file is a directory or not.
boolean	isSymbolicLink(java.lang.String path) Retrieves whether the given file is a symbolic link or not.
java.lang.String[]	listFiles(java.lang.String path) Lists the files under the given path.
void	readFile(java.lang.String path, byte[] data, int offset, int length) Reads a portion of the given file.
void	removeFile(java.lang.String path) Removes the given file.

Method Detail

addDataToFile

void addDataToFile(java.lang.String path,
                   byte[] data,
                   int offset,
                   boolean truncate)
            throws java.lang.Exception

Writes new contents to an existing file.

Parameters:

path - Path of the file to add data content to.

data - The data content to add.

offset - The starting offset to start writing data.

truncate - Whether to truncate the file after the new data.

Throws:

java.lang.Exception - if any error occur while adding the given data to the file.

createFileFromByteArray

boolean createFileFromByteArray(java.lang.String path,
                                byte[] payload)
                         throws java.lang.Exception

Creates a File from a byte array and returns true if success, false otherwise.

Parameters:

path - Path of the file to create.

payload - Byte array with the content.

Returns:

true if success, false otherwise

Throws:

java.lang.Exception - if any error occur while creating the new file.

enoughStorageSizeAvailable

boolean enoughStorageSizeAvailable(java.lang.String dir,
                                   int fileSize)

Checks whether there is enough storage space available for the given file size in the given directory.

Parameters:

dir - Directory of the new file to create.

fileSize - Size of the new file to create.

Returns:

true if there is enough storage, false otherwise.

fileExists

boolean fileExists(java.lang.String path)

Retrieves whether the given file exists or not.

Parameters:

path - Path of the file to check.

Returns:

true if file exists, false otherwise.

getByteArrayFromFile

byte[] getByteArrayFromFile(java.lang.String path)
                     throws java.lang.Exception

Returns the byte array associated to the File object.

Parameters:

path - Path of the file to retrieve the byte array.

Returns:

Byte array with the file contents.

Throws:

java.lang.Exception - if any error occur while reading the contents of the file defined by the given path.

getFileInputStream

java.io.InputStream getFileInputStream(java.lang.String path)
                                throws java.lang.Exception

Retrieves the File input stream.

Parameters:

path - Path of the file to retrieve stream from.

Returns:

The file input stream.

Throws:

java.lang.Exception - if any error occur while getting the InputStream of the file defined by the given path.

getFileSize

long getFileSize(java.lang.String path)

Retrieves the the given file size.

Parameters:

path - Path of the file to retrieve its size.

Returns:

File size.

getLastModified

long getLastModified(java.lang.String path)

Retrieves the last modified date of the given file.

Parameters:

path - Path to the file to retrieve last modified date.

Returns:

Last modified date.

getName

java.lang.String getName(java.lang.String path)

Retrieves the given file name.

Parameters:

path - Path to the file to retrieve its name.

Returns:

File name.

getStorageRootDir

java.lang.String getStorageRootDir()

Retrieves the directory path where file system storage root point is located. Used mainly by the File System service.

Returns:

File system storage root directory.

isDirectory

boolean isDirectory(java.lang.String path)

Retrieves whether the given file is a directory or not.

Parameters:

path - Path of the file to check

Returns:

true if file is a directory, false otherwise.

isSymbolicLink

boolean isSymbolicLink(java.lang.String path)

Retrieves whether the given file is a symbolic link or not.

Parameters:

path - Path of the file to check.

Returns:

true if file is a symbolic link, false otherwise.

listFiles

java.lang.String[] listFiles(java.lang.String path)

Lists the files under the given path.

Parameters:

path - Path to list files.

Returns:

List of listed files.

readFile

void readFile(java.lang.String path,
              byte[] data,
              int offset,
              int length)
       throws java.lang.Exception

Reads a portion of the given file.

Parameters:

path - Path of the file to read.

data - Byte array to store the read data.

offset - Starting file offset to read.

length - Amount of bytes to read.

Throws:

java.lang.Exception - if any error occur while reading the file.

removeFile

void removeFile(java.lang.String path)
         throws java.lang.Exception

Removes the given file.

Parameters:

path - Path of the file to remove.

Throws:

java.lang.Exception - if any error occurs when removing the file defined by the given path.