org.openl.rules.repository.api

Interface Repository

All Known Subinterfaces:

RRepositoryFactory

All Known Implementing Classes:

DatasourceDBRepositoryFactory, DBRepository, FileRepository, JdbcDBRepositoryFactory

public interface Repository

The interface of the repository abstraction. It contains a minimal set of methods to be compatible with various of internet storages like Amazon S3, Google Cloud Storage or Azure Storage. And to be simple to implement own storage based on a Database or a File System. This repository doesn't assume that it should support transactions, sessions or concurrent access. This repository must support only the atomicity of file modification, so the file always contains valid data. All path names in the repository MUST BE relative and satisfy to the following rules:

1. Only '/' symbol MUST be used to separate folders
2. The first symbol of the path MUST NOT be started from '/'
3. The path to the folder MUST be ended with '/'
4. The path to the file MUST NOT be ended with '/'
5. The path to the root folder is the empty path

Examples:

• '' - the root folder
• 'file_name' - file
• 'folder_name/' - folder
• 'folder_name/inner_file' - file
• 'folder_name/inner_folder/' - folder

Author:

Yury Molchan

Method Summary

Modifier and Type	Method and Description
FileData	check(String name) Read a file descriptor by the given path name.
FileData	checkHistory(String name, String version) Read a file descriptor by the given path name of the given version.
FileData	copy(String srcName, FileData destData) Copy a file to the destination file.
FileData	copyHistory(String srcName, FileData destData, String version) Copy a file of the given version to the destination file.
boolean	delete(FileData data) Delete a file or mark it as deleted.
boolean	deleteHistory(String name, String version) Delete a file from the history.
List<FileData>	list(String path) Return a list of files recursively in the given folder.
List<FileData>	listHistory(String name) List a versions of the given file.
FileItem	read(String name) Read a file by the given path name.
FileItem	readHistory(String name, String version) Read a file by the given path name of the given version.
FileData	rename(String srcName, FileData destData) Rename or move a file.
FileData	save(FileData data, InputStream stream) Save a file.
void	setListener(Listener callback) Set a listener to monitor changes in the repository.

Method Detail

list

List<FileData> list(String path)
             throws IOException

Return a list of files recursively in the given folder.

Parameters:

path - the folder to scan. The path must be ended by '/' or be empty.

Returns:

the list of the file descriptors. Invalid files are ignored.

Throws:

IOException - if not possible to read the directory.

check

FileData check(String name)
        throws IOException

Read a file descriptor by the given path name.

Parameters:

name - the path name of the file to read.

Returns:

the file descriptor or null if the file is absent.

Throws:

IOException - if not possible to read the file descriptor.

read

FileItem read(String name)
       throws IOException

Read a file by the given path name.

Parameters:

name - the path name of the file to read.

Returns:

the file descriptor or null if the file is absent.

Throws:

IOException - if not possible to read the file.

save

FileData save(FileData data,
              InputStream stream)
       throws IOException

Save a file.

Parameters:

data - the file descriptor.

stream - the stream to save with the specified file descriptor.

Returns:

the resulted file descriptor after successful writing.

Throws:

IOException - if not possible to save the file.

delete

boolean delete(FileData data)

Delete a file or mark it as deleted.

Parameters:

data - the file descriptor to delete.

Returns:

true if file has been deleted successfully or false if the file is absent or cannot be deleted.

copy

FileData copy(String srcName,
              FileData destData)
       throws IOException

Copy a file to the destination file.

Parameters:

srcName - the file to copy.

destData - the destination file descriptor.

Returns:

the file descriptor of the resulted file.

Throws:

IOException - if not possible to copy the file

rename

FileData rename(String srcName,
                FileData destData)
         throws IOException

Rename or move a file.

Parameters:

srcName - the file to rename.

destData - the destination file descriptor.

Returns:

the file descriptor of the resulted file.

Throws:

IOException - if not possible to rename the file

setListener

void setListener(Listener callback)

Set a listener to monitor changes in the repository.

Parameters:

callback - the listener.

listHistory

List<FileData> listHistory(String name)
                    throws IOException

List a versions of the given file. If the repository does not support file versions, then it will return one record of the given file. The order of the file descriptions is undefined, but the first element is the actual file which can be access by read(String) method.

Parameters:

name - the file name.

Returns:

the list of file descriptions.

Throws:

IOException - if not possible to read the directory.

checkHistory

FileData checkHistory(String name,
                      String version)
               throws IOException

Read a file descriptor by the given path name of the given version. If the version is null, then it will work like check(String) method.

Parameters:

name - the path name of the file to read.

version - the version of the file to read, can be null.

Returns:

the file descriptor or null if the file is absent.

Throws:

IOException - if not possible to read the file descriptor.

See Also:

read(String)

readHistory

FileItem readHistory(String name,
                     String version)
              throws IOException

Read a file by the given path name of the given version. If the version is null, then it will work like read(String) method.

Parameters:

name - the path name of the file to read.

version - the version of the file to read, can be null.

Returns:

the file descriptor or null if the file is absent.

Throws:

IOException - if not possible to read the file.

See Also:

read(String)

deleteHistory

boolean deleteHistory(String name,
                      String version)

Delete a file from the history. If the version is null, then it will delete all versions of the file from the history.

Parameters:

name - the file to delete.

version - the version of the file to delete, can be null.

Returns:

true if file has been deleted successfully or false if the file is absent or cannot be deleted.

See Also:

delete(FileData)

copyHistory

FileData copyHistory(String srcName,
                     FileData destData,
                     String version)
              throws IOException

Copy a file of the given version to the destination file. If the version is null, then it will work like copy(String, FileData) method.

Parameters:

srcName - the file to copy.

destData - the destination file descriptor.

version - the version of the file to copy

Returns:

the file descriptor of the resulted file.

Throws:

IOException - if not possible to copy the file

See Also:

copy(String, FileData)