PDFreactor SOAP Client API Documentation

Enables or disables attachments specified in style sheets.

The default value is false.

Enables or disables bookmarks in the PDF document.

Enables or disables comments in the PDF document.

The default value is false.

Enables or disables links in the PDF document.

The default value is false.

Enables or disables overprinting.

The default value is false.

Enables or disables embedding of image previews per page in the PDF document.

The default value is false.

Enables or disables tagging of the PDF document.

The default value is false.

Enables or disables the 'annotations' restriction in the PDF document.

The default value is false.

Enables or disables the 'assembly' restriction in the PDF document.

The default value is false.

Enables or disables the 'copy' restriction in the PDF document.

The default value is false.

Enables or disables the 'degraded printing' restriction in the PDF document.

The default value is false.

Enables or disables the 'fill in' restriction in the PDF document.

The default value is false.

Enables or disables the 'modify contents' restriction in the PDF document.

The default value is false.

Enables or disables the 'printing' restriction in the PDF document.

The default value is false.

Enables or disables the 'screen readers' restriction in the PDF document.

The default value is false.

Specifies whether or not the log data should be added to the PDF document.

The default value is false.

Adds a file attachment to PDF document.

Enables access to resources that are secured via Basic or Digest authentication.

Sets the value of the author field of the PDF document.

Sets the base URL of the document.

To resolve relative URLs to absolute URLs a reference (base) URL is required. This reference URL is usually the system id of the document.

This method can be used to specify another reference URL. If this URL is not null then it will be used instead of the system id.

The default value is null.

Convenience method to set pages-per-sheet properties and page order in one step to create a booklet.

Adds callbacks to the conversion which will be called at specific times. All callbacks perform a POST request to the specified URL with the specified content type and a certain model which depends on the callback event.

For each callback, you can specify a timeout. If no timeout is specified, the server's default timeout for callbacks is used. A value of zero or negative values indicate an infinite timeout, however the PDFreactor server may have a maximum timeout configured, in which case that will be the used value.

Some callbacks might be called regularly during the course of a conversion. For these callbacks you can specify an interval to control how frequently they are called.

Sets the cleanup tool to use for documents with unparsable content.

The Cleanup constants can be used as value. The default value specified is Cleanup.CYBERNEKO.

The cleanup tool is only used for Configuration.documentType Doctype.XHTML. HTML5 utilizes an internal cleanup.

Specifies color space related settings.

Sets the conformance of the PDF.

The Conformance constants can be used as value. The default value specified is Conformance.PDF.

Specifies parts of the document's content that should be observed and logged in greater detail. Data logged this way can be programmatically retrieved after the conversion has finished. The following can be observed:

• Content exceeding boundary containers.

  Use ExceedingContentAnalyze constants to specify which kind of content should be observed for exceeding content logging. The default value is ExceedingContentAnalyze.NONE.

  Use ExceedingContentAgainst constants to specify that exceeding this content starts exceeding content logging. The default value is ExceedingContentAgainst.NONE.

• Resources that could not be loaded.
• URL connection attempts made by PDFreactor.

Enables the conversion of the input document into one image.

Sets a name for the conversion. If a name is set, it will be logged at level "info". The name can be an arbitrary string but should be unique for every conversion or application so that the log output can be matched to a specific conversion or application later.

Adds a cookie to all outgoing HTTP connections. The parameters are URL encoded (see Configuration.rawCookies). If the key already exists, the pair is overwritten.

Sets the value of creator field of the PDF document.

Specifies the behavior of PDFreactor regarding the support and validation of CSS properties and their declaration. The following modes can be set:

• Do not validate at all, consider all declared style as valid. See CssPropertySupport.ALL
• Validate all declared styles for properties only supported by PDFreactor. Properties only supported by third party products are not supported/taken as invalid. See CssPropertySupport.HTML
• Validate all declared styles for properties supported by PDFreactor. Properties only supported by third party products are supported/taken as valid. See CssPropertySupport.HTML_THIRD_PARTY
• All properties supported by third party products are supported/taken as valid. All declared styles for properties not supported by third party products but supported by PDFreactor will be validated. See CssPropertySupport.HTML_THIRD_PARTY_LENIENT

Adds a custom property to the PDF document. An existing property of the same name will be replaced.

Enables and configures debug settings, which add additional information to the output.

If enabled, exceptions during the conversion will not be thrown. In such a case, instead of a document a string containing the log and exception will be returned.

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.colorSpaceSettings and ColorSpaceSettings.targetColorSpace instead.

Sets whether fonts will not be embedded into the resulting PDF. Setting this to true will reduce the file size of the output document. However, the resulting PDF documents are no longer guaranteed to look identical on all systems.

The default value is false.

The input document. This can either be a URL string, XML or HTML source code string.

Sets the language used for documents having no explicit language attribute set.

The language code is used to resolve the lang() selector correct and to determine the correct language used for hyphenation.

Sets the document type.

The Doctype constants can be used to specify the document type. The default value specified is Doctype.AUTODETECT.

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.debugSettings instead.

Sets the encoding of the document.

If this value is set to null or it is empty then the encoding will be detected automatically.

The default value is null.

Sets the encryption.

Use one of the Encryption constants to specify the encryption. The default value is Encryption.NONE.

Specifies error policies that will be used for the conversion. Depending on the policy, the conversion will fail if the appropriate criteria are not met.

Registers an alias font family for an existing font.

This function is limited to fonts loaded automatically from system folders.

Sets a list of fallback font families used for character substitution. This list is iterated for characters that can not be displayed with any of the fonts specified via the CSS property font-family.

Loads a font from a URL which can be used via the CSS property font-family.

If the output format is an image format, this setting controls whether a grayscale image should be returned. This can not be combined with transparency.

Enables or disables full compression of the PDF document.

The default value is false.

Sets the HTTPS mode. In closed environment lenient can be the preferred setting to avoid HTTPS issues that are not security critical

The default value specified is HttpsMode.STRICT.

Sets whether the alpha value of CSS RGBA colors is ignored. This can be used to avoid conformance issues in PDF/A-1.

Adds an integration style sheet to the document.

There are two ways to specify the style sheet:

1. Specifying the style sheet only using an URI.
2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.javaScriptSettings instead.

Specifies JavaScript related settings.

If set to true prevents the document from being deleted from the PDFreactor Web Service after it has been accessed. This only works for asynchronous conversions.

Sets the value of the keywords field of the PDF document.

Sets the license key using a string. If the license key is set to null then PDFreactor looks for a 'licensekey.xml' file in the same directory where the 'PDFreactor.jar' file is located. If no license key could be found then PDFreactor runs in evaluation mode.

The default value is null.

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.contentObserver instead.

Sets the log level.

Use one of the LogLevel constants to specify the log level.

The default value is LogLevel.NONE.

Defines the value of a Media Feature which is used to resolve CSS3 media queries.

Sets the media types that are used to resolve CSS3 media queries.

Please note that this overrides the default media types of PDFreactor, which are:

"print", "paged", "visual", "bitmap", "static", "-ro-pdfreactor"

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

This method sets external PDF documents which will be merged with the PDF document generated by the HTML source.

Sets the merge mode.

The following merge methods can be used:

• append (MergeMode.APPEND)
• prepend (MergeMode.PREPEND)
• overlay above the content of the generated PDF (MergeMode.OVERLAY)
• overlay below the content of the generated PDF (MergeMode.OVERLAY_BELOW)

The default value is MergeMode.APPEND.

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.mergeDocuments instead.

Sets the OutputFormat. The default value is OutputFormat.PDF.

For image formats the width or height in pixels must be specified.

When either dimension is <1 it is computed based on the other dimension and the aspect ratio of the input document.

Sets the output intent including the identifier and the ICC profile to be embedded into the PDF.

Set either the profile URL or the profile data, not both. Certain PDF/X formats require neither, just a known identifier.

If one of the documents of an overlay process is shorter than the other, this method allows repeating either its last page or all of its pages in order to overlay all pages of the longer document.

Use one of the OverlayRepeat constants to specify the overlay repeat. The default value is OverlayRepeat.NONE.

Sets the owner password of the PDF document.

The default value is null.

Sets the page order of the direct result of the conversion.

If Configuration.mergeMode is set to MergeMode.ARRANGE, this method is also used to specify the position of inserted pages from an existing PDF.

A description of the syntax can be found in the manual.

Sets the properties of a sheet on which multiple pages are being arranged.

If PagesPerSheetProperties.cols or PagesPerSheetProperties.rows is less than 1, no pages-per-sheet processing is done. This is the case by default.

Use one of the PagesPerSheetDirection constants to specify the the direction. The default value is PagesPerSheetDirection.RIGHT_DOWN.

Sets a pair of trigger event and PDF script. The script is triggered on the specified event.

A PDF script is JavaScript that is executed by a PDF viewer (e.g. Adobe Reader). Note that most viewers do not support this feature.

PDF Scripts can also be set by using the proprietary CSS property pdf-script-action. More information on this property can be found in the manual.

Please note, that scripts set via CSS have a higher priority. If two scripts are registered on the same event, but one via API and the other via the CSS property, the script set in the CSS will override the other one.

Sets the pixels per inch.

Changing this value changes the physical length of sizes specified in px (including those specified via HTML attributes).

The default value is 96 ppi.

Whether the pixels per inch should be adapted automatically to avoid content exceeding pages.

Sets the document type after the XSL-Transformations have been applied.

The Doctype constants can be used to specify the document type. The default value specified is Doctype.AUTODETECT.

Enables or disables a print dialog to be shown upon opening the generated PDF document by a PDF viewer.

The default value is false.

Preferences that influence the conversion process without changing the output.

Use the ProcessingPreferences constants to specify the processing preferences. By default no processing preference is set.

Allows to enable or disable behaviors that are otherwise depend on the doctype of the input document.

Adds a cookie to all outgoing HTTP connections. The parameters are not URL encoded (see Configuration.cookies). If the key already exists, the pair is overwritten.

Adds a request header to all outgoing HTTP connections. If the key already exists, the pair is overwritten.

Sets a timeout in milliseconds for connecting to resources, such as HTTP requests to style sheets, images etc. If the connection could not be established until the timeout expires, the request will be aborted and the resource will not be loaded.

A timeout of 0 means that the connection will not time out. A negative value means that no timeout will be set. The default value is 60000 (1min).

Sets a timeout in milliseconds for reading resources, such as HTTP requests to style sheets, images etc. If the download does not start until the timeout expires, the request will be aborted and the resource will not be loaded.

A timeout of 0 means that the download will not time out. A negative value means that no timeout will be set. The default value is 60000 (1min).

Deprecated

Deprecated as of PDFreactor 10. Use Configuration.resourceConnectTimeout and Configuration.resourceReadTimeout instead.

This property configures segmentation of the conversion, which helps with very large documents.

Sets a digital certificate to sign the newly created PDF.

Requires a keystore file. The included certificate may be self-signed.

Use the KeystoreType constants to specify the keystore type.

Use the SigningMode constants to specify the cryptographic filter that is used for signing.

Sets the value of the subject field of the PDF document.

Deprecated

Deprecated as of PDFreactor 9. Use Configuration.errorPolicies instead.

Sets the value of the title field of the PDF document.

Sets the user password of the PDF document.

The default value is null.

Adds an user script to the document.

There are two ways to specify the script:

1. Specifying the script only by an URI.
2. Specifying the script by the content of the script and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

Adds a user style sheet to the document.

There are two ways to specify the style sheet:

1. Specifying the style sheet only using an URI.
2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

Enables PDFreactor to validate the generated PDF against the Conformance specified via Configuration.conformance.

Currently only PDF/A validation is supported.

Please note that validation might take several minutes for larger documents.

Sets the page layout and page mode preferences of the PDF.

Use the ViewerPreferences constants to specify the viewer preferences. By default no viewer preference is set.

Sets custom XMP to be embedded into the PDF document.

If both Xmp.content and Xmp.uri are not set or null no custom XMP is embedded. If XmpPriority is also set to XmpPriority.HIGH automatic generation of required XMP is also suppressed. This may cause output PDFs to not archive a specified conformance.

Enables or disables XSLT transformations.

Set this value to true to enable XSLT transformations or to false to disable XSLT transformations.

The default value is false.

Adds an XSLT style sheet to the document.

There are two ways to specify the style sheet:

1. Specifying the style sheet only by an URI.
2. Specifying the style sheet by the content of the style sheet and alternatively setting a URI to resolve relative elements. If no URI is specified then the system id/base URL of the document will be used.

The binary content of the attachment. May be null.

The description of the attachment. If this is not set or null the value of Attachment.name is used.

The file name associated with the attachment. It is recommended to specify the correct file extension. If this is not set or null the name is derived from Attachment.url.

If Attachment.data is not set or set to null, the attachment will be retrieved from this URL.

If this is "#" the input document URL is used instead.

Whether or not the reading order of the booklet should be right-to-left.

The sheet margin as CSS margin value, for example "1in", "1cm 1.5cm" or "10mm 20mm 10mm 30mm". null is interpreted as "0mm".

The size of the sheet as CSS value, for example "A3", "letter landscape", "15in 20in" or "20cm 30cm".

The content type of the payload that is posted.

The interval in seconds at which to trigger repeating callbacks.

Only applies CallbackType.PROGRESS.

An optional timeout for the callback. A value of zero or negative values are treated as an infinite timeout.

The event to trigger the callback.

The URL to call back.

Specifies the ICC profile which defines the CMYK color space into or from which CSS colors and images are converted, if ColorSpaceSettings.conversionEnabled.

Enables the conversion of CSS colors and images to the ColorSpaceSettings.targetColorSpace using the ColorSpaceSettings.cmykIccProfileUrl or naively if there is none.

Specifies the target color-space of the PDF.

This is the color space, CSS keyword based colors are converted to, as well as, if ColorSpaceSettings.conversionEnabled, other CSS colors and images.

It also is the color space for PDF/A and PDF/X documents.

Defaults to ColorSpace.RGB RGB.

Whether the response was retrieved from a cache.

Whether a URL connection could be established by PDFreactor. If this is false, see Connection.error for details.

The duration in milliseconds how long this connection remained open.

The error message if the connection could not be established.

The request method used by the underlying HTTP request (like "GET", "POST", etc.) or null if this is not an HTTP connection or the connection could not be established.

The protocol of the URL connection.

The request headers.

Note: If a header has multiple values, there will be one KeyValuePair for each value with the header name as key.

The response headers.

Note: If a header has multiple values, there will be one KeyValuePair for each value with the header name as key.

The response code for HTTP connections or 0 for all other connections.

The response message for the response code or null if the response code is 0 or the message could not be determined.

The time stamp of this connection.

The URL.

Enables observation of URL connections done by PDFreactor.

Enables observation of exceeding content either against the page edges, page content areas or containers.

Enables observation of exceeding content and optionally of boxes.

Enables observation of resources that could not be loaded.

Equivalent to the height of a browser window (view port). For values <1 the entire height of the document is used.

Equivalent to the width of a browser window (view port). Values <1 enable paginated output.

Adjusts the CSS property support behavior.

Adjusts the CSS property validation behavior.

This is a convenience property that enables the following DebugSettings:

• DebugSettings.attachDocuments,
• DebugSettings.attachResources,
• DebugSettings.attachLogs,
• DebugSettings.appendLogs,
• DebugSettings.forceResult

Specifies whether the logs will be appended to the resulting PDF.

Specifies whether all debug files belonging to the group "documents" will be attached to the generated PDF. Please see the manual for more information.

Specifies whether all debug files belonging to the group "logs" will be attached to the generated PDF. Please see the manual for more information.

Specifies whether all debug files belonging to the group "resources" will be attached to the generated PDF. Please see the manual for more information.

Forces PDFreactor to return a result, regardless of any exceptions or errors that may have occurred during the conversion.

If an exception or error occurred during the conversion, its stack trace and the PDFreactor log is written as-is into the result data stream. This means that the resulting document will not be a valid PDF but can be opened with an appropriate text editor to view the log and errors.

Returns whether the content exceeds the page at the bottom.

Returns whether the exceeding content is a box instead of text or image content.

Returns the bottom coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

Returns the left coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

Returns the right coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

Returns the top coordinate of the the container box in the page in pixels. Depending on the settings this box may be the page.

Returns a description of the content. In case of text content, the text is returned. In case of images the URL is returned if available.

Returns the bottom coordinate of the the exceeding box in the page in pixels.

Returns the left coordinate of the the exceeding box in the page in pixels.

Returns the right coordinate of the the exceeding box in the page in pixels.

Returns the top coordinate of the the exceeding box in the page in pixels.

Returns the HTML of the box that contains the exceeding content.

Returns whether the content exceeds the page to the left.

Returns the bottom coordinate of the the page in pixels.

Returns the left coordinate of the the page in pixels.

Returns the number of the page that contains the exceeding content.

Returns the right coordinate of the the page in pixels.

Returns the top coordinate of the the page in pixels.

Returns an array of integers denoting the indexes of the ancestors of the DOM node corresponding to the box containing the exceeding content, starting from below the root node down to the element itself.

Returns whether the content exceeds the page to the right.

Returns a summary of this exceeding content object.

Returns whether the content exceeds the page at the top.

Whether the alias will be labeled bold.

The alias name for that font.

Whether the alias will be labeled italic.

The source URL of the font (when adding new fonts) or the name of an existing font family (when creating an alias).

Specifies the amount of spaces per indentation level when using JavaScript debugging.

The default value is 0.

Specifies the debug mode.

Any other value than the default JavaScriptDebugMode.NONE impacts performance significantly and should not be used in production.

Specifies whether to process JavaScript.

Specifies whether to ignore <script> elements in the document, only executing user scripts.

Specifies the maximum amount of tasks to be queued before ending JavaScript processing.

Values smaller than 1 default to 1,000,000.

Specifies the maximum amount of script elements in the document to process.

Values smaller than 1 default to 1,000,000.

Specifies the maximum amount of tasks to be allowed to be queued, while the DOM does not change, before ending JavaScript processing.

Values smaller than 1 default to 1,000.

Specifies the maximum amount of virtual time in seconds to let pass before ending JavaScript processing.

Values smaller than 1 default to 3600 (1h).

Specifies whether to process JavaScript without causing document layouts or updates.

This can speed up conversions, but will break a significant amount of functionality and libraries.

Specifies whether not to use virtual time for JavaScript.

Only use if required for a specific library.

Specifies whether to fast-forward the virtual time of JavaScript every time it is retrieved.

Only use if required for a specific library.

The key.

The value.

Enables logging of exceeding content either against the page edges, page content areas or containers.

Enables logging of exceeding content and optionally of boxes.

The media feature.

The value that is associated with the given media feature.

The message indicating why the resource could not be found.

The resource identifier. Usually a URL string.

The type of resource (style sheet, image, etc.).

The height of the output in pixels (image formats only). Values <1 will be computed based on the specified width and the aspect ratio of the input document.

Indicates whether the image output will be paginated into multiple images.

The output format. See OutputType constants.

The with of the output in pixels (image formats only). Values <1 will be computed based on the specified height and the aspect ratio of the input document.

The profile data.

The identifier.

The profile URL.

The number of columns per sheet.

The direction in which the pages are ordered on a sheet.

The number of rows per sheet.

The sheet margin as CSS margin, for example "1in", "1cm 1.5cm" or "10mm 20mm 10mm 30mm". null is interpreted as "0mm".

The sheet size as CSS size, for example "A4", "letter landscape", "15in 20in" or "20cm 30cm".

The horizontal and vertical space between pages on a sheet as CSS value, for example "0.1in" or "5mm 2mm". null is interpreted as "0mm".

The script source that should be executed.

The event on which the script is executed. Value is a PdfScriptTriggerEvent constant.

By default in HTML CSS class selectors are case sensitive.

In the default QuirksMode.DETECT mode this behavior is disabled for old HTML doctypes or when there is no doctype.

To enable or disable it independently of the document this property can be set to QuirksMode.STANDARDS or QuirksMode.QUIRKS respectively.

By default the line-height of text containers, e.g. paragraph elements, is used as the minimum line-height of their lines.

In the default QuirksMode.DETECT mode this behavior is disabled for old HTML doctypes or when there is no doctype.

To enable or disable it independently of the document this property can be set to QuirksMode.STANDARDS or QuirksMode.QUIRKS respectively.

Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.

Only supported for JavaScript-type resources.

The content of the resource. Only supported for Style Sheet- and Script-type resources.

The binary data of the resource.

The URI of the resource.

Provides a log about all URL connections attempted by PDFreactor, including information about HTTP request and result, should the connection be an HTTP or HTTPS connection. Depends on the mode set via Configuration.contentObserver.

The resulting PDF or image.

This is not present if only the document's metadata was retrieved.

The resulting image as a collection of separate images, each representing a single page. This property is only present if the configuration option "multiImage" was set to true.

This is also not present if only the document's metadata was retrieved.

The date and time when the conversion was finished on the server.

Returns the error messages that might have been generated during rendering.

Provides information about content exceeding its page or parent. Depends on the mode set via "logExceedingContents".

Returns data that has been exported from document JavaScript via ro.exports if set, null otherwise. If the JavaScript data is not a string, it will be converted to JSON. If the data can't be converted, a generic string representation is used or null if none is available.

Indicates whether or not the keepDocument property was set in the Configuration of this conversion. If true, additional requests can be made to retrieve this document.

Returns the log messages generated during rendering based on the log level.

Provides information about resources that could not be loaded during the conversion. Depends on the mode set via Configuration.contentObserver.

Returns the number of pages of the document after conversion.

Returns the number of pages of the resulting PDF (including, e.g., merge operations), otherwise it will return the number pages of the laid out input document.

Use true to cause PDFreactor to run the script before all scripts inside the document and false to run it after.

Only supported for JavaScript-type resources.

The content of the resource. Only supported for Style Sheet- and Script-type resources.

The binary data of the resource.

The URI of the resource.

Enables or disables segmentation.

The preferred size (in number of pages) of the segments into which the conversion will be split.

Valid values range from 10 to 1000. Values smaller than 1 default to 1000.

The alias of the certificate included in the keystore to be used to sign the PDF.

The password for the certificate included in the keystore to be used to sign the PDF.

If none is provided, the keystore password will be used for the certificate.

The password of the keystore.

The format of the keystore, for example PKCS #12 or JKS. Use one of the KeystoreType constants as value.

The URL to the keystore file.

The cryptographic filter mode that is used to sign the PDF, like SELF_SIGNED, VERISIGN_SIGNED or WINCER_SIGNED.

Use one of the SigningMode constants as value.

XMP, as an XML string, to be embedded into the PDF document.

Priority of this XMP over XMP generated automatically for the conformance requirements of certain output formats.

URI to XMP to be embedded into the PDF document, if Xmp.content is not set or null.