Package org.opencms.file.wrapper

package org.opencms.file.wrapper

This package contains classes and interfaces used to access OpenCms through a wrapped CmsObject.

Main entry point is the class CmsObjectWrapper. The CmsObjectWrapper is configured with a list of implementations of 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 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 CmsRepositorySession to create a simple configurable access to the resources in OpenCms.

Since:

6.2.4

See Also:

• CmsObjectWrapper
• I_CmsResourceWrapper

Related Packages

Package	Description
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.file.collectors	Collectors allow to gather lists of OpenCms resources from the OpenCms VFS using specific rules.
org.opencms.file.history	This package contains the classes to deal with the OpenCms VFS history archive.
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.

Class	Description
A_CmsResourceExtensionWrapper	Abstract base class which implements I_CmsResourceWrapper and makes it possible to add and remove file extensions to resources.
A_CmsResourceWrapper	Default abstract implementation of the interface I_CmsResourceWrapper.
CmsObjectWrapper	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.
CmsResourceExtensionWrapperJsp	A resource type wrapper for jsp files, which adds the correct file extension "jsp" to the resources.
CmsResourceExtensionWrapperXmlContent	A resource type wrapper for xml content files, which adds the correct file extension "xml" to the resources.
CmsResourceExtensionWrapperXmlPage	A resource type wrapper for xml pages, which adds the correct file extension "xml" to the resources.
CmsResourceWrapperModules	Resource wrapper used to import/export modules by copying them to/from virtual folders.
CmsResourceWrapperModulesNonLazy	Resource wrapper used to import/export modules by copying them to/from virtual folders.
CmsResourceWrapperPreventCreateNameCI	Resource wrapper class which is used to prevent resources with a certain name from being created.
CmsResourceWrapperPreventCreateNameRegex	Resource wrapper class which is used to prevent resources with names matching a given regex from being created.
CmsResourceWrapperPropertyFile	Adds a folder in every existing folder with the name "__properties" which contains property files for every resource in the existing folder.
CmsResourceWrapperReplaceDeleted	Resource wrapper which intercepts createResource calls and substitutes them with replaceResource if there is already a deleted file at the same path.
CmsResourceWrapperSystemFolder	Adds the system folder to every root folder of target sites.
CmsResourceWrapperUtils	Helper class with several methods used by different implementations of the interface I_CmsResourceWrapper.
CmsResourceWrapperXmlPage	A resource type wrapper for xml page files, which explodes the xml pages to folders.
CmsSilentWrapperException	Exception to be used in wrappers for exceptions that you don't want to be logged as errors.
CmsWrappedResource	Helper class to create "virtual" resources not existing in the vfs which are based on existing resources.
I_CmsResourceWrapper	Interface which is used by the CmsObjectWrapper to create a different view to the resources in the VFS.
Messages	Convenience class to access the localized messages of this OpenCms package.