Quote PDFs in Java

Why quotes become PDFs

A quote is an offer with an expiry, and it gets forwarded to people who will never log into your product. It has to stand alone and it has to be fixed at the moment it was sent. That is the difference between a document and a view of a database, and it is why sales teams keep asking for this.

What a quote has to carry

Before any of the code below matters, the template has to produce a document that is actually a quote. These are the fields that make it one, and the ones a reader or an auditor will look for first.

• a quote reference, which the eventual order will cite
• the validity date, after which the pricing no longer stands
• each line with the price offered, which may not be list price
• any discount shown as a discount rather than folded into the unit price
• the terms attached to the offer: payment schedule, lead time, exclusions

The Java implementation

java.net.http.HttpClient ships with the runtime, so this adds no dependency. The render happens in a controller returning StreamingResponseBody, and you BodyHandlers.ofInputStream into a StreamingResponseBody.

@GetMapping(value = "/quote/{id}.pdf", produces = MediaType.APPLICATION_PDF_VALUE)
public ResponseEntity<StreamingResponseBody> quotePdf(@PathVariable String id) throws Exception {
    String html = renderQuote(id);

    String payload = mapper.writeValueAsString(Map.of(
        "html", html,
        "options", Map.of("format", "A4", "printBackground", true)
    ));

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://api.pdfpipe.xyz/v1/pdf"))
        .header("Authorization", "Bearer " + System.getenv("PDFPIPE_KEY"))
        .header("Content-Type", "application/json")
        .POST(HttpRequest.BodyPublishers.ofString(payload))
        .build();

    // ofInputStream, not ofByteArray: a long quote never lands on the heap.
    var response = client.send(request, HttpResponse.BodyHandlers.ofInputStream());

    StreamingResponseBody body = out -> response.body().transferTo(out);
    return ResponseEntity.ok(body);
}

The CSS that makes a quote page correctly

The layout problem specific to this document is that optional line items and discount blocks make the length unpredictable, so the signature area must not orphan onto a page of its own. These rules handle it.

/* Backgrounds are dropped unless printBackground is set on the
   request, which is the usual reason a document renders in plain
   black and white when it looked right in the browser. */
@page {
  size: A4;
  margin: 18mm 16mm;
}

table { break-inside: avoid; }
h2    { break-after: avoid; }

What goes wrong in Java

BodyHandlers.ofByteArray materialises the whole document on the heap. On a servlet container sized for JSON payloads, a few concurrent report renders is all it takes to meet the GC.

What people try first

Most Java projects reach for iText, whose AGPL terms mean commercial use needs a paid licence, or PDFBox, which draws primitives rather than laying out HTML. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.

Where the quote lives afterwards

Rendering is the short part. A quote is dead once it expires or converts, so retention is short and driven by the sales system rather than by law. What matters is that the version the customer received is the one you can produce later, because a disputed price is settled by the document that was sent.

Getting the document right

• Check the validity date, since a quote without one is an open-ended commitment.
• Generation is triggered by a salesperson sending it, so latency is felt directly by a person waiting, so size the timeout for that path rather than for a health check.
• These are produced one at a time by a person who is waiting, so latency is felt directly.
• Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.

Frequently asked

Related

Other Java documents, and the same quote in other stacks.