| org.opencms.file.wrapper |
|
This package contains classes and interfaces used to access OpenCms through a wrapped
{@link org.opencms.file.CmsObject}.
Main entry point is the class {@link org.opencms.file.wrapper.CmsObjectWrapper}. The
CmsObjectWrapper is configured with a list of implementations
of {@link org.opencms.file.wrapper.I_CmsResourceWrapper}. So it is possible to show resources in
the VFS different as usual.
For example: If you would like that xml pages always have the correct file extension (.xml) so you
can use the {@link org.opencms.file.wrapper.CmsResourceExtensionWrapperXmlPage}. This implementation
of the interface I_CmsResourceWrapper adds to every resource of type
"xmlpage" the correct file extension ".xml".
This package is mainly used by {@link org.opencms.repository.CmsRepositorySession} to create a
simple configurable access to the resources in OpenCms.
@version $Revision: 1.5 $
@since 6.2.4
@see org.opencms.file.wrapper.CmsObjectWrapper
@see org.opencms.file.wrapper.I_CmsResourceWrapper
|
| Java Source File Name | Type | Comment |
| A_CmsResourceExtensionWrapper.java | Class | |
| A_CmsResourceWrapper.java | Class | |
| CmsObjectWrapper.java | Class | This class contains a subset of the methods of
CmsObject and uses the
configured resource wrappers (
I_CmsResourceWrapper ) to change the view
to the existing resources in the VFS.
Almost every method in this class iterates through the configured list of
I_CmsResourceWrapper and calls the same method there. |
| CmsResourceExtensionWrapperJsp.java | Class | |
| CmsResourceExtensionWrapperXmlContent.java | Class | |
| CmsResourceExtensionWrapperXmlPage.java | Class | |
| CmsResourceWrapperPropertyFile.java | Class | Adds a folder in every existing folder with the name "__properties" which
contains property files for every resource in the existing folder.
Empty folders don't have the property folder visible.
The names of the property files are the same as the resource they belong to
with the extension "properties". |
| CmsResourceWrapperSystemFolder.java | Class | |
| CmsResourceWrapperUtils.java | Class | |
| CmsResourceWrapperXmlPage.java | Class | A resource type wrapper for xml page files, which explodes the xml pages to folders.
Every resource of type "xmlpage" becomes a folder with the same name. |
| CmsWrappedResource.java | Class | Helper class to create "virtual" resources not existing in the vfs which are
based on existing resources.
It is not possible to change a
CmsResource instance. |
| I_CmsResourceWrapper.java | Interface | Interface which is used by the
CmsObjectWrapper to create a different view to the
resources in the VFS.
It is possible to create "new" virtual resource in the view to the clients using the
CmsObjectWrapper or to change the existing ones. |
| Messages.java | Class | |