How Tos

The samples and documentation here should get you quickly up and running with the PDF Services SDK. These code examples illustrate how to perform PDF actions using the SDK, including:

Creating a PDF from multiple formats, including HTML, Microsoft Office documents, and text files
Exporting a PDF to other formats or an image
Combining entire PDFs or specified page ranges
Using OCR to make a PDF file searchable with a custom locale
Compress PDFs with compression level and Linearize PDFs
Protect PDFs with password(s) and Remove password protection from PDFs
Common page operations, including inserting, replacing, deleting, reordering, and rotating
Splitting PDFs into multiple files
Extract PDF as JSON: the content, structure & renditions of table and figure elements along with Character Bounding Boxes
Get the properties of a PDF file like page count, PDF version, file size, compliance levels, font info, permissions and more
Improving the accessibility of PDFs (Available under Early Access Program)

Service region configuration

Adobe PDF Services SDKs use US (United States) as a default region to process all the documents. Once you purchase PDF Services SDK, the SDKs can be configured to process the documents in a specified region that is listed below. Currently, PDF Services SDKs has support for the following regions :

Region Code	Name
`US`	United States (default)
`EU`	Europe

In addition to the details below, you can refer to working code samples:

Available properties:

region: Default: US. All documents will be processed in the specified region.

Override the region property via a custom ClientConfig class:

Java

.NET

Node.js

Python

ClientConfig clientConfig = ClientConfig.builder()
    .setRegion(Region.EU)
    .build();
Copied to your clipboard
1ClientConfig clientConfig = ClientConfig.builder()
2    .setRegion(Region.EU)
3    .build();

ClientConfig clientConfig = ClientConfig.ConfigBuilder()
    .SetRegion(Region.EU)
    .Build();
Copied to your clipboard
1ClientConfig clientConfig = ClientConfig.ConfigBuilder()
2    .SetRegion(Region.EU)
3    .Build();

const clientConfig = new ClientConfig({
    region: Region.EU
});
Copied to your clipboard
1const clientConfig = new ClientConfig({
2    region: Region.EU
3});

client_config = ClientConfig.builder()
    .with_region(Region.EU)
    .build()
Copied to your clipboard
1client_config = ClientConfig.builder()
2    .with_region(Region.EU)
3    .build()

Proxy Server Configuration

The Java and Node SDK enables connection to API calls through Proxy via Client Configurations. Also, it supports username and password based authentication for the proxy server. It allows the clients to use SDK within the network where all outgoing calls have to go through a proxy and are allowed only if allow-listed on the proxy. Please refer to the following sample for details.

Java

Java Proxy Server configuration

Available properties:

host: The proxy Server Hostname (DNS or IP Address)
scheme: Default: http. Scheme of the proxy server i.e. http or https.
port: Default: 80 for http, 443 for https. Port on which proxy server is listening.
username: Username for the authentication.
password: Password for the authentication.

Node.js

Node Proxy Server configuration

Available properties:

host: The proxy Server Hostname (DNS or IP Address)
scheme: Default: http. Scheme of the proxy server i.e. http or https.
port: Port on which proxy server is listening.
username: Username for the authentication.
password: Password for the authentication.

All these properties are wrapped within the proxyServerConfig object. Further, username and password is to be provided inside the nested object usernamePasswordCredentials.

Set the above properties using a custom ProxyServerConfig class, and use ClientConfig class to configure proxy server.

Sample showing proxy server configuration without authentication.

Java

Node.js

ProxyServerConfig proxyServerConfig = new ProxyServerConfig.Builder()
    .withHost("PROXY_HOSTNAME")
    .withProxyScheme(ProxyScheme.HTTPS)
    .withPort(443)
    .build();

ClientConfig clientConfig = ClientConfig.builder()
    .withConnectTimeout(10000)
    .withSocketTimeout(40000)
    .withProxyServerConfig(proxyServerConfig)
    .build();
Copied to your clipboard
1ProxyServerConfig proxyServerConfig = new ProxyServerConfig.Builder()
2    .withHost("PROXY_HOSTNAME")
3    .withProxyScheme(ProxyScheme.HTTPS)
4    .withPort(443)
5    .build();
6
7ClientConfig clientConfig = ClientConfig.builder()
8    .withConnectTimeout(10000)
9    .withSocketTimeout(40000)
10    .withProxyServerConfig(proxyServerConfig)
11    .build();

const proxyServerConfig = new ProxyServerConfig({
    host: "PROXY_HOSTNAME",
    port: 443,
    scheme: ProxyScheme.HTTP
});

const clientConfig = new ClientConfig({
    proxyServerConfig
});
Copied to your clipboard
1const proxyServerConfig = new ProxyServerConfig({
2    host: "PROXY_HOSTNAME",
3    port: 443,
4    scheme: ProxyScheme.HTTP
5});
6
7const clientConfig = new ClientConfig({
8    proxyServerConfig
9});

Sample showing proxy server configuration with authentication.

Java

Node.js

ProxyServerConfig proxyServerConfig = new ProxyServerConfig.Builder()
    .withHost("PROXY_HOSTNAME")
    .withProxyScheme(ProxyScheme.HTTPS)
    .withPort(443)
    .withCredentials(new UsernamePasswordCredentials("USERNAME", "PASSWORD"))
    .build();

ClientConfig clientConfig = ClientConfig.builder()
    .withConnectTimeout(10000)
    .withSocketTimeout(40000)
    .withProxyServerConfig(proxyServerConfig)
    .build();
Copied to your clipboard
1ProxyServerConfig proxyServerConfig = new ProxyServerConfig.Builder()
2    .withHost("PROXY_HOSTNAME")
3    .withProxyScheme(ProxyScheme.HTTPS)
4    .withPort(443)
5    .withCredentials(new UsernamePasswordCredentials("USERNAME", "PASSWORD"))
6    .build();
7
8ClientConfig clientConfig = ClientConfig.builder()
9    .withConnectTimeout(10000)
10    .withSocketTimeout(40000)
11    .withProxyServerConfig(proxyServerConfig)
12    .build();

const proxyServerConfig = new ProxyServerConfig({
    host: "PROXY_HOSTNAME",
    port: 443,
    scheme: ProxyScheme.HTTP,
    credentials: new UsernamePasswordCredentials({
        username: "USERNAME",
        password: "PASSWORD"
    })
});

const clientConfig = new ClientConfig({
    proxyServerConfig
});
Copied to your clipboard
1const proxyServerConfig = new ProxyServerConfig({
2    host: "PROXY_HOSTNAME",
3    port: 443,
4    scheme: ProxyScheme.HTTP,
5    credentials: new UsernamePasswordCredentials({
6        username: "USERNAME",
7        password: "PASSWORD"
8    })
9});
10
11const clientConfig = new ClientConfig({
12    proxyServerConfig
13});

Custom timeout configuration

The APIs use inferred timeout properties and provide defaults. However, the SDK supports custom timeouts for the API calls. You can tailor the timeout settings for your environment and network speed. In addition to the details below, you can refer to working code samples:

Java timeout configuration

Available properties:

connectTimeout: Default: 2000. The maximum allowed time in milliseconds for creating an initial HTTPS connection.
socketTimeout: Default: 10000. The maximum allowed time in milliseconds between two successive HTTP response packets.

Override the timeout properties via a custom ClientConfig class:

ClientConfig clientConfig = ClientConfig.builder()
    .withConnectTimeout(3000)
    .withSocketTimeout(20000)
    .build();
Copied to your clipboard
1ClientConfig clientConfig = ClientConfig.builder()
2    .withConnectTimeout(3000)
3    .withSocketTimeout(20000)
4    .build();

.NET timeout configuration

Available properties:

timeout: Default: 400000. The maximum allowed time in milliseconds for establishing a connection, sending a request, and getting a response.
readWriteTimeout: Default: 10000. The maximum allowed time in milliseconds to read or write data after connection is established.
processingTimeout: Default: 600000. The maximum allowed time in milliseconds for processing the documents. Any operation taking more time than the specified processingTimeout will result in an operation timeout exception.
- Note : It is advisable to set the processingTimeout to higher values for processing large files.

Override the timeout properties via a custom ClientConfig class:

ClientConfig clientConfig = ClientConfig.ConfigBuilder()
    .WithTimeout(40000)
    .WithReadWriteTimeout(10000)
    .WithProcessingTmeout(900000)
    .Build();
Copied to your clipboard
1ClientConfig clientConfig = ClientConfig.ConfigBuilder()
2    .WithTimeout(40000)
3    .WithReadWriteTimeout(10000)
4    .WithProcessingTmeout(900000)
5    .Build();

Node.js timeout configuration

Available properties:

timeout: Default: 10000. The maximum allowed time in milliseconds before the request times out. If the request takes longer than timeout, the request will be aborted.

Override the timeout properties via a custom ClientConfig class:

const clientConfig = new ClientConfig({
    timeout: 15000
})
Copied to your clipboard
1const clientConfig = new ClientConfig({
2    timeout: 15000
3})

Python timeout configuration

Available properties:

connectTimeout: Default: 4000. The number of milliseconds Requests will wait for the client to establish a connection to Server.
readTimeout: Default: 10000. The number of milliseconds the client will wait for the server to send a response.
processingTimeout: Default: 600000. The maximum allowed time in milliseconds for processing the documents. Any operation taking more time than the specified processingTimeout will result in an operation timeout exception.
- Note : It is advisable to set the processingTimeout to higher values for processing large files.

Override the timeout properties via a custom ClientConfig class:

client_config = ClientConfig.builder()
    .with_connect_timeout(10000)
    .with_read_timeout(40000)
    .with_processing_timeout(900000)
    .build()
Copied to your clipboard
1client_config = ClientConfig.builder()
2    .with_connect_timeout(10000)
3    .with_read_timeout(40000)
4    .with_processing_timeout(900000)
5    .build()