com.qoppa.spi

Interface ContentProvider

public interface ContentProvider

Interface for accessing a file store through the REST API module.

Method Summary

Modifier and Type	Method and Description
boolean	createFolder(String folderPath, com.qoppa.spi.Session session) Create a new folder a the specified path.
boolean	deleteFile(String path, com.qoppa.spi.Session session) Deletes the file at the specified path.
boolean	deleteFolder(String folderPath, boolean recursive, com.qoppa.spi.Session session) Deletes the folder at the specified path.
boolean	exists(String path, com.qoppa.spi.Session session) Returns true if a file or folder exists at the specified path.
List<String>	getChildren(String folderPath, com.qoppa.spi.Session session) Gets a list of the names of the files and directories in the specified folder.
long	getFileSize(String path, com.qoppa.spi.Session session) Gets the size in bytes of file at the specified path.
InputStream	getInputStream(String path, com.qoppa.spi.Session session) Gets the input stream of the file at the specified path.
String	getProviderName() Gets the human readable name of the provider.
void	upload(InputStream in, long length, String path, com.qoppa.spi.Session session) Uploads the file to the specified path.
boolean	validateConfiguration() Validates the provider configuration.

Method Detail

getProviderName

String getProviderName()

Gets the human readable name of the provider.

Returns:

The human readable name of the provider

createFolder

boolean createFolder(String folderPath,
                     com.qoppa.spi.Session session)

Create a new folder a the specified path. This should also create any parent directories that don't yet exist.

Parameters:

folderPath - The path to the new folder. It is relative to the base directory.

session - The existing Session object.

Returns:

True if the folder was create successfully or false if there was a problem creating the new folder or any of its ancestors.

exists

boolean exists(String path,
               com.qoppa.spi.Session session)

Returns true if a file or folder exists at the specified path.

Parameters:

path - The path to the file or folder relative to the base directory.

session - The existing Session object.

Returns:

True if the file or folder exists, false if it doesn't exist.

getFileSize

long getFileSize(String path,
                 com.qoppa.spi.Session session)

Gets the size in bytes of file at the specified path.

Parameters:

path - The path of the file relative to the base directory.

session - The existing Session object.

Returns:

The size in bytes of the file at the specified path.

getInputStream

InputStream getInputStream(String path,
                           com.qoppa.spi.Session session)
                    throws IOException

Gets the input stream of the file at the specified path.

Parameters:

path - The path of the file relative to the base directory.

session - The existing Session object.

Returns:

The input stream of the file at the specified path.

Throws:

IOException

upload

void upload(InputStream in,
            long length,
            String path,
            com.qoppa.spi.Session session)
     throws IOException

Uploads the file to the specified path.

Parameters:

in - The file's input stream.

length - The length of the input stream. May be -1 if unknown.

path - The path of the file relative to the base directory.

session - The existing Session object.

Throws:

IOException

deleteFile

boolean deleteFile(String path,
                   com.qoppa.spi.Session session)

Deletes the file at the specified path.

Parameters:

path - The path of the file relative to the base directory.

session - The existing Session object.

Returns:

True if the file was successfully deleted or false if there was a problem deleting the file.

deleteFolder

boolean deleteFolder(String folderPath,
                     boolean recursive,
                     com.qoppa.spi.Session session)

Deletes the folder at the specified path. If recursive is set to false, the folder should only be deleted if it is empty.

Parameters:

folderPath - The path of the folder relative to the base directory.

recursive - Set to true if all sub-folders should be deleted.

session - The existing Session object.

Returns:

True if the folder is deleted or false if there was a problem deleting the folder.

getChildren

List<String> getChildren(String folderPath,
                         com.qoppa.spi.Session session)

Gets a list of the names of the files and directories in the specified folder.

Parameters:

folderPath - The path of the folder relative to the base directory.

session - The existing Session object.

Returns:

a list of the names of the files and directories in the specified folder.

validateConfiguration

boolean validateConfiguration()

Validates the provider configuration.

Returns:

true if the provider configuration is valid.