Module com.github.librepdf.openpdf

Package org.openpdf.text.pdf

Class PdfBatchUtils

java.lang.Object

org.openpdf.text.pdf.PdfBatchUtils

public final class PdfBatchUtils
extends Object

The PdfBatchUtils class provides high-level utilities for performing common PDF operations—such as merging, watermarking, encrypting, and splitting—in batch mode using Java 21 virtual threads for efficient concurrent execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PdfBatchUtils.EncryptJob	Encrypt a PDF with given passwords and permissions.
static final record	PdfBatchUtils.MergeJob	Merge several PDFs into one.
static final record	PdfBatchUtils.SplitJob	Split one PDF into per-page PDFs in the given directory (files will be named baseName_pageX.pdf).
static final record	PdfBatchUtils.WatermarkJob	Add a semi-transparent text watermark to all pages.

Method Summary

Modifier and Type	Method	Description
static int	aes128()	AES 128 vs 256 convenience.
static int	aes256()
static PdfBatch.BatchResult<Path>	batchEncrypt(List<PdfBatchUtils.EncryptJob> jobs, Consumer<Path> onSuccess, Consumer<Throwable> onFailure)	Batch encrypt.
static PdfBatch.BatchResult<Path>	batchMerge(List<PdfBatchUtils.MergeJob> jobs, Consumer<Path> onSuccess, Consumer<Throwable> onFailure)	Batch merge.
static PdfBatch.BatchResult<List<Path>>	batchSplit(List<PdfBatchUtils.SplitJob> jobs, Consumer<List<Path>> onSuccess, Consumer<Throwable> onFailure)	Batch split.
static PdfBatch.BatchResult<Path>	batchWatermark(List<PdfBatchUtils.WatermarkJob> jobs, Consumer<Path> onSuccess, Consumer<Throwable> onFailure)	Batch watermark.
static Path	encrypt(Path input, Path output, String userPassword, String ownerPassword, int permissions, int encryptionType)	Encrypt one PDF.
static Path	merge(List<Path> inputs, Path output)	Merge one set of inputs into a single output file.
static int	perms(boolean print, boolean modify, boolean copy, boolean annotate)	Quick permissions helper.
static List<Path>	split(Path input, Path outputDir, String baseName)	Split one PDF to per-page PDFs.
static Path	watermark(Path input, Path output, String text, float fontSize, float opacity)	Watermark one PDF with text on every page (centered, diagonal).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

merge

public static Path merge(List<Path> inputs,
 Path output)
                  throws IOException,
DocumentException

Merge one set of inputs into a single output file.

Throws:

IOException

DocumentException

batchMerge

public static PdfBatch.BatchResult<Path> batchMerge(List<PdfBatchUtils.MergeJob> jobs,
 Consumer<Path> onSuccess,
 Consumer<Throwable> onFailure)

Batch merge.

watermark

public static Path watermark(Path input,
 Path output,
 String text,
 float fontSize,
 float opacity)
                      throws IOException,
DocumentException

Watermark one PDF with text on every page (centered, diagonal).

Throws:

IOException

DocumentException

batchWatermark

public static PdfBatch.BatchResult<Path> batchWatermark(List<PdfBatchUtils.WatermarkJob> jobs,
 Consumer<Path> onSuccess,
 Consumer<Throwable> onFailure)

Batch watermark.

encrypt

public static Path encrypt(Path input,
 Path output,
 String userPassword,
 String ownerPassword,
 int permissions,
 int encryptionType)
                    throws IOException,
DocumentException

Encrypt one PDF.

Throws:

IOException

DocumentException

batchEncrypt

public static PdfBatch.BatchResult<Path> batchEncrypt(List<PdfBatchUtils.EncryptJob> jobs,
 Consumer<Path> onSuccess,
 Consumer<Throwable> onFailure)

Batch encrypt.

split

public static List<Path> split(Path input,
 Path outputDir,
 String baseName)
                        throws IOException,
DocumentException

Split one PDF to per-page PDFs.

Throws:

IOException

DocumentException

batchSplit

public static PdfBatch.BatchResult<List<Path>> batchSplit(List<PdfBatchUtils.SplitJob> jobs,
 Consumer<List<Path>> onSuccess,
 Consumer<Throwable> onFailure)

Batch split.

perms

public static int perms(boolean print,
 boolean modify,
 boolean copy,
 boolean annotate)

Quick permissions helper.

aes128

public static int aes128()

AES 128 vs 256 convenience.

aes256

public static int aes256()