{"id":26534857,"url":"https://github.com/iron-software/ironpdf-for-java","last_synced_at":"2025-03-21T20:28:53.364Z","repository":{"id":62817950,"uuid":"560283467","full_name":"iron-software/IronPDF-for-Java","owner":"iron-software","description":"IronPDF for Java","archived":false,"fork":false,"pushed_at":"2025-03-21T06:27:15.000Z","size":4971,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-21T07:27:04.203Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rich Text Format","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iron-software.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-01T06:05:52.000Z","updated_at":"2025-03-06T10:55:13.000Z","dependencies_parsed_at":"2023-01-31T03:00:17.806Z","dependency_job_id":"5afebeda-bbbc-47ef-a97e-b020babf690f","html_url":"https://github.com/iron-software/IronPDF-for-Java","commit_stats":null,"previous_names":[],"tags_count":80,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iron-software%2FIronPDF-for-Java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iron-software%2FIronPDF-for-Java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iron-software%2FIronPDF-for-Java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iron-software%2FIronPDF-for-Java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iron-software","download_url":"https://codeload.github.com/iron-software/IronPDF-for-Java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244864015,"owners_count":20523079,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-21T20:28:52.661Z","updated_at":"2025-03-21T20:28:53.353Z","avatar_url":"https://github.com/iron-software.png","language":"Rich Text Format","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Apache Maven](https://img.shields.io/maven-central/v/com.ironsoftware/ironpdf)  ![Passed](https://img.shields.io/badge/build-%20%E2%9C%93%203158%20tests%20passed%20(0%20failed)%20-107C10?logo=visualstudio)  [![windows](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=windows)](https://ironpdf.com/python/docs/questions/installation/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield) [![macOS](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=apple)](https://ironpdf.com/python/docs/questions/macos/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield) [![linux](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=linux\u0026logoColor=white)](https://ironpdf.com/python/docs/questions/linux/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield) [![docker](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=docker\u0026logoColor=white)](https://ironpdf.com/python/docs/questions/docker-linux/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield) [![aws](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=amazonaws)](https://ironpdf.com/python/docs/questions/creating-pdfs-csharp-amazon-aws-lambda/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield) [![microsoftazure](https://img.shields.io/badge/%E2%80%8E%20-%20%E2%9C%93-107C10?logo=microsoftazure)](https://ironpdf.com/python/docs/questions/azure/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield) [![livechat](https://img.shields.io/badge/Live%20Chat:-24/5-purple?logo=googlechat\u0026logoColor=white)](https://ironpdf.com/python/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=topshield#helpscout-support)\n\n# IronPDF for Java - Create, Edit, and Read PDFs in Java Applications\n___\n\nIronPdf is a library developed and maintained by Iron Software that helps\nSoftware Engineers to create, edit and extract PDF content in projects in Java.\n\n## IronPDF excels at:\n\n- Generating PDFs from: HTML, URL, JavaScript, CSS and many image formats\n- Adding headers/footers, signatures, attachments, and passwords and security\n- Performance optimization: Full Multithreading and Async support\n- And many more! Visit our website to see all our code examples and\n  a [full list of our 50+ features](https://ironpdf.com/java/features/?utm_source=nuget\u0026utm_medium=organic\u0026utm_campaign=readme\u0026utm_content=featureslist)*\n\n## Using IronPDF\n\n### Define IronPDF as a Java Dependency\n\nTo define IronPDF as a dependency, please add the following excerpt to your pom.xml:\n\n```xml  \n\u003cdependencies\u003e\n  \u003cdependency\u003e\n    \u003cgroupId\u003ecom.ironsoftware\u003c/groupId\u003e\n    \u003cartifactId\u003eironpdf\u003c/artifactId\u003e\n    \u003cversion\u003e20xx.xx.xxxx\u003c/version\u003e\n  \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n### Start writing Java code\n\nOnce the dependence is defined, you can get started by adding the `import com.ironsoftware.ironpdf.*` statement to the top of your Java code. Here is\na sample HTML to PDF example to get started:\n\n```java\nPdfDocument pdfDocument = PdfDocument.renderHtmlAsPdf(\"\u003ch1\u003e ~Hello World~ \u003c/h1\u003e Made with IronPDF!\");\n        pdfDocument.saveAs(Paths.get(\"html_saved.pdf\"));\n```\n\nThis is another example which demonstrates URL to PDF:\n\n```java \nPdfDocument pdfDocument = PdfDocument.renderUrlAsPdf(\"https://ironpdf.com/java\");\n        pdfDocument.saveAs(Paths.get(\"url_saved.pdf\"));\n```\n\n### Settings\n\nNote: Please note that all settings, logging, and licensing operations must be executed before any IronPDF methods are called.\n\n#### Applying License Key\n\n```java \ncom.ironsoftware.ironpdf.License.setLicenseKey(\"YOUR-LICENSE-KEY\");\n```\n\n#### Logging\n\nIronPdf Java uses the [slf4j](https://www.slf4j.org/) logger. To enable logging use:\n```java \ncom.ironsoftware.ironpdf.Settings.setDebug(true);\n```\nTo specify the IronPdfEngine log path add:\n```java \ncom.ironsoftware.ironpdf.Settings.setLogPath(Paths.get(\"C:/tmp/myIronPdfEngineLog.log\"));\n```\n\nNot familiar with slf4j? Just add this to your `pom.xml`:\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.slf4j\u003c/groupId\u003e\n  \u003cartifactId\u003eslf4j-simple\u003c/artifactId\u003e\n  \u003cversion\u003e2.0.3\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## About IronPDF for Java\n\n`IronPDF for Java` is based on `IronPDF for .NET`, it will generally be about 1 version behind.\n\nIronPDF for Java uses gRPC to communicate with the `IronPdfEngine`, which consumes `IronPDF for .NET`\n\n## About IronPDF Engine\n\n`IronPdfEngine` is the core of IronPdf. To use `IronPdf for Java` `IronPdfEngine` binaries is required.\n\nThe `IronPdfEngine` process will start when you call any IronPdf function for the first time, and stop when your application is closed, or when it enters an idle stage.\n\nBy default `IronPdf for Java` will download `IronPdfEngine` binaries on the first run (or when it cannot find the binaries).\n\n\u003e Note: For macOS, `IronPdfEngine` binaries that download on the first run might not work in your system (Gatekeeper on macOS).\nPlease use `IronPdfEngine` as a maven dependency instead (next section)\n\n### Install IronPDF Engine as a Maven Dependency\n\nBy adding IronPdfEngine as a Maven dependency, the binaries will be downloaded during the loading of dependencies:\n- This approach will avoid a lengthy startup process, as the IronPdfEngine binaries will already be downloaded.\n- Moreover, it will be beneficial for deployment setups that do not allow downloading from external sources.\n\nSimply add one or multiple of the following code snippets to your **pom.xml** file if you are working on a multiplatform app:\n\n#### For windows x64\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.ironsoftware\u003c/groupId\u003e\n  \u003cartifactId\u003eironpdf-engine-windows-x64\u003c/artifactId\u003e\n  \u003cversion\u003e20xx.xx.xxxx\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### For windows x86\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.ironsoftware\u003c/groupId\u003e\n  \u003cartifactId\u003eironpdf-engine-windows-x86\u003c/artifactId\u003e\n  \u003cversion\u003e20xx.xx.xxxx\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### For Linux x64\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.ironsoftware\u003c/groupId\u003e\n  \u003cartifactId\u003eironpdf-engine-linux-x64\u003c/artifactId\u003e\n  \u003cversion\u003e20xx.xx.xxxx\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### For macOS x64 (Intel)\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.ironsoftware\u003c/groupId\u003e\n  \u003cartifactId\u003eironpdf-engine-macos-x64\u003c/artifactId\u003e\n  \u003cversion\u003e20xx.xx.xxxx\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### For macOS Arm (Apple Silicon)\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.ironsoftware\u003c/groupId\u003e\n  \u003cartifactId\u003eironpdf-engine-macos-arm64\u003c/artifactId\u003e\n  \u003cversion\u003e20xx.xx.xxxx\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Licensing \u0026 Support Available\n\n`IronPdf for Java` is free to use and test with an IronPDF watermark applied. To remove the watermark [apply for a license or trial license.](https://ironpdf.com/licensing/).\n\nFor our full list of code examples, tutorials, licensing information, and documentation\nvisit: [https://ironpdf.com/java](https://ironpdf.com/java)\n\nFor more support and inquiries, please email us at: support@ironsoftware.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firon-software%2Fironpdf-for-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firon-software%2Fironpdf-for-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firon-software%2Fironpdf-for-java/lists"}