Package org.eclipse.dirigible.repository.api

Interface IRepositoryWriter

All Known Subinterfaces:

IRepository

public interface IRepositoryWriter

This interface represents a Repository. It allows for querying, modifying and navigating through collections and resources.

Method Summary

Modifier and Type	Method	Description
ICollection	createCollection(String path)	This method creates a new empty collection at the specified path.
IResource	createResource(String path)	This method creates a new empty resource at the specified path.
IResource	createResource(String path, byte[] content)	This method creates a new resource at the specified path and fills it with the specified content.
IResource	createResource(String path, byte[] content, boolean isBinary, String contentType)	This method creates a new empty resource at the specified path.
IResource	createResource(String path, byte[] content, boolean isBinary, String contentType, boolean override)	This method creates a new empty, or override resource at the specified path.
void	deleteLinkedPath(String repositoryPath)	Delete link together with external folder or file.
void	dispose()	Disposes of this repository.
boolean	isLinkedPath(String repositoryPath)	Check if Link exists between folder or file and an internal Repository artifact.
boolean	isLinkingPathsSupported()	Whether the Repository supports linking of external paths.
void	linkPath(String repositoryPath, String filePath)	Link external folder or file as an internal Repository artifact.
void	removeCollection(String path)	This method removes the collection with the specified path from the repository.
void	removeResource(String path)	This method removes the resource at the specified path from the repository.

Method Details

createCollection

ICollection createCollection(String path) throws RepositoryWriteException

This method creates a new empty collection at the specified path.

The returned value is an instance of ICollection which represents the newly created collection.

Parameters:

path - ICollection location

Returns:

an ICollection instance

Throws:

RepositoryWriteException - in case the ICollection cannot be created

removeCollection

void removeCollection(String path) throws RepositoryWriteException

This method removes the collection with the specified path from the repository.

Parameters:

path - the ICollection location

Throws:

RepositoryWriteException - in case the ICollection cannot be removed

createResource

IResource createResource(String path) throws RepositoryWriteException

This method creates a new empty resource at the specified path.

The returned value is an instance of IResource that represents the newly created resource.

Parameters:

path - the IResource location

Returns:

an IResource instance

Throws:

RepositoryWriteException - in case IResource cannot be created

createResource

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

This method creates a new resource at the specified path and fills it with the specified content.

The returned value is an instance of IResource that represents the newly created resource.

Parameters:

path - the IResource location

content - the raw content

Returns:

an IResource instance

Throws:

RepositoryWriteException - in case IResource cannot be created

createResource

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

This method creates a new empty resource at the specified path.

The returned value is an instance of IResource that represents the newly created resource.

Parameters:

path - the IResource location

content - the raw content

isBinary - whether it is binary

contentType - the type of the content

Returns:

an IResource instance

Throws:

RepositoryWriteException - in case the IResource cannot be created

createResource

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

This method creates a new empty, or override resource at the specified path.

The returned value is an instance of IResource that represents the newly created resource.

Parameters:

path - the IResource location

content - the raw content

isBinary - whether it is binary

contentType - the type of the content

override - whether to override existing

Returns:

an IResource instance

Throws:

RepositoryWriteException - in case the IResource cannot be created

removeResource

void removeResource(String path) throws RepositoryWriteException

This method removes the resource at the specified path from the repository.

Parameters:

path - the IResource location

Throws:

RepositoryWriteException - in case the IResource cannot be removed

dispose

void dispose()

Disposes of this repository.

Calling this method allows for the repository to release all allocated resources.

Calling this method more than once will be a no-op.

isLinkingPathsSupported

boolean isLinkingPathsSupported()

Whether the Repository supports linking of external paths.

Returns:

true, if is linking paths supported

linkPath

void linkPath(String repositoryPath, String filePath) throws IOException

Link external folder or file as an internal Repository artifact.

Parameters:

repositoryPath - the relative path

filePath - the target folder or file

Throws:

IOException - in case of exception

deleteLinkedPath

void deleteLinkedPath(String repositoryPath) throws IOException

Delete link together with external folder or file.

Parameters:

repositoryPath - the relative path

Throws:

IOException - in case of exception

isLinkedPath

boolean isLinkedPath(String repositoryPath)

Check if Link exists between folder or file and an internal Repository artifact.

Parameters:

repositoryPath - the relative path

Returns:

true if link exists