Static Export configuration

From OpenCms Wiki
(Difference between revisions)
Jump to: navigation, search
m (The Role of the OpenCms Error Handler during Static Export)
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
== Static Export Configuration ==
 
== Static Export Configuration ==
See also: [[Static Export]]
+
For an introduction, see: [[Static Export]]
  
=== The Role of the OpenCms Error Handler Servlet during Static Export ===
+
=== The Role of the OpenCms Error Handler during Static Export ===
The static export is always based on a specialized "Error-Handler" Servlet. This Servlet runs in the same web application as the main servlet of OpenCms, but is mapped to a different URL perfix(e.g. ''/handle404/'').
+
The static export is always based on a specialized "Error-Handler". This errorhandler is registered for then complete OpenCms web application, so whenever a request points to nonexistent resources that belong to OpenCms, then the webserver will call the file-not-found handler of OpenCms and the errorhandler will take over.  
  
There are two ways, how this Servlet is used to trigger the export of an existing file into the file system:
+
If a request points to a location where a file should be exported (usually '''/opencms/export/'''), but is not yet exported then the errorhandler will cause the resource to be generated dynamically and will return the processing result to the client.
  
* The way of triggering the Error Handler servlet happens, if a user requests a file that is not yet exported into the file system. In this case the web server issues a file not found error (HTTP code 404). The webserver must be configured so that it calls the specialized Errorhandler-Servlet of OpenCms. That Servlet will then cause the missing file to be processed and the results are written into the file system. It also returns the processing result for the requested file to the requesting client, so that the client will not notice that an internal file-not-found error had occurred inside of the server.<br /> After that, an exported form of the requested file will exist in the file system. This will speed all future requests for the given file, as all future requests can be directly satisfied with that exported file. This method is called [[Static Export On Demand]].
+
There are two ways, how this Handler is used to trigger the export of an existing file into the file system:
  
* Another export method is called [[Static Export After Publish]]. It also uses the error handler servlet. If this method of publishing is active, then OpenCms will export files as soon as changes are published. At that point, OpenCms will check the Export configuration for any resource sets that are defined there. When at least one file that belongs to a defined resource set is exported, then all other files that belong to that set are also exported. Resource sets are defined by one or more regular expressions annd all files whose path matches one of these expressions, belongs to the given resource set.<br />If a file is exported, which belongs to no resource set at all, then ''all'' exportable files in the system are exported. The export is triggered by OpenCms calling it's own Errorhandler-Servlet for each file to be exported. This will cause these files to be exported into the file System. If a file has existed before, then it will be overwritten.
+
* If a user requests a file by calling its ''export'' location and if the file is not yet exported then the Error handler will take over, as described above. In this situation, OpenCms will always return the requested page to the client, as if it would exist in this location. But OpenCms can also be configured to write the requested resource into the file system along with that. <br /> In this way, after the first failing request to an exportable resource, the file will exist in the file system to satisfy future requests for the same resource. This will speed all future requests for the given file, as all future requests can be directly satisfied with that exported file. This method is called [[Static Export On Demand]]. With this export strategy, all already exported files will be deleted from the file system, which where changed in the workplace and published. After that, whenever an exportable resource is requested, it will be re-created in its current state and written to the file system again.
  
Because the Error handler is used for both Static Export methods, the error handler servlet must be working, otherwise the export will fail. Also, for Static Export After Publish, the URL prefix of the Errorhandler servlet must be corretly configured in the export configuration, so that opencms is able to call it's own errorhandler via HTTP.
+
* Another export method is called [[Static Export After Publish]]. It also uses the error handler's mechanism for exporting files. If this method of publishing is active, then OpenCms will export files as soon as changes are ''published''. At that point, OpenCms will check the Export configuration for any resource sets that are defined there. When at least one file that belongs to a defined resource set is exported, then all other files that belong to that set are also exported. Resource sets are defined by one or more regular expressions and all files whose path matches one of these expressions, belongs to the given resource set.<br />If a file is exported, which belongs to no resource set at all, then ''all'' exportable files in the system are exported. The export is triggered by OpenCms calling it's own Errorhandler via HTTP for each file to be exported. As described above, the errorhandler will return the resulting page for this request. That page will then be exported into the file System. If a file has existed before, then it will be overwritten.
 +
 
 +
* [[Static Export after publish in the Background]]. (This can be done with a custom export handler.)
 +
 
 +
Because the Error handler is used for both Static Export methods, it must be working correctly, otherwise the export will fail. Also, for Static Export After Publish, the URL for exportable files must be corretly configured in the export configuration, so that opencms is able to call it's own errorhandler via HTTP.
  
 
== External Links ==
 
== External Links ==
=== Static Export After Publish ===
+
=== Configuring Static Export After Publish ===
* [http://www.opencms-forum.de/opencms-forum/viewthread?thread=1279 Configuring Static Export Tutorial] ([http://lists.opencms.org/pipermail/opencms-dev/2005q4/021164.html Alternative Link])
+
* [http://lists.opencms.org/pipermail/opencms-dev/2005q4/021164.html Configuring Static Export Tutorial]
 +
 
 +
[[Category:Getting OpenCms up and running]]

Latest revision as of 16:44, 1 August 2019

Contents

Static Export Configuration

For an introduction, see: Static Export

The Role of the OpenCms Error Handler during Static Export

The static export is always based on a specialized "Error-Handler". This errorhandler is registered for then complete OpenCms web application, so whenever a request points to nonexistent resources that belong to OpenCms, then the webserver will call the file-not-found handler of OpenCms and the errorhandler will take over.

If a request points to a location where a file should be exported (usually /opencms/export/), but is not yet exported then the errorhandler will cause the resource to be generated dynamically and will return the processing result to the client.

There are two ways, how this Handler is used to trigger the export of an existing file into the file system:

  • If a user requests a file by calling its export location and if the file is not yet exported then the Error handler will take over, as described above. In this situation, OpenCms will always return the requested page to the client, as if it would exist in this location. But OpenCms can also be configured to write the requested resource into the file system along with that.
    In this way, after the first failing request to an exportable resource, the file will exist in the file system to satisfy future requests for the same resource. This will speed all future requests for the given file, as all future requests can be directly satisfied with that exported file. This method is called Static Export On Demand. With this export strategy, all already exported files will be deleted from the file system, which where changed in the workplace and published. After that, whenever an exportable resource is requested, it will be re-created in its current state and written to the file system again.
  • Another export method is called Static Export After Publish. It also uses the error handler's mechanism for exporting files. If this method of publishing is active, then OpenCms will export files as soon as changes are published. At that point, OpenCms will check the Export configuration for any resource sets that are defined there. When at least one file that belongs to a defined resource set is exported, then all other files that belong to that set are also exported. Resource sets are defined by one or more regular expressions and all files whose path matches one of these expressions, belongs to the given resource set.
    If a file is exported, which belongs to no resource set at all, then all exportable files in the system are exported. The export is triggered by OpenCms calling it's own Errorhandler via HTTP for each file to be exported. As described above, the errorhandler will return the resulting page for this request. That page will then be exported into the file System. If a file has existed before, then it will be overwritten.

Because the Error handler is used for both Static Export methods, it must be working correctly, otherwise the export will fail. Also, for Static Export After Publish, the URL for exportable files must be corretly configured in the export configuration, so that opencms is able to call it's own errorhandler via HTTP.

External Links

Configuring Static Export After Publish

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox