Java Interface

This interface allows Office Server Document Converter V10.0 to be invoked from Java programs. version 11 or later. See Java VM Issues.

The Java Interface uses JNI (Java Native Interface).

Library Files

The following library files are included in [Install directory] or [Install directory]/​lib.

Library file Contents Location
DfvJavaCtl.jarJava Archive [Install directory]/​lib
DfvJavaCtl.dllJava Interface Library for Windows [Install directory]
libDfvJavaCtl.soJava Interface Library for Linux [Install directory]/​lib

In order to execute the Java Interface, directory of execute java and [Install directory]/​lib/​DfvJavaCtl.jar must be included in the CLASSPATH environment variable. In addition, from using JNI (Java Native Interface), in Windows versions, [Install directory] must be included in the PATH environment variable. In the following environment, [Install directory]/​lib must be included. In Linux versions, it must be included in the LD_LIBRARY_PATH environment variable. See also Environment Variables and Symbolic Links for the necessary environment variables.

Windows versions:

> set CLASSPATH=[Install directory]/lib/DfvJavaCtl.jar;%CLASSPATH% > set PATH=[Install directory];%PATH%

Linux versions:

$ CLASSPATH=[Install directory]/lib/DfvJavaCtl.jar:${CLASSPATH} $ export CLASSPATH $ LD_LIBRARY_PATH=[Install directory]/lib:${LD_LIBRARY_PATH} $ export LD_LIBRARY_PATH

Java VM Issues

Java Interface is built using Eclipse Temurin JDK (Former AdoptOpenJDK) 11. Java runtime environments below Java 11 are not supported. Additionally using Java execution of an old version in the Linux environment could cause compatibility issues.

Using the interface in an application server

Since the native JNI library can be read by two or more Java VM class loaders, when using this interface in application servers, such as Tomcat, do not install the DfvJavaCtl.jar in the WEB-INF/lib of the Web application. Set the interface to be read by class loaders (system class loader etc.) which only load once.

Running the Sample Program

[Install directory]/​samples/​java includes some simple sample programs.

The following shows how to execute these sample programs. In this case [Install directory]/​samples/​java must be included in CLASSPATH.

> cd [Install directory]/samples/java > javac sample.java > java sample sample.fo sample.pdf

API Specification

See the Javadoc documentation.