Organization of the Distribution

The distribution containing jadice server 5 is divided into the following sub-folders:

apache-activemq

This folder contains a distribution of the message broker Apache ActiveMQ. In the standard distribution this broker is used for the communication between clients and jadice server.

bin

All files necessary to launch jadice server are supplied in this folder. jadice server can be launched via command line (for example during development) or as system service.

client-lib

The jar files in this folder have to be added to the class path of the client application so that it can communicate with jadice server.

client-lib/apache-activemq

If the client application is supposed to communicate with jadice server via the standard JMS implementation ActiveMQ, the jar files in this folder have to be added to its class path.

client-lib/logging

This directory contains the libraries necessary to connect the logging system of the jadice server client API with other logging systems. The section the section called “Client Logging” describes this connection in detail.

documentation

Here you can find a copy of the documentation you are reading.

example/hotfolder

This directory contains an example application which performs a Hot Folder conversion. Any file which is placed in the directory C:\temp\hotfolder\input\ is transferred to jadice server and converted to pdf format. The resulting file is transferred back to the client and placed in its C:\temp\hotfolder\output\ directory. The required settings can be found in the configuration file configuration.properties.

example/servlet

This folder contains a web application archive (WAR) including a simple http servlet which demonstrates how jadice server can be integrated into a middle tier application to perform an on-the-fly conversion.

In order to launch the application, you need to deploy it in common servlet container and call DownloadServlet in the browser. Customarily you can then see a list of all files under C:\Temp. These files are analyzed and offered for download on request. In case a file is neither in pdf or tiff format nor plain text, it will be transferred to jadice server in order to be converted.

Some settings may be altered in the file WEB-INF/classes/DownloadServlet.properties within the war file.

example/viewer

Here you can find an adapted jadice viewer with sample commands, which demonstrates the potential interaction between the two products; see Chapter 2, Quick Start

Important

This distribution does not encompass a license for jadice viewer. Please contact us to obtain such a license.

javadoc/client-lib

This folder contains the javadoc documentation of the client's APIs in all jadice server modules in order to integrate jadice server in own applications.

javadoc/server-lib

This folder contains the javadoc documentation of jadice server's API, which serves to expand jadice server's range of functionalities; see the section called “Implementing Own Nodes / Workers”.

log

Under default settings jadice server files all log data into this directory.

msoffice-lib

This directory contains all libraries that are needed for the conversion via Microsoft Office.

libreoffice-lib

This directory contains all libraries that are needed for the conversion via LibreOffice.

server-config

This folder contains all configuration files of jadice server. The pre-defined settings allow you to launch jadice server directly on any common system. For advice on potential adaptations see Chapter 5, Installation and Configuration.

server-lib

This directory contains all libraries that are needed to operate jadice server. Any changes to this directory are carried out at your own risk and are therefore not our liability!

wrapper

This directory contains all configurations files that are necessary to launch jadice server from a system-dependent wrapper or as a system service.

documentation.html

Homepage of this documentation.

[jadice server Version 5.8.7.0: Documentation for Developers and Administrators. Published: 2021-04-15]