OpenCms online Javadoc

NEW: Go to OpenCms Documentation Central - http://documentation.opencms.org for all the OpenCms documentation, including Javadoc, in one place. 

The Javadoc documentation for OpenCms is helpful for developers who are interested in using and extending the OpenCms functionality. This documentation is automatically generated from comments within the OpenCms Java source code.

We provide the following Javadoc documentations of the latest stable OpenCms version for convenient online access:

  • OpenCms core API
    This is the main API documentation for the OpenCms core packages, which are used for building customized OpenCms websites.
  • OpenCms workplace modules
    The documentation for the modules that build the OpenCms Workplace (Administration view, WYSIWIG editors). These are usually of interest only to developers who want to extend the OpenCms Workplace.
  • OpenCms setup API
    These are the classes used by the OpenCms setup wizard and the upgrade wizard.
  • OpenCms GWT components
    The documentation of the GWT components used to build the GUI of the new ADE features. GWT is a development toolkit for building and optimizing complex browser-based applications.

Please note: We at Alkacon put a lot of work in our Javadoc to make it as useful as possible. Usually the quality of our Javadoc is considered very good (as compared to other projects).

Latest News

  • OpenCms 17 available

    Apr 9, 2024 - OpenCms 17 gives content managers the new app "Date search" to find content that has been changed in a certain time range. The "Websites" app allows to easily export the content of a complete site for archiving. An option has been added to hide "sensitive" content in the Offline project. The default Mercury template has been further improved, e.g. with SEO optimized job postings, a "spacer" function and marker clusters for maps. OpenCms 17 has also been tested and certified using Java 17 LTS and 21 LTS.

  • OpenCms 17 Release Notes

    Apr 9, 2024 - The OpenCms 17 release notes contain detailed information about the new features and fixes in this version.

  • Alkacon OCEE 17

    Apr 9, 2024 - Alkacon OCEE 17 is the latest OCEE release for OpenCms 17. This version improves the cluster shutdown behaviour when using the CmsShell.

  • OpenCms Docker image

    Apr 9, 2024 - Test OpenCms using the official image from the Docker hub registry - the fastest way to evaluate and test OpenCms. The image is well suited for evaluation and test purposes of the latest OpenCms release. We provide a docker-compose file to get OpenCms and the database running with just one command.

Try the OpenCms Live Demo