Package org.eclipse.dirigible.repository.fs

Class FileSystemRepository

java.lang.Object

org.eclipse.dirigible.repository.fs.FileSystemRepository

All Implemented Interfaces:

IRepository, IRepositoryExporter, IRepositoryImporter, IRepositoryReader, IRepositorySearch, IRepositoryWriter

Direct Known Subclasses:

LocalRepository

public abstract class FileSystemRepository
extends Object
implements IRepository

The File System based implementation of IRepository.

Field Summary

Fields inherited from interface org.eclipse.dirigible.repository.api.IRepository

DIRIGIBLE_REPOSITORY_CACHE_ENABLED, DIRIGIBLE_REPOSITORY_CACHE_SIZE_LIMIT_IN_MEGABYTES, DIRIGIBLE_REPOSITORY_CACHE_TIME_LIMIT_IN_MINUTES, DIRIGIBLE_REPOSITORY_PROVIDER, DIRIGIBLE_REPOSITORY_PROVIDER_DATABASE, DIRIGIBLE_REPOSITORY_PROVIDER_LOCAL, SEPARATOR, UTF8

Constructor Summary

Constructors

Constructor	Description
FileSystemRepository()	Constructor with default root folder - user.dir and without database initialization
FileSystemRepository(String rootFolder)	Constructor with root folder parameter.
FileSystemRepository(String rootFolder, boolean absolute)	Constructor with root folder parameter.

Method Summary

Modifier and Type	Method	Description
ICollection	createCollection(String path)	Creates the collection.
protected void	createRepository(String rootFolder, boolean absolute)	Creates the repository.
IResource	createResource(String path)	Creates the resource.
IResource	createResource(String path, byte[] content)	Creates the resource.
IResource	createResource(String path, byte[] content, boolean isBinary, String contentType)	Creates the resource.
IResource	createResource(String path, byte[] content, boolean isBinary, String contentType, boolean override)	Creates the resource.
void	deleteLinkedPath(String repositoryPath)	Delete linked path.
void	dispose()	Dispose.
byte[]	exportZip(String relativeRoot, boolean inclusive)	Export zip.
byte[]	exportZip(List<String> relativeRoots)	Export zip.
List<String>	find(String path, String pattern)	Find.
List<String>	getAllResourcePaths()	Gets the all resource paths.
ICollection	getCollection(String path)	Gets the collection.
String	getInternalResourcePath(String resourcePath)	Gets the internal resource path.
String	getParameter(String key)	Gets the parameter.
LocalRepositoryDao	getRepositoryDao()	Gets the repository dao.
String	getRepositoryPath()	Gets the repository path.
protected String	getRepositoryRootFolder()	Gets the repository root folder.
IResource	getResource(String path)	Gets the resource.
ICollection	getRoot()	Gets the root.
boolean	hasCollection(String path)	Checks for collection.
boolean	hasResource(String path)	Checks for resource.
void	importZip(byte[] data, String path)	Import zip.
void	importZip(byte[] data, String path, boolean override)	Import zip.
void	importZip(byte[] data, String relativeRoot, boolean override, boolean excludeRootFolderName, Map<String,String> filter)	Import zip.
void	importZip(ZipInputStream zipInputStream, String path)	Import zip.
void	importZip(ZipInputStream zipInputStream, String path, boolean override)	Import zip.
void	importZip(ZipInputStream zipInputStream, String relativeRoot, boolean override, boolean excludeRootFolderName)	Import zip.
boolean	isLinkedPath(String repositoryPath)	Checks if is linked path.
boolean	isLinkingPathsSupported()	Checks if is linking paths supported.
void	linkPath(String repositoryPath, String filePath)	Link path.
void	removeCollection(String path)	Removes the collection.
void	removeResource(String path)	Removes the resource.
List<IEntity>	searchName(String parameter, boolean caseInsensitive)	Search name.
List<IEntity>	searchName(String root, String parameter, boolean caseInsensitive)	Search name.
List<IEntity>	searchPath(String parameter, boolean caseInsensitive)	Search path.
void	searchRefresh()	Search refresh.
List<IEntity>	searchText(String parameter)	Search text.
protected void	setParameter(String key, String value)	Sets the parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.dirigible.repository.api.IRepository

getLastModified

Methods inherited from interface org.eclipse.dirigible.repository.api.IRepositoryReader

initialize

Constructor Details

FileSystemRepository

public FileSystemRepository() throws LocalRepositoryException

Constructor with default root folder - user.dir and without database initialization

Throws:

LocalRepositoryException - in case the repository cannot be created

FileSystemRepository

public FileSystemRepository(String rootFolder) throws LocalRepositoryException

Constructor with root folder parameter.

Parameters:

rootFolder - the root folder

Throws:

LocalRepositoryException - in case the repository cannot be created

FileSystemRepository

public FileSystemRepository(String rootFolder, boolean absolute) throws LocalRepositoryException

Constructor with root folder parameter.

Parameters:

rootFolder - the root folder

absolute - whether the root folder is absolute

Throws:

LocalRepositoryException - in case the repository cannot be created

Method Details

createRepository

protected void createRepository(String rootFolder, boolean absolute)

Creates the repository.

Parameters:

rootFolder - the root folder

absolute - the absolute

getRepositoryPath

public String getRepositoryPath()

Gets the repository path.

Specified by:

getRepositoryPath in interface IRepository

Returns:

the repository path

getRepositoryRootFolder

protected String getRepositoryRootFolder()

Gets the repository root folder.

Returns:

the repository root folder

getRoot

public ICollection getRoot()

Gets the root.

Specified by:

getRoot in interface IRepositoryReader

Returns:

the root

createCollection

public ICollection createCollection(String path) throws RepositoryWriteException

Creates the collection.

Specified by:

createCollection in interface IRepositoryWriter

Parameters:

path - the path

Returns:

the i collection

Throws:

RepositoryWriteException - the repository write exception

getCollection

public ICollection getCollection(String path)

Gets the collection.

Specified by:

getCollection in interface IRepositoryReader

Parameters:

path - the path

Returns:

the collection

removeCollection

public void removeCollection(String path) throws RepositoryWriteException

Removes the collection.

Specified by:

removeCollection in interface IRepositoryWriter

Parameters:

path - the path

Throws:

RepositoryWriteException - the repository write exception

hasCollection

public boolean hasCollection(String path) throws RepositoryReadException

Checks for collection.

Specified by:

hasCollection in interface IRepositoryReader

Parameters:

path - the path

Returns:

true, if successful

Throws:

RepositoryReadException - the repository read exception

createResource

public IResource createResource(String path) throws RepositoryWriteException

Creates the resource.

Specified by:

createResource in interface IRepositoryWriter

Parameters:

path - the path

Returns:

the i resource

Throws:

RepositoryWriteException - the repository write exception

createResource

public IResource createResource(String path, byte[] content) throws RepositoryWriteException

Creates the resource.

Specified by:

createResource in interface IRepositoryWriter

Parameters:

path - the path

content - the content

Returns:

the i resource

Throws:

RepositoryWriteException - the repository write exception

createResource

public IResource createResource(String path, byte[] content, boolean isBinary, String contentType) throws RepositoryWriteException

Creates the resource.

Specified by:

createResource in interface IRepositoryWriter

Parameters:

path - the path

content - the content

isBinary - the is binary

contentType - the content type

Returns:

the i resource

Throws:

RepositoryWriteException - the repository write exception

createResource

public IResource createResource(String path, byte[] content, boolean isBinary, String contentType, boolean override) throws RepositoryWriteException

Creates the resource.

Specified by:

createResource in interface IRepositoryWriter

Parameters:

path - the path

content - the content

isBinary - the is binary

contentType - the content type

override - the override

Returns:

the i resource

Throws:

RepositoryWriteException - the repository write exception

getResource

public IResource getResource(String path)

Gets the resource.

Specified by:

getResource in interface IRepositoryReader

Parameters:

path - the path

Returns:

the resource

removeResource

public void removeResource(String path) throws RepositoryWriteException

Removes the resource.

Specified by:

removeResource in interface IRepositoryWriter

Parameters:

path - the path

Throws:

RepositoryWriteException - the repository write exception

hasResource

public boolean hasResource(String path) throws RepositoryReadException

Checks for resource.

Specified by:

hasResource in interface IRepositoryReader

Parameters:

path - the path

Returns:

true, if successful

Throws:

RepositoryReadException - the repository read exception

dispose

public void dispose()

Dispose.

Specified by:

dispose in interface IRepositoryWriter

getRepositoryDao

public LocalRepositoryDao getRepositoryDao()

Gets the repository dao.

Returns:

the repository dao

importZip

public void importZip(ZipInputStream zipInputStream, String path) throws RepositoryImportException

Import zip.

Specified by:

importZip in interface IRepositoryImporter

Parameters:

zipInputStream - the zip input stream

path - the path

Throws:

RepositoryImportException - the repository import exception

importZip

public void importZip(ZipInputStream zipInputStream, String path, boolean override) throws RepositoryImportException

Import zip.

Specified by:

importZip in interface IRepositoryImporter

Parameters:

zipInputStream - the zip input stream

path - the path

override - the override

Throws:

RepositoryImportException - the repository import exception

importZip

public void importZip(ZipInputStream zipInputStream, String relativeRoot, boolean override, boolean excludeRootFolderName) throws RepositoryImportException

Import zip.

Specified by:

importZip in interface IRepositoryImporter

Parameters:

zipInputStream - the zip input stream

relativeRoot - the relative root

override - the override

excludeRootFolderName - the exclude root folder name

Throws:

RepositoryImportException - the repository import exception

importZip

public void importZip(byte[] data, String path) throws RepositoryImportException

Import zip.

Specified by:

importZip in interface IRepositoryImporter

Parameters:

data - the data

path - the path

Throws:

RepositoryImportException - the repository import exception

importZip

public void importZip(byte[] data, String path, boolean override) throws RepositoryImportException

Import zip.

Specified by:

importZip in interface IRepositoryImporter

Parameters:

data - the data

path - the path

override - the override

Throws:

RepositoryImportException - the repository import exception

importZip

public void importZip(byte[] data, String relativeRoot, boolean override, boolean excludeRootFolderName, Map<String,String> filter) throws RepositoryImportException

Import zip.

Specified by:

importZip in interface IRepositoryImporter

Parameters:

data - the data

relativeRoot - the relative root

override - the override

excludeRootFolderName - the exclude root folder name

filter - the filter

Throws:

RepositoryImportException - the repository import exception

exportZip

public byte[] exportZip(List<String> relativeRoots) throws RepositoryExportException

Export zip.

Specified by:

exportZip in interface IRepositoryExporter

Parameters:

relativeRoots - the relative roots

Returns:

the byte[]

Throws:

RepositoryExportException - the repository export exception

exportZip

public byte[] exportZip(String relativeRoot, boolean inclusive) throws RepositoryExportException

Export zip.

Specified by:

exportZip in interface IRepositoryExporter

Parameters:

relativeRoot - the relative root

inclusive - the inclusive

Returns:

the byte[]

Throws:

RepositoryExportException - the repository export exception

searchName

public List<IEntity> searchName(String parameter, boolean caseInsensitive) throws RepositorySearchException

Search name.

Specified by:

searchName in interface IRepositorySearch

Parameters:

parameter - the parameter

caseInsensitive - the case insensitive

Returns:

the list

Throws:

RepositorySearchException - the repository search exception

searchName

public List<IEntity> searchName(String root, String parameter, boolean caseInsensitive) throws RepositorySearchException

Search name.

Specified by:

searchName in interface IRepositorySearch

Parameters:

root - the root

parameter - the parameter

caseInsensitive - the case insensitive

Returns:

the list

Throws:

RepositorySearchException - the repository search exception

searchPath

public List<IEntity> searchPath(String parameter, boolean caseInsensitive) throws RepositorySearchException

Search path.

Specified by:

searchPath in interface IRepositorySearch

Parameters:

parameter - the parameter

caseInsensitive - the case insensitive

Returns:

the list

Throws:

RepositorySearchException - the repository search exception

searchText

public List<IEntity> searchText(String parameter) throws RepositorySearchException

Search text.

Specified by:

searchText in interface IRepositorySearch

Parameters:

parameter - the parameter

Returns:

the list

Throws:

RepositorySearchException - the repository search exception

searchRefresh

public void searchRefresh() throws RepositorySearchException

Search refresh.

Specified by:

searchRefresh in interface IRepositorySearch

Throws:

RepositorySearchException - the repository search exception

getAllResourcePaths

public List<String> getAllResourcePaths() throws RepositoryReadException

Gets the all resource paths.

Specified by:

getAllResourcePaths in interface IRepositoryReader

Returns:

the all resource paths

Throws:

RepositoryReadException - the repository read exception

getParameter

public String getParameter(String key)

Gets the parameter.

Specified by:

getParameter in interface IRepository

Parameters:

key - the key

Returns:

the parameter

setParameter

protected void setParameter(String key, String value)

Sets the parameter.

Parameters:

key - the key

value - the value

isLinkingPathsSupported

public boolean isLinkingPathsSupported()

Checks if is linking paths supported.

Specified by:

isLinkingPathsSupported in interface IRepositoryWriter

Returns:

true, if is linking paths supported

linkPath

public void linkPath(String repositoryPath, String filePath) throws IOException

Link path.

Specified by:

linkPath in interface IRepositoryWriter

Parameters:

repositoryPath - the repository path

filePath - the file path

Throws:

IOException - Signals that an I/O exception has occurred.

deleteLinkedPath

public void deleteLinkedPath(String repositoryPath) throws IOException

Delete linked path.

Specified by:

deleteLinkedPath in interface IRepositoryWriter

Parameters:

repositoryPath - the repository path

Throws:

IOException - Signals that an I/O exception has occurred.

isLinkedPath

public boolean isLinkedPath(String repositoryPath)

Checks if is linked path.

Specified by:

isLinkedPath in interface IRepositoryWriter

Parameters:

repositoryPath - the repository path

Returns:

true, if is linked path

find

public List<String> find(String path, String pattern) throws RepositorySearchException

Find.

Specified by:

find in interface IRepositorySearch

Parameters:

path - the path

pattern - the pattern

Returns:

the list

Throws:

RepositorySearchException - the repository search exception

getInternalResourcePath

public String getInternalResourcePath(String resourcePath)

Gets the internal resource path.

Specified by:

getInternalResourcePath in interface IRepository

Parameters:

resourcePath - the resource path

Returns:

the internal resource path