Update PDF Metadata in Java with GroupDocs.Metadata

Managing PDF files programmatically often means you need to update PDF metadata — author, title, creation date, or even the PDF version itself. Inconsistent metadata can cause rendering glitches or make it harder to locate documents in a large repository. This tutorial walks you through detecting the PDF version and updating PDF metadata using GroupDocs.Metadata for Java, giving you a reliable way to keep your PDFs tidy and compatible.

Quick Answers

  • What does “update PDF metadata” mean? Adding, modifying, or removing information stored inside a PDF file.
  • Which library helps with this in Java? GroupDocs.Metadata.
  • Can I also detect the PDF version? Yes, the same API provides version detection.
  • Do I need a license? A free trial works for evaluation; a paid license is required for production.
  • What Java version is required? JDK 8 or newer.

What is updating PDF metadata?

Updating PDF metadata refers to programmatically reading and writing the descriptive information embedded in a PDF file—such as author, title, subject, and custom properties. Proper metadata improves searchability, compliance, and version control in document management systems.

Why detect PDF version in Java?

Knowing the PDF version (e.g., 1.4, 1.7) helps you ensure that the file will render correctly on the target viewer or that it meets the requirements of downstream processing pipelines. Detecting the version is especially useful when you need to enforce compatibility rules before archiving or publishing documents.

Prerequisites

  • Java Development Kit (JDK) 8 or higher.
  • Maven for dependency management (or you can download the JAR directly).
  • Basic familiarity with Java file I/O.

Setting Up GroupDocs.Metadata for Java

Maven Setup

Add the repository and dependency to your pom.xml:

<repositories>
   <repository>
      <id>repository.groupdocs.com</id>
      <name>GroupDocs Repository</name>
      <url>https://releases.groupdocs.com/metadata/java/</url>
   </repository>
</repositories>

<dependencies>
   <dependency>
      <groupId>com.groupdocs</groupId>
      <artifactId>groupdocs-metadata</artifactId>
      <version>24.12</version>
   </dependency>
</dependencies>

Direct Download

Alternatively, download the latest JAR from the official release page: GroupDocs.Metadata for Java releases.

License Acquisition Steps

  • Free Trial – start experimenting without cost.
  • Temporary License – extend the trial if needed.
  • Purchase – obtain a full‑feature license for production use.

Basic Initialization and Setup

Create a Metadata instance that points to your PDF file:

import com.groupdocs.metadata.Metadata;
import com.groupdocs.metadata.core.PdfRootPackage;

public class PdfMetadataExample {
    public static void main(String[] args) {
        try (Metadata metadata = new Metadata("YOUR_DOCUMENT_DIRECTORY/input.pdf")) {
            // Further operations will go here
        }
    }
}

Now you’re ready to read properties, detect the version, and update metadata.

Detect PDF Version & Read PDF Properties in Java

Step 1: Open the PDF with a Metadata object

try (Metadata metadata = new Metadata("YOUR_DOCUMENT_DIRECTORY/input.pdf")) {
    // Access PDF‑specific properties here
}

Step 2: Get the root package for PDF‑specific details

PdfRootPackage root = metadata.getRootPackageGeneric();

Step 3: Extract version and format information

String fileFormat = root.getPdfType().getFileFormat();
String version = root.getPdfType().getVersion();
String mimeType = root.getPdfType().getMimeType();
String extension = root.getPdfType().getExtension();

System.out.println("File Format: " + fileFormat);
System.out.println("PDF Version: " + version);
System.out.println("MIME Type: " + mimeType);
System.out.println("Extension: " + extension);

Pro tip: Use the version value to enforce compatibility checks before processing a batch of PDFs.

Troubleshooting

  • Verify the file path; an incorrect path throws FileNotFoundException.
  • Ensure the GroupDocs.Metadata version matches your JDK (the example uses 24.12).

Update PDF Metadata in Java

Step 1: Open the PDF (same as above)

try (Metadata metadata = new Metadata("YOUR_DOCUMENT_DIRECTORY/input.pdf")) {
    // Modify or read metadata here
}

Step 2: Access the document‑info package and change fields

PdfRootPackage root = metadata.getRootPackageGeneric();

// Example: read the current author
String author = root.getPdfDocumentInfo().getAuthor();
System.out.println("Author: " + author);

// To update a property, call the setter (omitted for brevity)
// e.g., root.getPdfDocumentInfo().setAuthor("New Author");

Note: The actual setter calls are straightforward; they follow the same pattern as the getters shown.

Common Pitfalls

  • Attempting to modify metadata on a PDF that lacks the target property results in a null value—always check for null before setting.
  • Large PDFs may require increased JVM heap; monitor memory usage during batch updates.

Practical Use Cases

  1. Compliance Audits – Verify that all PDFs meet a minimum version (e.g., 1.7) before legal filing.
  2. Automated Archiving – Tag PDFs with author, department, and creation date for easier retrieval.
  3. Document Management Integration – Enrich PDFs with custom properties that DMS platforms can index.
  4. Report Generation – Insert version information into automatically generated reports.
  5. Cross‑Platform Testing – Detect version mismatches that could cause rendering issues on older viewers.

Performance Tips

  • Use try‑with‑resources (as shown) to automatically close Metadata objects.
  • Batch Process multiple files in a loop to reduce overhead.
  • Monitor Heap for very large PDFs; consider processing them in chunks if you hit memory limits.

Frequently Asked Questions

Q: Can I update metadata on password‑protected PDFs?
A: Yes, but you must supply the password when creating the Metadata object.

Q: Does GroupDocs.Metadata support custom XMP properties?
A: Absolutely. You can read and write custom XMP fields through the same API.

Q: Is it possible to change the PDF version itself?
A: The library can report the version; changing it requires saving the document with a different version profile, which is supported via additional save options.

Q: What happens if the PDF has no existing metadata?
A: The getters will return null. You can safely call the setters to create new metadata entries.

Q: Are there any licensing restrictions for commercial use?
A: A commercial license is required for production deployments; the trial is limited to evaluation purposes.

Last Updated: 2026-02-14
Tested With: GroupDocs.Metadata 24.12 for Java
Author: GroupDocs