org.openl.rules.repository.file

Class FileRepository

java.lang.Object

org.openl.rules.repository.file.FileRepository

All Implemented Interfaces:

Closeable, AutoCloseable, Repository, RRepositoryFactory

public class FileRepository
extends Object
implements Repository, RRepositoryFactory, Closeable

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

Author:

Yury Molchan

Constructor Summary

Constructors

Constructor and Description
FileRepository()

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.
void	close()
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.
File	getRoot()
void	initialize() Initialize factory.
protected void	invokeListener()
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.
void	setRoot(File root)
void	setUri(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRepository

public FileRepository()

Method Detail

setRoot

public void setRoot(File root)

setUri

public void setUri(String path)

initialize

public void initialize()
                throws RRepositoryException

Description copied from interface: RRepositoryFactory

Initialize factory.

Specified by:

initialize in interface RRepositoryFactory

Throws:

RRepositoryException

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.

delete

public boolean delete(FileData data)

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 or cannot be deleted.

copy

public FileData copy(String srcName,
                     FileData destData)
              throws IOException

Description copied from interface: Repository

Copy a file to the destination file.

Specified by:

copy in interface Repository

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

public FileData rename(String srcName,
                       FileData destData)
                throws IOException

Description copied from interface: Repository

Rename or move a file.

Specified by:

rename in interface Repository

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

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)
                           throws IOException

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.

Throws:

IOException - if not possible to read the directory.

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(String name,
                             String version)

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:

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:

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 it will work like Repository.copy(String, FileData) method.

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

See Also:

Repository.copy(String, FileData)

getRoot

public File getRoot()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

invokeListener

protected void invokeListener()