Package com.pdftools

Class Sdk

java.lang.Object

com.pdftools.internal.NativeBase

com.pdftools.internal.NativeObject

com.pdftools.Sdk

public class Sdk
extends NativeObject

SDK initialization and product information

Method Summary

Modifier and Type	Method	Description
static HttpClientHandler	getHttpClientHandler()	The default handler for communication to remote servers (Getter)
static java.lang.String	getProducerFullName()	The producer string that is set within the metadata of PDF output documents (Getter)
static java.net.URI	getProxy()	Proxy to use for all communication to remote servers (Getter)
static java.lang.String	getVersion()	The version of the SDK (Getter)
static void	initialize(java.lang.String license)	Initialize the product and the license key.
static void	initialize(java.lang.String license, java.lang.String producerSuffix)	Initialize the product and the license key.
static void	setProxy(java.net.URI value)	Proxy to use for all communication to remote servers (Setter)

Methods inherited from class com.pdftools.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

initialize

public static void initialize(java.lang.String license)
                       throws LicenseException,
                              UnknownFormatException,
                              CorruptException

Initialize the product and the license key.

Before calling any of the other functions of the SDK, a license key must be set by calling this method. For licensing questions, contact pdfsales@pdftools.com.

Parameters:

license - The license key. The format of the license key is "<4H,V1,PDFSDK,...>"

Throws:

UnknownFormatException - The format (version) of the license argument is unknown.

CorruptException - The license argument is not a correct license key.

LicenseException - The license argument can be read but the license check failed.

java.lang.IllegalArgumentException - if license is null

initialize

public static void initialize(java.lang.String license,
                              java.lang.String producerSuffix)
                       throws LicenseException,
                              UnknownFormatException,
                              CorruptException

Initialize the product and the license key.

Before calling any of the other functions of the SDK, a license key must be set by calling this method. For licensing questions, contact pdfsales@pdftools.com.

Parameters:

license - The license key. The format of the license key is "<4H,V1,PDFSDK,...>"

producerSuffix - If neither null nor empty, this string is appended to the producer string within metadata of PDF output documents (see getProducerFullName()).

Throws:

UnknownFormatException - The format (version) of the license argument is unknown.

CorruptException - The license argument is not a correct license key.

LicenseException - The license argument can be read but the license check failed.

java.lang.IllegalArgumentException - if license is null

getVersion

public static java.lang.String getVersion()

The version of the SDK (Getter)

getProducerFullName

public static java.lang.String getProducerFullName()

The producer string that is set within the metadata of PDF output documents (Getter)

The producer string depends on the license key and producer suffix set in initialize(java.lang.String).

getProxy

public static java.net.URI getProxy()

Proxy to use for all communication to remote servers (Getter)

The SDK can use a proxy for all HTTP and HTTPS communication.

The default is null, i.e. no proxy is used. Otherwise the property’s value must be a URI with the following elements:

http[s]://[\u2039user\u203a[:\u2039password\u203a]@]\u2039host\u203a[:\u2039port\u203a]

Where:

• http/https: Protocol for connection to proxy.
• \u2039user\u203a:\u2039password\u203a (optional): Credentials for connection to proxy (basic authorization).
• \u2039host\u203a: Hostname of proxy.
• \u2039port\u203a: Port for connection to proxy.

Example: "http://myproxy:8080"

For SSL/TLS connections, e.g. to a signature service, the proxy must allow the HTTP CONNECT request to the remote server.

setProxy

public static void setProxy(java.net.URI value)

Proxy to use for all communication to remote servers (Setter)

The SDK can use a proxy for all HTTP and HTTPS communication.

The default is null, i.e. no proxy is used. Otherwise the property’s value must be a URI with the following elements:

http[s]://[\u2039user\u203a[:\u2039password\u203a]@]\u2039host\u203a[:\u2039port\u203a]

Where:

• http/https: Protocol for connection to proxy.
• \u2039user\u203a:\u2039password\u203a (optional): Credentials for connection to proxy (basic authorization).
• \u2039host\u203a: Hostname of proxy.
• \u2039port\u203a: Port for connection to proxy.

Example: "http://myproxy:8080"

For SSL/TLS connections, e.g. to a signature service, the proxy must allow the HTTP CONNECT request to the remote server.

getHttpClientHandler

public static HttpClientHandler getHttpClientHandler()

The default handler for communication to remote servers (Getter)

This instance is used wherever there is no dedicated HTTP client handler parameter.