Exporting Reports

Overview

JasperReports Library provides Exporter implementations that can export print documents to various formats such as HTML, PDF, XLSX, and more.

ReportShell wraps these exporters behind a small ReportExporter abstraction so that the same export pipeline powers REST responses and the frontend viewer’s download flows.

Exporter Factories

The framework uses a ReportExporterFactory to create a configured ReportExporter for each export operation.

ReportShell provides built-in factories for the most common export formats:

• HTML
• PDF (requires jasperreports-pdf-<version>.jar on the classpath)
• CSV
• XLSX
• DOCX
• CSV (Metadata)

All these factories extend AbstractReportExporterFactory, which handles most of the common factory logic.

For other formats or custom exporter logic, you typically register a custom ReportExporterFactory for a specific output format. See API docs of ReportExporterFactoryRegistry for how to register or override exporter factories.

See also Exporter Registration Sample on GitHub, which shows how to register an RTF exporter factory.

Note

The default HtmlExporter created by ReportShell is not configured to support dynamic attachments or interactive features such as navigation links.

To support those, either register your own exporter factory or register a Spring bean of type JasperReportsExporterCustomizer to override the configuration of the exporter that ReportShell creates.

Export Context

When exporting a report, the framework creates a ReportExportContext that contains everything needed for the export operation. This includes the Operation Context, the output stream to write to, an ExporterInput containing the JasperPrint document, and export options (for example: output format, page, page range, and zoom).

This context is passed to a ReportExporterFactory which creates and configures a ReportExporter based on this context.