Package org.opencms.repository

Package contains all classes and interfaces needed to create or use a repository to access the resources in the VFS.

A repository is an set of interfaces (and their implementations) to create a simple access to the resources in the VFS of OpenCms. The repositories are configured in the opencms-importexport.xml. The CmsObjectWrapper is used by the repositories for the access to the VFS. So it is possible to configure the repositories to use one or more implementations of the I_CmsResourceWrapper to change the view to the resources in the VFS. Additionaly it is possible to define filters to include or exclude files and folders form being displayed.

Use the CmsRepositoryManager to get a configured I_CmsRepository. There you get a I_CmsRepositorySession through login in. With that session you will get the basic file and folder operations to the resources in the VFS of OpenCms.

Example:
I_CmsRepository repository = OpenCms.getRepositoryManager().getRepository(repository_name);
I_CmsRepositorySession session = repository.login(username, password);

Since:

6.2.4

See Also:

I_CmsRepository, I_CmsRepositorySession

Interface Summary

Interface	Description
I_CmsRepository	Represents a repository.
I_CmsRepositoryItem	This class represents items in the repository interface.
I_CmsRepositorySession	A repository session which provides basic file and folder operations to the resources in the VFS of OpenCms.

Class Summary

Class	Description
A_CmsRepository	Abstract implementation of the repository interface I_CmsRepository.
A_CmsRepositorySession	Abstract implementation of the interface I_CmsRepositorySession to provide the functionality of filtering items.
CmsPropertyName
CmsRepository	Creates a repository session to access OpenCms.
CmsRepositoryFilter	This class is a filter for the repositories.
CmsRepositoryItem	Represents a single entry in the repository.
CmsRepositoryLockInfo	The class represents a lock to a I_CmsRepositoryItem.
CmsRepositoryManager	The RepositoryManager keeps a list with all configured I_CmsRepository and can be used to get a repository by its name.
CmsRepositorySession	This is the session class to work with the CmsRepository.
Messages	Convenience class to access the localized messages of this OpenCms package.