Package org.opencms.staticexport

Contains the functionality for the static HTML page export.

The static export allows the rendering of resources (including dynamic generated HTML pages) to the file system. Resouces that are static exported will not longer be served through the OpenCms VFS and the connected databases, but directly from the harddrive of the system. This can dramatically improve performance for an OpenCms generated website.

Static export is only enabled for the "Online" project. When working in any offline project, resources are served directly from the OpenCms VFS. This way changes made in the offline mode are immediatly visible.

If your system is properly configured, you can directly serve static exported resources with a standard webserver. This means the requests will not even be forwarded to the Java VM based servlet container. This is the optimal configuration for maximum performance.

The link management is required in order to mix resources serves dynamically from OpenCms with staitc exported resources. Example: A JSP based template renders a persoanlized web page from OpenCms. This page can obviously not be static exported. However, there are a number of images refered to on the page. These images are part of the template and also managed inside the OpenCms VFS. By configuration you can staitc export these images. This means that all links to the images must be adjusted, since the links must now point to a different location. This is what the static export link management does. It adjusts links to resources that have been static exported so that they point to the static export location for the "Online" project, and to the OpenCms VFS location for offline projects.

Export points are not related to the static export. An export point is simply a folder inside the OpenCms VFS that is copied 1:1 to a location in the real file system during publishing. This is for example used to copy Java classes, JAR files or other system resouces from the VFS to the WEB-INF/classes or WEB-INF/lib folder. No link processing is done for resources written with export points.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsLinkSubstitutionHandler	Allows to configure customized link substitution behavior.
I_CmsStaticExportHandler	Provides a method for scrubbing files from the export folder that might have been changed, so that the export is newly created after the next request to the resource.

Class Summary

Class	Description
A_CmsOnDemandStaticExportHandler	Abstract implementation for the I_CmsStaticExportHandler interface.
A_CmsStaticExportHandler	Abstract base implementation for the I_CmsStaticExportHandler interface.
CmsAdvancedLinkSubstitutionHandler	Advanced link substitution behavior.
CmsAfterPublishMultiLanguageStaticExportHandler	Extended after publish static export handler, supporting multi-language exports.
CmsAfterPublishStaticExportHandler	Implementation for the I_CmsStaticExportHandler interface.
CmsDefaultLinkSubstitutionHandler	Default link substitution behavior.
CmsExportFolderMatcher	This class provides a file name matcher to find out those resources which must be part of a static export.
CmsExportname	A bean for a export name.
CmsExportname.CmsExportNameComparator	A export name comparator.
CmsLinkManager	Does the link replacement for the ≶link> tags.
CmsLinkProcessor	Implements the HTML parser node visitor pattern to exchange all links on the page.
CmsLinkTable	Maintains a table of links for an element of a CmsXmlPage.
CmsLinkTable.LinkKeyComparator	Comparator used to deterministically order the link table.
CmsLocalePrefixLinkSubstitutionHandler	Link substitution handler required to render single tree localized sites.
CmsOnDemandHtmlSubTreeHandler	Concrete OnDemandExportHandler.
CmsOnDemandStaticExportHandler	Concrete OnDemandExportHandler.
CmsPrefixFileFilter	Implements the file filter used to guess the right suffix of a deleted jsp file.
CmsStaticExportData	Provides a data structure for the result of an export request.
CmsStaticExportExportRule	Help class for storing of export-rules.
CmsStaticExportManager	Provides the functionality to export resources from the OpenCms VFS to the file system.
CmsStaticExportRequest	Wrapper for static export requests, required for parameter based requests.
CmsStaticExportResponseWrapper	Response wrapper for static export requests, required to access the status code of the response.
CmsStaticExportRfsRule	Help class for storing of rfs-rules.
Messages	Convenience class to access the localized messages of this OpenCms package.

Exception Summary

Exception	Description
CmsStaticExportException	Describes errors that occur in the context of OpenCms scheduler.