1. IronPDF
  2. Comenzar
  3. Usar IronPdfEngine

How to Use IronPdfEngine

Curtis Chau
Curtis Chau
Actualizado:
This article was translated from English: Does it need improvement?
Translated
View the article in English

IronPdfEngine is a gRPC server designed to manage various IronPDF operations, including creating, writing, editing, and reading PDFs.

How to Use IronPdfEngine as a Remote Server

  1. Install the Java library to utilize IronPdfEngine
  2. Include the library in the pom.xml file
  3. Utilize the `setIronPdfEngineHost` method to configure the host
  4. Utilize the `setIronPdfEnginePort` method to configure the port
  5. Use the IronPdfEngine to render HTML to PDF with a renderer identical to Chrome

Link to Download IronPDF for Java on ironpdf.com

IronPdf for Java and IronPdfEngine

IronPdf for Java requires IronPdfEngine to run. The Java code serves as an API mask over IronPdfEngine gRPC. When you invoke any method in IronPdf for Java, the actual processing occurs inside IronPdfEngine!

By default, IronPdf for Java will spawn IronPdfEngine as a subprocess and interact with it until your application shuts down.

Por favor notaEach version of IronPdf for Java requires a specific version of IronPdfEngine. Cross-version compatibility is not supported.

IronPdf for Java with Local IronPdfEngine

Option 1: Download IronPdfEngine at Runtime

By default, after you install IronPdf in your Java project, on the initial run, IronPdf will detect your platform (e.g., Windows x64) and download the appropriate IronPdfEngine binaries from the internet.

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf</artifactId>
    <version>20xx.xx.xx</version>
</dependency>
<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf</artifactId>
    <version>20xx.xx.xx</version>
</dependency>
XML

Pros

  • Your application package will be small.
  • Can deploy on many platforms.

Cons

  • Internet access is needed on the first runs.
  • Slow startup time.

Option 2 (recommended): Install IronPdfEngine as a Dependency

IronPdf Java allows you to add IronPdfEngine directly as a dependency. These dependencies wrap IronPdfEngine into a .zip file, automatically extracting and using it.

You can choose to install one or more of these IronPdfEngine dependencies.

Por favor notaironpdf and ironpdf-engine-xxx-xxx dependency version must be the same. ironpdf-engine-xxx-xxx does not refer to the IronPdfEngine's internal version.

For Windows x64

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-windows-x64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-windows-x64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
XML

For Windows x86

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-windows-x86</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-windows-x86</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
XML

For Linux x64

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-linux-x64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-linux-x64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
XML

For macOS x64

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-macos-x64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-macos-x64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
XML

For macOS arm

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-macos-arm64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf-engine-macos-arm64</artifactId>
    <version>20xx.xx.xxxx</version>
</dependency>
XML

Por favor notaEach dependency is quite large, so installing them all is not advisable.

Pros

  • Faster startup time.
  • Internet access is not needed after the dependency is installed.

Cons

  • Your application package will be large.
  • Need to specify target platforms.

IronPdf for Java with Remote IronPdfEngine

To use a remote IronPdfEngine, a specific version is necessary. For example, if IronPdf for Java version 2024.2.2 requires IronPdfEngine version 2024.2.2, do not use version 2024.2.1. Use the getIronPdfEngineVersion method to verify the required version.

// Get the version of the IronPdfEngine needed for the current Java version
String ironPdfEngineVersion = Settings.getIronPdfEngineVersion();
// Get the version of the IronPdfEngine needed for the current Java version
String ironPdfEngineVersion = Settings.getIronPdfEngineVersion();
JAVA

How to Connect

Assume that IronPdfEngine is running remotely at 123.456.7.8:33350.

Refer to Instructions on How to Pull and Run IronPdfEngine

To connect, specify the location of IronPdfEngine (ensure the address is accessible and not blocked by firewalls). Add this code during the initial stage of your application (or just before invoking any IronPdf method).

// Set the host and port for a remote IronPdfEngine connection
com.ironsoftware.ironpdf.Settings.setIronPdfEngineHost("123.456.7.8");
com.ironsoftware.ironpdf.Settings.setIronPdfEnginePort(33350);
// Set the host and port for a remote IronPdfEngine connection
com.ironsoftware.ironpdf.Settings.setIronPdfEngineHost("123.456.7.8");
com.ironsoftware.ironpdf.Settings.setIronPdfEnginePort(33350);
JAVA

Simple as that! After executing this code, your application connects to the remote IronPdfEngine!

For remote IronPdfEngine, installing IronPdfEngine as a dependency is not needed. You can skip the section titled "Option 2 (recommended): Install IronPdfEngine as a Dependency."

Preguntas Frecuentes

¿Qué es IronPdfEngine y cómo se relaciona con las operaciones de PDF en Java?

IronPdfEngine es un servidor gRPC que maneja operaciones de PDF como creación, edición y lectura. En Java, funciona como el backend de IronPDF, que actúa como una máscara de API sobre IronPdfEngine.

¿Cómo puedo renderizar HTML a PDF en Java usando IronPdfEngine?

Puedes usar la biblioteca IronPDF en Java para renderizar HTML en PDFs. El proceso involucra configurar IronPdfEngine y usar sus métodos, como RenderHtmlAsPdf, para convertir contenido HTML a formato PDF.

¿Por qué las operaciones de PDF en Java requieren compatibilidad de versión con IronPdfEngine?

La compatibilidad de versión es crucial ya que cada versión de IronPDF para Java está diseñada para trabajar con una versión específica de IronPdfEngine, asegurando operaciones fluidas y previniendo problemas de compatibilidad.

¿Cuáles son las ventajas de usar IronPdfEngine localmente en proyectos Java?

Usar IronPdfEngine localmente puede llevar a tiempos de inicio más rápidos y eliminar la necesidad de acceso a internet después de la instalación. Permite un procesamiento de PDF más eficiente directamente dentro de la aplicación Java.

¿Cómo configuro IronPdfEngine para su uso en un servidor remoto en Java?

Para configurar IronPdfEngine para uso remoto, establece el host y puerto del servidor usando los métodos setIronPdfEngineHost y setIronPdfEnginePort en tu aplicación Java, asegurando que el servidor sea accesible.

¿Qué debo considerar al decidir descargar binarios de IronPdfEngine en tiempo de ejecución?

Descargar binarios en tiempo de ejecución resulta en un paquete de aplicación más pequeño y flexibilidad en el despliegue multiplataforma. Sin embargo, requiere acceso a internet inicialmente y puede resultar en tiempos de inicio más lentos.

¿Puede utilizarse IronPdfEngine sin instalarlo como dependencia?

Sí, IronPdfEngine puede usarse sin instalación como dependencia descargando los binarios necesarios en tiempo de ejecución. Este enfoque es adecuado para entornos dinámicos donde el tamaño de la aplicación es una preocupación.

¿Cómo aseguro que mi biblioteca Java de PDF está usando la versión correcta de IronPdfEngine?

Puedes verificar la versión de IronPdfEngine requerida para tu biblioteca Java de PDF usando el método getIronPdfEngineVersion, asegurando compatibilidad y funcionalidad adecuada.

¿Cuáles son los pasos para instalar IronPdfEngine en un proyecto de Java?

Para instalar IronPdfEngine, incluye la biblioteca Java de IronPDF en tu proyecto, configura el host y puerto del servidor, y conéctate a IronPdfEngine usando los ajustes apropiados en el código de tu aplicación.

¿Es necesario tener acceso a internet al usar IronPdfEngine en Java?

El acceso a internet es necesario cuando se elige descargar binarios de IronPdfEngine en tiempo de ejecución. Sin embargo, si IronPdfEngine se instala como una dependencia, no se requiere acceso a internet después de la configuración inicial.

¿IronPDF es compatible con .NET 10 y qué beneficios aporta?

Sí. IronPDF es compatible con .NET 10 sin necesidad de soluciones alternativas, lo que proporciona un mejor rendimiento, mayor estabilidad en tiempo de ejecución y compatibilidad con las nuevas funciones del lenguaje. Funciona a la perfección con todas las versiones modernas de .NET, incluidas .NET 8, 9 y 10.

Curtis Chau
Curtis Chau
  Chatea con el equipo de ingeniería ahora
Escritor Técnico

Curtis Chau tiene una licenciatura en Ciencias de la Computación (Carleton University) y se especializa en el desarrollo front-end con experiencia en Node.js, TypeScript, JavaScript y React. Apasionado por crear interfaces de usuario intuitivas y estéticamente agradables, disfruta trabajando con frameworks modernos y creando manuales bien ...

Leer más
¿Listo para empezar?
Versión: 2025.11 recién lanzado