API Documentation for Bloomreach Content

Info: Public hosting of Javadocs at javadoc.onehippo.org will be deprecated in October 2025. Analysis shows that these resources receive very little usage. Developers can generate the same Javadocs locally from the codebase as needed. As a result, public hosting will be discontinued instead of migrated to new infrastructure.
This change allows Bloomreach to focus on maintaining documentation that delivers more value. If you need Javadocs, generate them from the source code using standard build tools.

You can generate the following API documentation directly from the Bloomreach Content source code:

• CMS API reference
• Commons API reference
• Repository API reference
• Services API reference
• Site Toolkit API reference
• CRISP API reference
• HST Tag Library JSP/Freemarker
• OpenUI Extension Library JavaScript TypeDoc

Building Javadocs

If your root pom.xml does not include an apidocs Maven profile, add it as described in Required Maven Profile.

To generate the Javadocs:

1. From the root directory of the Bloomreach Content repository, run:

   mvn -Papidoc clean javadoc:javadoc validate
   copy

2. Wait for the build process to finish.
3. When the build completes, the generated Javadoc files will be in the target/<version> directory (or target/<apidocs> for version 16.6 and higher).
4. Open the generated HTML files in your browser to view the API reference.

For more information about building the full Bloomreach Content project, see Build Bloomreach Content From Source.

Output Format

The Javadoc build creates a target/ directory in the root of your project.

Inside target/, a subdirectory named after your Bloomreach Content version contains the generated developer reference files.

The table below shows the contents of each folder. To view an API specification, open the index.html file in the relevant folder using your browser and navigate through the available resources.

Folder name	Specification
bloomreach-ui-extension	OpenUI Extension Library JavaScript TypeDoc (includes document field and dialog extensions APIs)
hippo-addon-crisp	CRISP API reference
hippo-cms	CMS API reference
hippo-cms-commons	Commons API reference
hippo-repository-api	Repository API reference
hippo-services-api	Services API reference
hippo-site-toolkit	Site Toolkit (HST) API reference
tlddocs	HST Tag Library JSP/Freemarker

Required Maven Profile

Add the following Maven profile to the <profiles> section of your root pom.xml to enable Javadoc generation:

<profile>
  <id>apidoc</id>
  <build>
    <plugins>
      <plugin>
        <!-- build hst tlddoc -->
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <executions>
          <execution>
            <id>tlddoc</id>
            <phase>validate</phase>
            <goals>
              <goal>java</goal>
            </goals>
            <configuration>
              <includePluginDependencies>true</includePluginDependencies>
              <includeProjectDependencies>false</includeProjectDependencies>
              <mainClass>com.sun.tlddoc.TLDDoc</mainClass>
              <arguments>
                <argument>-doctitle</argument>
                <argument>HST Tag Library</argument>
                <argument>-windowtitle</argument>
                <argument>HST Tag Library</argument>
                <argument>-d</argument>
                <argument>${project.build.directory}/${javadoc.base.version}/tlddocs</argument>
                <argument>community/site-toolkit/client/src/main/resources/META-INF/hst-core.tld</argument>
              </arguments>
            </configuration>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>taglibrarydoc</groupId>
            <artifactId>tlddoc</artifactId>
            <version>1.3</version>
          </dependency>
        </dependencies>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
          <execution>
            <id>copy-javadoc</id>
            <phase>validate</phase>
            <goals>
              <goal>run</goal>
            </goals>
            <configuration>
              <target name="copy javadoc files">
                <copy todir="${project.build.directory}/${javadoc.base.version}/hippo-cms-commons">
                  <fileset dir="commons/target/reports/apidocs/"/>
                </copy>
                <copy todir="${project.build.directory}/${javadoc.base.version}/hippo-services-api">
                  <fileset dir="services-api/target/reports/apidocs/"/>
                </copy>
                <copy todir="${project.build.directory}/${javadoc.base.version}/hippo-repository-api">
                  <fileset dir="repository/api/target/reports/apidocs/"/>
                </copy>
                <copy todir="${project.build.directory}/${javadoc.base.version}/hippo-site-toolkit">
                  <fileset dir="site-toolkit/api/target/reports/apidocs/"/>
                </copy>
                <copy todir="${project.build.directory}/${javadoc.base.version}/hippo-cms">
                  <fileset dir="cms/api/target/reports/apidocs/"/>
                </copy>
                <copy todir="${project.build.directory}/${javadoc.base.version}/hippo-addon-crisp">
                  <fileset dir="crisp/api/target/reports/apidocs/"/>
                </copy>
                <copy todir="${project.build.directory}/${javadoc.base.version}/bloomreach-ui-extension">
                  <fileset dir="ui-extension/docs/"/>
                </copy>
              </target>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</profile>
copy