Setting_Api (com.ironsoftware:ironpdf 2024.3.1 API)

java.lang.Object
- com.ironsoftware.ironpdf.internal.staticapi.Setting_Api

public final class Setting_Api
extends Object

The type Setting api.

Field Summary

Fields
Modifier and Type	Field	Description
`static Path`	`chromeBrowserCachePath`
`static int`	`chromeBrowserLimit`
`static int`	`chromeGpuMode`
`static boolean`	`enableDebug`	The constant enableDebug.
`static String`	`IRON_PDF_ENGINE_VERSION`	The constant IRON_PDF_ENGINE_VERSION.
`static int`	`ironPdfEngineTimeout`
`static Path`	`ironPdfEngineWorkingDirectory`	Path to IronPdfEngine working directory.
`static String`	`licenseKey`	The constant licenseKey.
`static boolean`	`linuxAndDockerAutoConfig`
`static Path`	`logPath`	Path to IronPdfEngine log.
`static boolean`	`singleProcess`
`static String`	`subProcessHost`	The constant subProcessHost.
`static int`	`subProcessPort`	The constant subProcessPort.
`static Path`	`tempFolderPath`

Constructor Summary

Constructors
Constructor Description

Setting_Api()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static int`	`getDefaultPort()`	Find free port int.
`static String`	`getIronPdfEngineExecutableFileName()`
`static Path`	`getIronPdfEngineExecutablePath(Path workingDir)`	Gets custom iron pdf engine path.
`static String`	`getIronPdfEngineFolderName()`
`static String`	`getIronPdfEngineZipName()`
`static void`	`useIronPdfEngineDocker(int port)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- subProcessPort
```
public static int subProcessPort
```
  The constant subProcessPort.
- licenseKey
```
public static String licenseKey
```
  The constant licenseKey.
- enableDebug
```
public static boolean enableDebug
```
  The constant enableDebug.
- logPath
```
public static Path logPath
```
  Path to IronPdfEngine log.
- ironPdfEngineWorkingDirectory
```
public static Path ironPdfEngineWorkingDirectory
```
  Path to IronPdfEngine working directory. default is current directory. If IronPdfEngine binary does not exist, we will download automatically to this folder.
- subProcessHost
```
public static String subProcessHost
```
  The constant subProcessHost.
- tempFolderPath
```
public static Path tempFolderPath
```
- IRON_PDF_ENGINE_VERSION
```
public static final String IRON_PDF_ENGINE_VERSION
```
  The constant IRON_PDF_ENGINE_VERSION.
  
  See Also:
  
  Constant Field Values
- singleProcess
```
public static boolean singleProcess
```
- chromeBrowserLimit
```
public static int chromeBrowserLimit
```
- chromeBrowserCachePath
```
public static Path chromeBrowserCachePath
```
- chromeGpuMode
```
public static int chromeGpuMode
```
- linuxAndDockerAutoConfig
```
public static boolean linuxAndDockerAutoConfig
```
- ironPdfEngineTimeout
```
public static int ironPdfEngineTimeout
```

Constructor Detail
- Setting_Api
```
public Setting_Api()
```

Method Detail

getDefaultPort
```
public static int getDefaultPort()
```
Find free port int.

Returns:

the int

getIronPdfEngineFolderName

public static String getIronPdfEngineFolderName()

getIronPdfEngineZipName

public static String getIronPdfEngineZipName()

getIronPdfEngineExecutableFileName

public static String getIronPdfEngineExecutableFileName()

getIronPdfEngineExecutablePath
```
public static Path getIronPdfEngineExecutablePath(Path workingDir)
```
Gets custom iron pdf engine path.

Returns:

the custom iron pdf engine path

useIronPdfEngineDocker

public static void useIronPdfEngineDocker(int port)