Samples¶
The sample applications live in their own repository, jodconverter/jodconverter-samples, where they are built and tested with each change, against the latest release of JODConverter. Each one has a README that says how to run it and what it shows.
| Sample | What it shows |
|---|---|
| basic-webapp | A plain Jakarta Servlet application, without a framework: a LocalOfficeManager started and stopped with the application, and a servlet that converts the uploaded documents. |
| spring-boot-webapp | A web page with the Spring Boot starter: conversions with filters, PDF options and passwords. |
| spring-boot-rest | A REST API with the Spring Boot starter: conversions with load and store properties, a description of the office, previews of the first page and images of the slides, and the health and meters of the office processes. |
| spring-boot-remote | Conversions sent to a Collabora Online server with the remote module: the application has no office of its own. |
| spring-boot-attached | Conversions with a LibreOffice that runs in a container, which the application does not start: the AttachedOfficeManager, with the documents sent through the connection. |
The samples need Java 17 or later. All of them but the remote one need LibreOffice, installed on the machine or, for the attached sample, in its container; the remote and attached samples need Docker for their conversion server or office. To run one, from the root of the repository:
./gradlew :samples:spring-boot-rest:bootRun
Whenever OpenOffice.org (OOo for short) is mentioned, this can generally be interpreted to include any office suite derived from OOo such as Apache OpenOffice and LibreOffice.