Package org.openl.rules.repository.file

Class FileSystemRepository

java.lang.Object

org.openl.rules.repository.file.FileSystemRepository

All Implemented Interfaces:

Closeable, AutoCloseable, FolderRepository, Repository

Direct Known Subclasses:

LocalRepository

public class FileSystemRepository
extends Object
implements FolderRepository, Closeable

A simple implementation of a file-system-based repository. This repository does not support versioning.

Author:

Yury Molchan

Constructor Summary

Constructors

Constructor	Description
FileSystemRepository()

Method Summary

Modifier and Type	Method	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.
void	close()
FileData	copyHistory(String srcName, FileData destData, String version)	Copy a file of the given version to the destination file.
boolean	delete(List<FileData> data)	Delete multiple files or mark it as deleted in one transaction.
boolean	delete(FileData data)	Delete a file or mark it as deleted.
boolean	deleteHistory(FileData data)	Delete a file from the history.
protected FileData	getFileData(File file)
String	getId()	Get unique identifier for Repository.
String	getName()	Get repository name shown on UI.
File	getRoot()
protected String	getVersion(File file)
void	initialize()
protected void	invokeListener()
protected boolean	isSkip(File file)
List<FileData>	list(String path)	Return a list of files recursively in the given folder.
List<FileData>	listFiles(String path, String version)	Return a list of files recursively in the given folder and given version.
List<FileData>	listFolders(String path)	Return a list of folders in the given path (not recursively).
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.
List<FileData>	save(List<FileItem> fileItems)	Save multiple projects in one transaction.
FileData	save(FileData data, InputStream stream)	Save a file.
FileData	save(FileData folderData, Iterable<FileItem> files, ChangesetType changesetType)	Save the folder.
void	setId(String id)
void	setListener(Listener callback)	Set a listener to monitor changes in the repository.
void	setListenerTimerPeriod(int listenerTimerPeriod)
void	setName(String name)
void	setRoot(File root)
void	setUri(String path)
Features	supports()	Get the features supported by the repository.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openl.rules.repository.api.Repository

validateConnection

Constructor Detail

FileSystemRepository

public FileSystemRepository()

Method Detail

setRoot

public void setRoot(File root)

setUri

public void setUri(String path)

initialize

public void initialize()

setId

public void setId(String id)

getId

public String getId()

Description copied from interface: Repository

Get unique identifier for Repository. Used to distinguish one repository from another. Must be unique.

Specified by:

getId in interface Repository

Returns:

repository id.

setName

public void setName(String name)

getName

public String getName()

Description copied from interface: Repository

Get repository name shown on UI.

Specified by:

getName in interface Repository

Returns:

repository name

list

public List<FileData> list(String path)
                    throws IOException

Description copied from interface: Repository

Return a list of files recursively in the given folder.

Specified by:

list in interface Repository

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

public FileData check(String name)
               throws IOException

Description copied from interface: Repository

Read a file descriptor by the given path name.

Specified by:

check in interface Repository

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

public FileItem read(String name)
              throws IOException

Description copied from interface: Repository

Read a file by the given path name.

Specified by:

read in interface Repository

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

public FileData save(FileData data,
                     InputStream stream)
              throws IOException

Description copied from interface: Repository

Save a file.

Specified by:

save in interface Repository

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.

save

public List<FileData> save(List<FileItem> fileItems)
                    throws IOException

Description copied from interface: Repository

Save multiple projects in one transaction. Used only in deployment services

Specified by:

save in interface Repository

Parameters:

fileItems - list of file descriptor and stream pairs

Throws:

IOException - if not possible to save the file.

delete

public boolean delete(FileData data)
               throws IOException

Description copied from interface: Repository

Delete a file or mark it as deleted.

Specified by:

delete in interface Repository

Parameters:

data - the file descriptor to delete.

Returns:

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

Throws:

IOException - if not possible to delete the file.

delete

public boolean delete(List<FileData> data)
               throws IOException

Description copied from interface: Repository

Delete multiple files or mark it as deleted in one transaction.

Specified by:

delete in interface Repository

Parameters:

data - list of files to delete

Returns:

true if at least one file is deleted

Throws:

IOException - if not possible to delete the file

setListener

public void setListener(Listener callback)

Description copied from interface: Repository

Set a listener to monitor changes in the repository.

Specified by:

setListener in interface Repository

Parameters:

callback - the listener.

listHistory

public List<FileData> listHistory(String name)

Description copied from interface: Repository

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 Repository.read(String) method.

Specified by:

listHistory in interface Repository

Parameters:

name - the file name.

Returns:

the list of file descriptions.

checkHistory

public FileData checkHistory(String name,
                             String version)
                      throws IOException

Description copied from interface: Repository

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

Specified by:

checkHistory in interface Repository

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:

Repository.read(String)

readHistory

public FileItem readHistory(String name,
                            String version)
                     throws IOException

Description copied from interface: Repository

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

Specified by:

readHistory in interface Repository

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:

Repository.read(String)

deleteHistory

public boolean deleteHistory(FileData data)
                      throws IOException

Description copied from interface: Repository

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

Specified by:

deleteHistory in interface Repository

Parameters:

data - the file descriptor to delete. The fields "name", "version", "author" and "comment" must be initialized.

Returns:

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

Throws:

IOException - if not possible to delete the file.

See Also:

Repository.delete(FileData)

copyHistory

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

Description copied from interface: Repository

Copy a file of the given version to the destination file. If the version is null, then copy latest version.

Specified by:

copyHistory in interface Repository

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

supports

public Features supports()

Description copied from interface: Repository

Get the features supported by the repository. If specific feature is supported, repository instance can be casted to interface class that support that feature.

Specified by:

supports in interface Repository

Returns:

Supported features

getFileData

protected FileData getFileData(File file)
                        throws IOException

Throws:

IOException

getRoot

public File getRoot()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Repository

invokeListener

protected void invokeListener()

listFolders

public List<FileData> listFolders(String path)

Description copied from interface: FolderRepository

Return a list of folders in the given path (not recursively).

Specified by:

listFolders in interface FolderRepository

Parameters:

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

Returns:

the list of the folder descriptors. Invalid folders are ignored.

getVersion

protected String getVersion(File file)

listFiles

public List<FileData> listFiles(String path,
                                String version)
                         throws IOException

Description copied from interface: FolderRepository

Return a list of files recursively in the given folder and given version.

Specified by:

listFiles in interface FolderRepository

Parameters:

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

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

Returns:

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

Throws:

IOException - if not possible to read the directory.

save

public FileData save(FileData folderData,
                     Iterable<FileItem> files,
                     ChangesetType changesetType)
              throws IOException

Description copied from interface: FolderRepository

Save the folder.

Specified by:

save in interface FolderRepository

Parameters:

folderData - folder descriptor

files - all files inside the folder recursively or only changed (modified, added, deleted) files depending on changesetType

changesetType - if ChangesetType.DIFF, only changed files. If ChangesetType.FULL all files that exist in project

Returns:

the resulted folder descriptor after successful writing.

Throws:

IOException - if not possible to save the folder.

isSkip

protected boolean isSkip(File file)

setListenerTimerPeriod

public void setListenerTimerPeriod(int listenerTimerPeriod)