Quickstart for Adobe PDF Electronic Seal API (Java)

To get started using Adobe PDF Electronic Seal API, let's walk through a simple scenario - Applying an electronic seal on an invoice PDF document. In this guide, we will walk you through the complete process for creating a program that will accomplish this task.

Prerequisites

To complete this guide, you will need:

• Java - Java 11 or higher is required.
• Maven
• An Adobe ID. If you do not have one, the credential setup will walk you through creating one.
• A way to edit code. No specific editor is required for this guide.

Step One: Getting credentials

1) To begin, open your browser to https://acrobatservices.adobe.com/dc-integration-creation-app-cdn/main.html?api=pdf-services-api. If you are not already logged in to Adobe.com, you will need to sign in or create a new user. Using a personal email account is recommended and not a federated ID.

2) After registering or logging in, you will then be asked to name your new credentials. Use the name, "New Project".

3) Change the "Choose language" setting to "Java".

4) Also note the checkbox by, "Create personalized code sample." This will include a large set of samples along with your credentials. These can be helpful for learning more later.

5) Click the checkbox saying you agree to the developer terms and then click "Create credentials."

6) After your credentials are created, they are automatically downloaded:

Step Two: Setting up the project

1) In your Downloads folder, find the ZIP file with your credentials: PDFServicesSDK-JavaSamples.zip. If you unzip that archive, you will find a folder of samples and the pdfservices-api-credentials.json file.

2) Take the pdfservices-api-credentials.json and place it in a new directory.

3) In this directory, create a new file named pom.xml and copy the following content:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.adobe.documentservices</groupId>
  <artifactId>pdfservices-sdk-electronicseal-guide</artifactId>
  <version>1</version>

  <name>PDF Services Java SDK Samples</name>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>11</maven.compiler.source>
    <maven.compiler.target>11</maven.compiler.target>
    <pdfservices.sdk.version>4.0.0</pdfservices.sdk.version>
  </properties>

  <dependencies>

    <dependency>
      <groupId>com.adobe.documentservices</groupId>
      <artifactId>pdfservices-sdk</artifactId>
      <version>${pdfservices.sdk.version}</version>
    </dependency>

    <!--        log4j2 dependency to showcase the use of log4j2 with slf4j API-->
    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-slf4j-impl</artifactId>
      <version>2.21.1</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.0</version>
        <configuration>
          <source>${maven.compiler.source}</source>
          <target>${maven.compiler.target}</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>1.5.0</version>
        <executions>
          <execution>
            <goals>
              <goal>java</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>
CopyCopied to your clipboard
1<?xml version="1.0" encoding="UTF-8"?>
2
3<project xmlns="http://maven.apache.org/POM/4.0.0"
4         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
6  <modelVersion>4.0.0</modelVersion>
7
8  <groupId>com.adobe.documentservices</groupId>
9  <artifactId>pdfservices-sdk-electronicseal-guide</artifactId>
10  <version>1</version>
11
12  <name>PDF Services Java SDK Samples</name>
13
14  <properties>
15    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
16    <maven.compiler.source>11</maven.compiler.source>
17    <maven.compiler.target>11</maven.compiler.target>
18    <pdfservices.sdk.version>4.0.0</pdfservices.sdk.version>
19  </properties>
20
21  <dependencies>
22
23    <dependency>
24      <groupId>com.adobe.documentservices</groupId>
25      <artifactId>pdfservices-sdk</artifactId>
26      <version>${pdfservices.sdk.version}</version>
27    </dependency>
28
29    <!--        log4j2 dependency to showcase the use of log4j2 with slf4j API-->
30    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->
31    <dependency>
32      <groupId>org.apache.logging.log4j</groupId>
33      <artifactId>log4j-slf4j-impl</artifactId>
34      <version>2.21.1</version>
35    </dependency>
36  </dependencies>
37
38  <build>
39    <plugins>
40      <plugin>
41        <groupId>org.apache.maven.plugins</groupId>
42        <artifactId>maven-compiler-plugin</artifactId>
43        <version>3.8.0</version>
44        <configuration>
45          <source>${maven.compiler.source}</source>
46          <target>${maven.compiler.target}</target>
47        </configuration>
48      </plugin>
49      <plugin>
50        <groupId>org.codehaus.mojo</groupId>
51        <artifactId>exec-maven-plugin</artifactId>
52        <version>1.5.0</version>
53        <executions>
54          <execution>
55            <goals>
56              <goal>java</goal>
57            </goals>
58          </execution>
59        </executions>
60      </plugin>
61    </plugins>
62  </build>
63</project>

This file will define what dependencies we need and how the application will be built.

Our application will take an Invoice PDF document, sampleInvoice.pdf (downloadable from here), and will use the sealing options with default appearance options to apply electronic seal over the PDF document by invoking Acrobat Services API and generate an electronically sealed PDF.

4) In your editor, open the directory where you previously copied the credentials, and create a new directory, src/main/java. In that directory, create ElectronicSeal.java.

Now you're ready to begin coding.

Step Three: Creating the application

1) We will begin by including the required dependencies:

import com.adobe.pdfservices.operation.PDFServices;
import com.adobe.pdfservices.operation.PDFServicesMediaType;
import com.adobe.pdfservices.operation.PDFServicesResponse;
import com.adobe.pdfservices.operation.auth.Credentials;
import com.adobe.pdfservices.operation.auth.ServicePrincipalCredentials;
import com.adobe.pdfservices.operation.exception.SDKException;
import com.adobe.pdfservices.operation.exception.ServiceApiException;
import com.adobe.pdfservices.operation.exception.ServiceUsageException;
import com.adobe.pdfservices.operation.io.Asset;
import com.adobe.pdfservices.operation.io.StreamAsset;
import com.adobe.pdfservices.operation.pdfjobs.jobs.PDFElectronicSealJob;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceItem;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceOptions;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CSCAuthContext;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CertificateCredentials;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldLocation;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldOptions;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.PDFElectronicSealParams;
import com.adobe.pdfservices.operation.pdfjobs.result.PDFElectronicSealResult;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
CopyCopied to your clipboard
1import com.adobe.pdfservices.operation.PDFServices;
2import com.adobe.pdfservices.operation.PDFServicesMediaType;
3import com.adobe.pdfservices.operation.PDFServicesResponse;
4import com.adobe.pdfservices.operation.auth.Credentials;
5import com.adobe.pdfservices.operation.auth.ServicePrincipalCredentials;
6import com.adobe.pdfservices.operation.exception.SDKException;
7import com.adobe.pdfservices.operation.exception.ServiceApiException;
8import com.adobe.pdfservices.operation.exception.ServiceUsageException;
9import com.adobe.pdfservices.operation.io.Asset;
10import com.adobe.pdfservices.operation.io.StreamAsset;
11import com.adobe.pdfservices.operation.pdfjobs.jobs.PDFElectronicSealJob;
12import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceItem;
13import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceOptions;
14import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CSCAuthContext;
15import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CertificateCredentials;
16import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldLocation;
17import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldOptions;
18import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.PDFElectronicSealParams;
19import com.adobe.pdfservices.operation.pdfjobs.result.PDFElectronicSealResult;
20import org.apache.commons.io.IOUtils;
21import org.slf4j.Logger;
22import org.slf4j.LoggerFactory;
23
24import java.io.File;
25import java.io.IOException;
26import java.io.InputStream;
27import java.io.OutputStream;
28import java.nio.file.Files;
29import java.nio.file.Paths;

2) Now let's define our main class:

public class ElectronicSeal {

    // Initialize the logger.
    private static final Logger LOGGER = LoggerFactory.getLogger(ElectronicSeal.class);

    public static void main(String[] args) {

    }
}
CopyCopied to your clipboard
1public class ElectronicSeal {
2
3    // Initialize the logger.
4    private static final Logger LOGGER = LoggerFactory.getLogger(ElectronicSeal.class);
5
6    public static void main(String[] args) {
7
8    }
9}

3) Set the environment variables PDF_SERVICES_CLIENT_ID and PDF_SERVICES_CLIENT_SECRET by running the following commands and replacing placeholders YOUR CLIENT ID and YOUR CLIENT SECRET with the credentials present in pdfservices-api-credentials.json file:

• Windows:

  • set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>
  • set PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>

• MacOS/Linux:

  • export PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>
  • export PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>

4) Next, we can create our credentials and PDFServices instance:

// Initial setup, create credentials instance
Credentials credentials = new ServicePrincipalCredentials(
        System.getenv("PDF_SERVICES_CLIENT_ID"),
        System.getenv("PDF_SERVICES_CLIENT_SECRET"));

// Creates a PDF Services instance
PDFServices pdfServices = new PDFServices(credentials);
CopyCopied to your clipboard
1// Initial setup, create credentials instance
2Credentials credentials = new ServicePrincipalCredentials(
3        System.getenv("PDF_SERVICES_CLIENT_ID"),
4        System.getenv("PDF_SERVICES_CLIENT_SECRET"));
5
6// Creates a PDF Services instance
7PDFServices pdfServices = new PDFServices(credentials);

5) Now, let's upload the asset:

// Create assets from source files and upload
Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
Asset sealImageAsset = pdfServices.upload(inputStreamSealImage, PDFServicesMediaType.PNG.getMediaType());
CopyCopied to your clipboard
1// Create assets from source files and upload
2Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
3Asset sealImageAsset = pdfServices.upload(inputStreamSealImage, PDFServicesMediaType.PNG.getMediaType());

6) Now, we will define the document level permission:

// Set the document level permission to be applied for output document
DocumentLevelPermission documentLevelPermission = DocumentLevelPermission.FORM_FILLING;
CopyCopied to your clipboard
1// Set the document level permission to be applied for output document
2DocumentLevelPermission documentLevelPermission = DocumentLevelPermission.FORM_FILLING;

7) Now, we will define seal field options:

// Create AppearanceOptions and add the required signature display items to it
AppearanceOptions appearanceOptions = new AppearanceOptions();
appearanceOptions.addItem(AppearanceItem.NAME);
appearanceOptions.addItem(AppearanceItem.LABELS);
appearanceOptions.addItem(AppearanceItem.DATE);
appearanceOptions.addItem(AppearanceItem.SEAL_IMAGE);
appearanceOptions.addItem(AppearanceItem.DISTINGUISHED_NAME);

// Sets the Seal Field Name to be created in input PDF document.
String sealFieldName = "Signature1";

// Sets the page number in input document for applying seal.
Integer sealPageNumber = 1;

// Sets if seal should be visible or invisible.
Boolean sealVisible = true;

// Creates FieldLocation instance and set the coordinates for applying signature
FieldLocation fieldLocation = new FieldLocation(150, 250, 350, 200);

// Create FieldOptions instance with required details.
FieldOptions fieldOptions = new FieldOptions.Builder(sealFieldName)
        .setFieldLocation(fieldLocation)
        .setPageNumber(sealPageNumber)
        .setVisible(sealVisible)
        .build();
CopyCopied to your clipboard
1// Create AppearanceOptions and add the required signature display items to it
2AppearanceOptions appearanceOptions = new AppearanceOptions();
3appearanceOptions.addItem(AppearanceItem.NAME);
4appearanceOptions.addItem(AppearanceItem.LABELS);
5appearanceOptions.addItem(AppearanceItem.DATE);
6appearanceOptions.addItem(AppearanceItem.SEAL_IMAGE);
7appearanceOptions.addItem(AppearanceItem.DISTINGUISHED_NAME);
8
9// Sets the Seal Field Name to be created in input PDF document.
10String sealFieldName = "Signature1";
11
12// Sets the page number in input document for applying seal.
13Integer sealPageNumber = 1;
14
15// Sets if seal should be visible or invisible.
16Boolean sealVisible = true;
17
18// Creates FieldLocation instance and set the coordinates for applying signature
19FieldLocation fieldLocation = new FieldLocation(150, 250, 350, 200);
20
21// Create FieldOptions instance with required details.
22FieldOptions fieldOptions = new FieldOptions.Builder(sealFieldName)
23        .setFieldLocation(fieldLocation)
24        .setPageNumber(sealPageNumber)
25        .setVisible(sealVisible)
26        .build();

8) Next, we create a CSC Certificate Credentials instance:

// Sets the name of TSP Provider being used.
String providerName = "<PROVIDER_NAME>";

// Sets the access token to be used to access TSP provider hosted APIs.
String accessToken = "<ACCESS_TOKEN>";

// Sets the credential ID.
String credentialID = "<CREDENTIAL_ID>";

// Sets the PIN generated while creating credentials.
String pin = "<PIN>";

// Creates CSCAuthContext instance using access token and token type.
CSCAuthContext cscAuthContext = new CSCAuthContext(accessToken, "Bearer");

// Create CertificateCredentials instance with required certificate details.
CertificateCredentials certificateCredentials = CertificateCredentials.cscCredentialBuilder()
        .withProviderName(providerName)
        .withCredentialID(credentialID)
        .withPin(pin)
        .withCSCAuthContext(cscAuthContext)
        .build();
CopyCopied to your clipboard
1// Sets the name of TSP Provider being used.
2String providerName = "<PROVIDER_NAME>";
3
4// Sets the access token to be used to access TSP provider hosted APIs.
5String accessToken = "<ACCESS_TOKEN>";
6
7// Sets the credential ID.
8String credentialID = "<CREDENTIAL_ID>";
9
10// Sets the PIN generated while creating credentials.
11String pin = "<PIN>";
12
13// Creates CSCAuthContext instance using access token and token type.
14CSCAuthContext cscAuthContext = new CSCAuthContext(accessToken, "Bearer");
15
16// Create CertificateCredentials instance with required certificate details.
17CertificateCredentials certificateCredentials = CertificateCredentials.cscCredentialBuilder()
18        .withProviderName(providerName)
19        .withCredentialID(credentialID)
20        .withPin(pin)
21        .withCSCAuthContext(cscAuthContext)
22        .build();

9) Now, let's create the job with seal parameters using certificate credentials and field options and set the seal image asset:

// Create parameters for the job
PDFElectronicSealParams pdfElectronicSealParams = PDFElectronicSealParams
        .pdfElectronicSealParamsBuilder(certificateCredentials, fieldOptions)
        .withAppearanceOptions(appearanceOptions)
        .build();

// Creates a new job instance
PDFElectronicSealJob pdfElectronicSealJob = new PDFElectronicSealJob(asset, pdfElectronicSealParams);

// Sets the optional input seal image for PDFElectronicSealOperation instance
pdfElectronicSealJob.setSealImageAsset(sealImageAsset);
CopyCopied to your clipboard
1// Create parameters for the job
2PDFElectronicSealParams pdfElectronicSealParams = PDFElectronicSealParams
3        .pdfElectronicSealParamsBuilder(certificateCredentials, fieldOptions)
4        .withAppearanceOptions(appearanceOptions)
5        .build();
6
7// Creates a new job instance
8PDFElectronicSealJob pdfElectronicSealJob = new PDFElectronicSealJob(asset, pdfElectronicSealParams);
9
10// Sets the optional input seal image for PDFElectronicSealOperation instance
11pdfElectronicSealJob.setSealImageAsset(sealImageAsset);

This set of code defines what we're doing (an Electronic Seal operation), it defines parameters for the seal job and sets input seal image asset.

10) The next code block submits the job and gets the job result:

// Submit the job and gets the job result
String location = pdfServices.submit(pdfElectronicSealJob);
PDFServicesResponse<PDFElectronicSealResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFElectronicSealResult.class);

// Get content from the resulting asset(s)
Asset resultAsset = pdfServicesResponse.getResult().getAsset();
StreamAsset streamAsset = pdfServices.getContent(resultAsset);
CopyCopied to your clipboard
1// Submit the job and gets the job result
2String location = pdfServices.submit(pdfElectronicSealJob);
3PDFServicesResponse<PDFElectronicSealResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFElectronicSealResult.class);
4
5// Get content from the resulting asset(s)
6Asset resultAsset = pdfServicesResponse.getResult().getAsset();
7StreamAsset streamAsset = pdfServices.getContent(resultAsset);

11) The next code block saves the result at the specified location:

// Creates an output stream and copy stream asset's content to it
OutputStream outputStream = Files.newOutputStream(new File("output/sealedOutput.pdf").toPath());
IOUtils.copy(streamAsset.getInputStream(), outputStream);
CopyCopied to your clipboard
1// Creates an output stream and copy stream asset's content to it
2OutputStream outputStream = Files.newOutputStream(new File("output/sealedOutput.pdf").toPath());
3IOUtils.copy(streamAsset.getInputStream(), outputStream);

Here's the complete application (src/main/java/ElectronicSeal.java):

import com.adobe.pdfservices.operation.PDFServices;
import com.adobe.pdfservices.operation.PDFServicesMediaType;
import com.adobe.pdfservices.operation.PDFServicesResponse;
import com.adobe.pdfservices.operation.auth.Credentials;
import com.adobe.pdfservices.operation.auth.ServicePrincipalCredentials;
import com.adobe.pdfservices.operation.exception.SDKException;
import com.adobe.pdfservices.operation.exception.ServiceApiException;
import com.adobe.pdfservices.operation.exception.ServiceUsageException;
import com.adobe.pdfservices.operation.io.Asset;
import com.adobe.pdfservices.operation.io.StreamAsset;
import com.adobe.pdfservices.operation.pdfjobs.jobs.PDFElectronicSealJob;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceItem;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceOptions;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CSCAuthContext;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CertificateCredentials;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.DocumentLevelPermission;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldLocation;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldOptions;
import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.PDFElectronicSealParams;
import com.adobe.pdfservices.operation.pdfjobs.result.PDFElectronicSealResult;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Paths;

public class ElectronicSeal {

    // Initialize the logger.
    private static final Logger LOGGER = LoggerFactory.getLogger(ElectronicSeal.class);

    public static void main(String[] args) {
        try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/sampleInvoice.pdf").toPath());
             InputStream inputStreamSealImage = Files.newInputStream(new File("src/main/resources/sampleSealImage.png").toPath())) {
            // Initial setup, create credentials instance
            Credentials credentials = new ServicePrincipalCredentials(
                    System.getenv("PDF_SERVICES_CLIENT_ID"),
                    System.getenv("PDF_SERVICES_CLIENT_SECRET"));
            
            // Creates a PDF Services instance
            PDFServices pdfServices = new PDFServices(credentials);

            // Create assets from source files and upload
            Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
            Asset sealImageAsset = pdfServices.upload(inputStreamSealImage, PDFServicesMediaType.PNG.getMediaType());

            // Set the document level permission to be applied for output document
            DocumentLevelPermission documentLevelPermission = DocumentLevelPermission.FORM_FILLING;
            
            // Create AppearanceOptions and add the required signature display items to it
            AppearanceOptions appearanceOptions = new AppearanceOptions();
            appearanceOptions.addItem(AppearanceItem.NAME);
            appearanceOptions.addItem(AppearanceItem.LABELS);
            appearanceOptions.addItem(AppearanceItem.DATE);
            appearanceOptions.addItem(AppearanceItem.SEAL_IMAGE);
            appearanceOptions.addItem(AppearanceItem.DISTINGUISHED_NAME);

            // Sets the Seal Field Name to be created in input PDF document.
            String sealFieldName = "Signature1";
          
            // Sets the page number in input document for applying seal.
            Integer sealPageNumber = 1;
          
            // Sets if seal should be visible or invisible.
            Boolean sealVisible = true;
          
            // Creates FieldLocation instance and set the coordinates for applying signature
            FieldLocation fieldLocation = new FieldLocation(150, 250, 350, 200);
          
            // Create FieldOptions instance with required details.
            FieldOptions fieldOptions = new FieldOptions.Builder(sealFieldName)
                    .setFieldLocation(fieldLocation)
                    .setPageNumber(sealPageNumber)
                    .setVisible(sealVisible)
                    .build();
          
            //Set the name of TSP Provider being used.
            String providerName = "<PROVIDER_NAME>";
          
            // Sets the access token to be used to access TSP provider hosted APIs.
            String accessToken = "<ACCESS_TOKEN>";
          
            // Sets the credential ID.
            String credentialID = "<CREDENTIAL_ID>";
          
            // Sets the PIN generated while creating credentials.
            String pin = "<PIN>";
          
            // Creates CSCAuthContext instance using access token and token type.
            CSCAuthContext cscAuthContext = new CSCAuthContext(accessToken, "Bearer");
          
            // Create CertificateCredentials instance with required certificate details.
            CertificateCredentials certificateCredentials = CertificateCredentials.cscCredentialBuilder()
                    .withProviderName(providerName)
                    .withCredentialID(credentialID)
                    .withPin(pin)
                    .withCSCAuthContext(cscAuthContext)
                    .build();
            
            // Create parameters for the job
            PDFElectronicSealParams pdfElectronicSealParams = PDFElectronicSealParams
                    .pdfElectronicSealParamsBuilder(certificateCredentials, fieldOptions)
                    .withDocumentLevelPermission(documentLevelPermission)
                    .withAppearanceOptions(appearanceOptions)
                    .build();
          
            // Creates a new job instance
            PDFElectronicSealJob pdfElectronicSealJob = new PDFElectronicSealJob(asset, pdfElectronicSealParams);
          
            // Sets the optional input seal image for PDFElectronicSealOperation instance
            pdfElectronicSealJob.setSealImageAsset(sealImageAsset);

            // Submit the job and gets the job result
            String location = pdfServices.submit(pdfElectronicSealJob);
            PDFServicesResponse<PDFElectronicSealResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFElectronicSealResult.class);
          
            // Get content from the resulting asset(s)
            Asset resultAsset = pdfServicesResponse.getResult().getAsset();
            StreamAsset streamAsset = pdfServices.getContent(resultAsset);

            // Creates an output stream and copy stream asset's content to it
            Files.createDirectories(Paths.get("output/"));
            OutputStream outputStream = Files.newOutputStream(new File("output/sealedOutput.pdf").toPath());
            LOGGER.info("Saving asset at output/sealedOutput.pdf");
            IOUtils.copy(streamAsset.getInputStream(), outputStream);
            outputStream.close();
        } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {
            LOGGER.error("Exception encountered while executing operation", ex);
        }
    }
}
CopyCopied to your clipboard
1import com.adobe.pdfservices.operation.PDFServices;
2import com.adobe.pdfservices.operation.PDFServicesMediaType;
3import com.adobe.pdfservices.operation.PDFServicesResponse;
4import com.adobe.pdfservices.operation.auth.Credentials;
5import com.adobe.pdfservices.operation.auth.ServicePrincipalCredentials;
6import com.adobe.pdfservices.operation.exception.SDKException;
7import com.adobe.pdfservices.operation.exception.ServiceApiException;
8import com.adobe.pdfservices.operation.exception.ServiceUsageException;
9import com.adobe.pdfservices.operation.io.Asset;
10import com.adobe.pdfservices.operation.io.StreamAsset;
11import com.adobe.pdfservices.operation.pdfjobs.jobs.PDFElectronicSealJob;
12import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceItem;
13import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.AppearanceOptions;
14import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CSCAuthContext;
15import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.CertificateCredentials;
16import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.DocumentLevelPermission;
17import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldLocation;
18import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.FieldOptions;
19import com.adobe.pdfservices.operation.pdfjobs.params.electronicseal.PDFElectronicSealParams;
20import com.adobe.pdfservices.operation.pdfjobs.result.PDFElectronicSealResult;
21import org.apache.commons.io.IOUtils;
22import org.slf4j.Logger;
23import org.slf4j.LoggerFactory;
24
25import java.io.File;
26import java.io.IOException;
27import java.io.InputStream;
28import java.io.OutputStream;
29import java.nio.file.Files;
30import java.nio.file.Paths;
31
32public class ElectronicSeal {
33
34    // Initialize the logger.
35    private static final Logger LOGGER = LoggerFactory.getLogger(ElectronicSeal.class);
36
37    public static void main(String[] args) {
38        try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/sampleInvoice.pdf").toPath());
39             InputStream inputStreamSealImage = Files.newInputStream(new File("src/main/resources/sampleSealImage.png").toPath())) {
40            // Initial setup, create credentials instance
41            Credentials credentials = new ServicePrincipalCredentials(
42                    System.getenv("PDF_SERVICES_CLIENT_ID"),
43                    System.getenv("PDF_SERVICES_CLIENT_SECRET"));
44            
45            // Creates a PDF Services instance
46            PDFServices pdfServices = new PDFServices(credentials);
47
48            // Create assets from source files and upload
49            Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
50            Asset sealImageAsset = pdfServices.upload(inputStreamSealImage, PDFServicesMediaType.PNG.getMediaType());
51
52            // Set the document level permission to be applied for output document
53            DocumentLevelPermission documentLevelPermission = DocumentLevelPermission.FORM_FILLING;
54            
55            // Create AppearanceOptions and add the required signature display items to it
56            AppearanceOptions appearanceOptions = new AppearanceOptions();
57            appearanceOptions.addItem(AppearanceItem.NAME);
58            appearanceOptions.addItem(AppearanceItem.LABELS);
59            appearanceOptions.addItem(AppearanceItem.DATE);
60            appearanceOptions.addItem(AppearanceItem.SEAL_IMAGE);
61            appearanceOptions.addItem(AppearanceItem.DISTINGUISHED_NAME);
62
63            // Sets the Seal Field Name to be created in input PDF document.
64            String sealFieldName = "Signature1";
65          
66            // Sets the page number in input document for applying seal.
67            Integer sealPageNumber = 1;
68          
69            // Sets if seal should be visible or invisible.
70            Boolean sealVisible = true;
71          
72            // Creates FieldLocation instance and set the coordinates for applying signature
73            FieldLocation fieldLocation = new FieldLocation(150, 250, 350, 200);
74          
75            // Create FieldOptions instance with required details.
76            FieldOptions fieldOptions = new FieldOptions.Builder(sealFieldName)
77                    .setFieldLocation(fieldLocation)
78                    .setPageNumber(sealPageNumber)
79                    .setVisible(sealVisible)
80                    .build();
81          
82            //Set the name of TSP Provider being used.
83            String providerName = "<PROVIDER_NAME>";
84          
85            // Sets the access token to be used to access TSP provider hosted APIs.
86            String accessToken = "<ACCESS_TOKEN>";
87          
88            // Sets the credential ID.
89            String credentialID = "<CREDENTIAL_ID>";
90          
91            // Sets the PIN generated while creating credentials.
92            String pin = "<PIN>";
93          
94            // Creates CSCAuthContext instance using access token and token type.
95            CSCAuthContext cscAuthContext = new CSCAuthContext(accessToken, "Bearer");
96          
97            // Create CertificateCredentials instance with required certificate details.
98            CertificateCredentials certificateCredentials = CertificateCredentials.cscCredentialBuilder()
99                    .withProviderName(providerName)
100                    .withCredentialID(credentialID)
101                    .withPin(pin)
102                    .withCSCAuthContext(cscAuthContext)
103                    .build();
104            
105            // Create parameters for the job
106            PDFElectronicSealParams pdfElectronicSealParams = PDFElectronicSealParams
107                    .pdfElectronicSealParamsBuilder(certificateCredentials, fieldOptions)
108                    .withDocumentLevelPermission(documentLevelPermission)
109                    .withAppearanceOptions(appearanceOptions)
110                    .build();
111          
112            // Creates a new job instance
113            PDFElectronicSealJob pdfElectronicSealJob = new PDFElectronicSealJob(asset, pdfElectronicSealParams);
114          
115            // Sets the optional input seal image for PDFElectronicSealOperation instance
116            pdfElectronicSealJob.setSealImageAsset(sealImageAsset);
117
118            // Submit the job and gets the job result
119            String location = pdfServices.submit(pdfElectronicSealJob);
120            PDFServicesResponse<PDFElectronicSealResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFElectronicSealResult.class);
121          
122            // Get content from the resulting asset(s)
123            Asset resultAsset = pdfServicesResponse.getResult().getAsset();
124            StreamAsset streamAsset = pdfServices.getContent(resultAsset);
125
126            // Creates an output stream and copy stream asset's content to it
127            Files.createDirectories(Paths.get("output/"));
128            OutputStream outputStream = Files.newOutputStream(new File("output/sealedOutput.pdf").toPath());
129            LOGGER.info("Saving asset at output/sealedOutput.pdf");
130            IOUtils.copy(streamAsset.getInputStream(), outputStream);
131            outputStream.close();
132        } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {
133            LOGGER.error("Exception encountered while executing operation", ex);
134        }
135    }
136}

Next Steps

Now that you've successfully performed your first operation, review the documentation for many other examples and reach out on our forums with any questions. Also remember the samples you downloaded while creating your credentials also have many demos.

Last updated 1/2/2024

Was this helpful?

Yes

No