Part I, Chapter 2, Section 1. Server parameters

1. Server parameters

The following server parameters allow to fine tune the behavior of XMLmind XML Server. They are declared in xslsrv/WEB-INF/web.xml (xslsrv/ being the unpacked xslsrv.war).

Important

Configuring XMLmind XML Server always involves modifying files found in xslsrv.war. This implies unpacking⁽¹⁾ xslsrv.war, modifying some configuration files and then repacking xslsrv.war. Fortunately, this is generally done once for all.

authorization1

A passphrase which must be passed by the client along all convert requests ("convert", "poll", "cancel", "result", "config").

Note that this feature is orthogonal to the user authentication. However it is seldom needed when user authentication has been turned on.

Default: none. Convert requests are honored without having to pass any authorization.

authorization2

A passphrase which must be passed by the client along all administration requests ("jobs", "clear").

Note that this feature is orthogonal to the user authentication. However it is seldom needed when user authentication has been turned on.

Default: none. Administration requests are honored without having to pass any authorization.

cacheSize

Number of job results (that is, PDF, RTF, .docx, etc, files created by XMLmind XSL Server) to be cached.

Note that the result of converting an uploaded file is never cached. Only the result of converting an URL can be cached.

Value: Strictly positive integer.

Default: 100.

credentials

Accessing some URLs to be converted request user authentication. This parameter specify such user credentials.

Value: Zero or more prompt/username/password triplets separated by whitespace.

A "*" prompt matches any prompt. Fields containing whitespace must be quoted using single or double quotes. Example: "'Document Repository' john foo * admin "bar gee"".

Default: none. User credentials are not needed to access the URLs to be converted.

customizeDir

This directory is intended to contain one or more of the following specifications:

Customizations of the stock conversion specifications of XMLmind XSL Server.
User-defined conversion specifications.
Apache FOP font specifications (e.g. map "sans-serif" to "Verdana").
The locations of helper applications such as the HTMLHelp compiler (i.e. "hhc.exe").

This directory has the same layout and contents as the user preferences directory of XMLmind XSL Utility

In fact, XMLmind XSL Server and XMLmind XSL Utility can share the same user preferences directory:

$HOME/.xfc/ on Linux.
$HOME/Library/Application Support/XMLmind/FOConverter/ on the Mac.
%APPDATA%\XMLmind\FOConverter\ on Windows. Example: C:\Users\joe\AppData\Roaming\XMLmind\FOConverter\.

XMLmind XSL Server can use its own customization directory initialized and modified using XMLmind XSL Utility. In order to do this, you'll have to run "xslutil -p customizeDir".

No need to stop and restart XMLmind XSL Server when the contents of the customizeDir directory has been modified.

Value: this directory and its contents must be readable by the operating system account used to run XMLmind XSL Server.

Default: none. You are limited to using the stock conversion specifications as is.

keepTimeWhenDone

After the end of a successful conversion job, keep the job result available to the client for at least this number of seconds.

Value: Strictly positive integer. Unit: second.

Default: 300 (5 minutes).

keepTimeWhenFailed

After the end of a failed conversion job, keep the job status available to the client for at least this number of seconds.

Value: Strictly positive integer. Unit: second.

Default: 60 (1 minute).

maxConversions

The maximum number of concurrent conversions. Requested conversions beyond that number are queued, that is, they are not discarded.

Value: an integer between 1 and 1000 inclusive.

Default: 20.

mimeTypesFile

A plain text file associating a MIME type to one or more filename extensions.

The format is similar to the one used by Apache httpd

file -> line*
line -> OPEN_LINE | COMMENT_LINE | spec_line
spec_line -> mime_type (SPACE extension)*

Example:

# This is a comment line.
application/x-dbm
application/rtf rtf 
application/x-compressed-tar tar.gz tgz

Value: this file must be readable by the operating system account used to run XMLmind XSL Server.

Default: the "mime.types" file found in xslsrv.war.

urlPrefixes

Restrict the use of XMLmind XSL Server to converting URLs starting with specified prefixes.

When this parameter has been specified, converting uploaded files is not allowed.

Value: zero or more regular expression patterns matching URL prefixes, separated by whitespace. URL prefixes must be properly escaped (e.g. they cannot contain whitespace).

Example 1: "http(s)?://www\.acme\.com/".

Example 2: "file:/usr/local/httpd/xmlmind/ file:/tmp/".

Default: none. Allow converting any URL and also allow converting uploaded files.

validateHTTPS

In some cases, the documents to be converted are served by an HTTPS server. If false, do not check the validity of the certicate presented by an HTTPS server. This useful to cope with self-signed certificates.

Value: true or false.

Default: true.

workDir

Uploaded files and conversion results are stored in subdirectories of this directory.

If specified directory does not exist, it will be created.

Value: this directory and its contents must be readable and writable by the operating system account used to run XMLmind XSL Server.

Default: dynamic; supplied by the Servlet Container.

maxRequestSize (support of "multipart/form-data" requests)

The maximum size allowed for "multipart/form-data" requests.

Value: an integer byte count between 1048576 (1Mb) and 2147483647, inclusive.

Default: 20971520 (20Mb).

maxFileSize (support of "multipart/form-data" requests)

The maximum size allowed for uploaded files.

Value: an integer byte count between 524288 (512Kb) and 2147483647, inclusive.

Default: 10485760 (10Mb).

fileSizeThreshold (support of "multipart/form-data" requests)

The size threshold after which the file will be written to disk.

Value: an integer byte count between 256 and 2147483647, inclusive.

Default: 16384.

idXSLTParameterName

Regular expression matching XSLT parameter names specifying which XSLT parameters are to be checked by XMLmind XSL Server as having values containing syntactically correct XML or HTML IDs. Such XSLT parameters may be found in some conversion specifications. Example of such XSLT parameter: root-id=xmncontents.

Default: "", that is, no such XSLT parameter names. However, the sample web.xml file contained in shipped xslsrv.war specifies "root\-?id" because XSLT parameter "rootid" is implemented by the DocBook XSL Stylesheets and XSLT parameter "root-id" is implemented by the XHTML XSL Stylesheets.