Package com.ironsoftware.ironpdf

Class Settings

  • public final class Settings
extends Object
    Important global settings for configuration of IronPDF for Java

    • Constructor Detail

      • Settings

        public Settings()

    • Method Detail

      • getIronPdfEngineVersion

        public static String getIronPdfEngineVersion()
        Gets IronPDF engine version.
        Returns:
        The current IronPdfEngine version

      • isDebug

        public static boolean isDebug()
        Is debug boolean.
        Returns:
        true if debug mode is enabled.

      • setDebug

        public static void setDebug​(boolean isDebug)
        Enable or disable debug mode.

        ***Recommended to set before calling any IronPdf function.***

        Parameters:
        isDebug - the is debug enabled

      • getIronPdfEngineWorkingDirectory

        public static Path getIronPdfEngineWorkingDirectory()
        Gets path to IronPDF engine working directory. default is current directory. If IronPdfEngine binary does not exist, We will download automatically to this folder.
        Returns:
        custom IronPdfEngine folder.

      • setIronPdfEngineWorkingDirectory

        public static void setIronPdfEngineWorkingDirectory​(Path path)
                                             throws IOException
        Sets path to IronPDF engine working directory. default is current directory. If IronPdfEngine binary does not exist, We will download automatically to this folder.

        ***Recommended to set before calling any IronPdf function.***

        Parameters:
        path - the path
        Throws:
        IOException - the io exception

      • getLogPath

        public static Path getLogPath()
        Gets IronPDF engine log file path.
        Returns:
        the log file path

      • setLogPath

        public static void setLogPath​(Path path)
        Sets IronPDF engine log file path.

        ***Recommended to set before calling any IronPdf function.***

        Parameters:
        path - the log file path

      • setIronPdfEngineHost

        public static void setIronPdfEngineHost​(String host)
        Set IronPDF engine host.
        Parameters:
        host - the host

      • getIronPdfEngineHost

        public static String getIronPdfEngineHost()
        Get IronPDF engine host string.
        Returns:
        the host string

      • setIronPdfEnginePort

        public static void setIronPdfEnginePort​(int port)
        Set IronPdf engine port. Default port will pick automatically.
        Parameters:
        port - the port

      • getIronPdfEnginePort

        public static int getIronPdfEnginePort()
        Get IronPdf engine port int. Default port will pick automatically.
        Returns:
        the port int

      • setTempFolderPath

        public static void setTempFolderPath​(Path tempFolderPath)
        Set temp folder path.
        Parameters:
        tempFolderPath - the temp folder path

      • getTempFolderPath

        public static Path getTempFolderPath()
        Get temp folder path.
        Returns:
        the path

      • useIronPdfEngineDocker

        public static void useIronPdfEngineDocker()
        Use IronPDF engine docker. All PDF operation will happen on the connected IronPDF engine docker. This setting required IronPdfEngine is already up and running in docker. (with default port) License key need to set as a Docker environment.

        Get IronPDF engine docker @see official-ironpdfengine-docker}

      • useIronPdfEngineDocker

        public static void useIronPdfEngineDocker​(int port)
        Use IronPDF engine docker. All PDF operation will happen on the connected IronPDF engine docker. This setting required IronPdfEngine is already up and running in docker. (on the given port) License key need to set as a Docker environment.

        Get IronPDF engine docker @see official-ironpdfengine-docker}

        Parameters:
        port - Set the port for IronPdfEngineDocker to listen on