Fill PDF Form Asynchronously - Java
PDF Fill PDF Forms sample in Java demonstrating ‘Fill PDF Form Asynchronously’
Main.java
package com.company;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import okhttp3.*;
import java.io.*;
import java.net.*;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
public class Main
{
// The authentication key (API Key).
// Get your own by registering at https://app.pdf.co
final static String API_KEY = "nnamdionyemaobi@gmail.com_Fcz589ZrRNt66ufvgsZZaMOHs918OOJ75F6p5sHyIZAUVpnjM1e3cVrq3jFs5gDi";
// Direct URL of source PDF file.
final static String SourceFileUrl = "bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-form/f1040.pdf";
// PDF document password. Leave empty for unprotected documents.
final static String Password = "";
// Destination PDF file name
final static Path ResultFile = Paths.get(".\\result.pdf");
// Asynchronous Job
final static boolean Async = true;
public static void main(String[] args) throws IOException, InterruptedException
{
// Create HTTP client instance
OkHttpClient webClient = new OkHttpClient();
// Prepare URL for `PDF Edit` API call
String query = "https://api.pdf.co/v1/pdf/edit/add";
// Prepare form filling data
String fields = "[\n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].FilingStatus[0].c1_01[1]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"True\"\n" +
" },\n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].f1_02[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"John A.\"\n" +
" }, \n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].f1_03[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"Doe\"\n" +
" }, \n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_04[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"123456789\"\n" +
" },\n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_05[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"Joan B.\"\n" +
" },\n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_05[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"Joan B.\"\n" +
" },\n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_06[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"Doe\"\n" +
" },\n" +
" {\n" +
" \"fieldName\": \"topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_07[0]\",\n" +
" \"pages\": \"1\",\n" +
" \"text\": \"987654321\"\n" +
" } \n" +
" ]";
// Make correctly escaped (encoded) URL
URL url = null;
try
{
url = new URI(null, query, null).toURL();
}
catch (URISyntaxException e)
{
e.printStackTrace();
}
// Create JSON payload
String jsonPayload = String.format("{\n" +
" \"url\": \"%s\",\n" +
" \"async\": %s,\n" +
" \"inline\": true,\n" +
" \"name\": \"f1040-filled\",\n" +
" \"fields\": %s"+
"}", SourceFileUrl, Async, fields);
// Prepare request body
RequestBody body = RequestBody.create(MediaType.parse("application/json"), jsonPayload);
// Prepare request
Request request = new Request.Builder()
.url(url)
.addHeader("x-api-key", API_KEY) // (!) Set API Key
.addHeader("Content-Type", "application/json")
.post(body)
.build();
// Execute request
Response response = webClient.newCall(request).execute();
DateTimeFormatter dtf = DateTimeFormatter.ofPattern("MM/dd/yyyy HH:mm:ss");
if (response.code() == 200)
{
// Parse JSON response
JsonObject json = new JsonParser().parse(response.body().string()).getAsJsonObject();
boolean error = json.get("error").getAsBoolean();
if (!error)
{
// Asynchronous job ID
String jobId = json.get("jobId").getAsString();
System.out.println("Job#" + jobId + ": has been created. - " + dtf.format(LocalDateTime.now()));
// URL of generated output file that will be available after the job completion
String resultFileUrl = json.get("url").getAsString();
// Check the job status in a loop.
do {
String status = CheckJobStatus(webClient, jobId); // Possible statuses: "working", "failed", "aborted", "success".
System.out.println("Job#" + jobId + ": " + status + " - " + dtf.format(LocalDateTime.now()));
if(status.compareToIgnoreCase("success") == 0){
// Build request for job url
request = new Request.Builder()
.url(resultFileUrl)
.build();
// Execute request
response = webClient.newCall(request).execute();
// Save the output file
downloadFile(webClient, resultFileUrl, ResultFile);
System.out.printf("Generated file saved to \"%s\" file.", ResultFile.toString());
break;
}
else if (status.compareToIgnoreCase("working") == 0){
// Pause for a few seconds
try{
Thread.sleep(3000);
}
catch (InterruptedException ex){
Thread.currentThread().interrupt(); // restore interrupted status
}
}
else{
System.out.println("Job failed with status: " + status);
break;
}
}while (true);
}
else
{
// Display service reported error
System.out.println(json.get("message").getAsString());
}
}
else
{
// Display request error
System.out.println(response.code() + " " + response.message());
}
}
// Check Job Status
private static String CheckJobStatus(OkHttpClient webClient, String jobId) throws IOException {
String url = "https://api.pdf.co/v1/job/check?jobid=" + jobId;
// Prepare request
Request request = new Request.Builder()
.url(url)
.addHeader("x-api-key", API_KEY) // (!) Set API Key
.build();
// Execute request
Response response = webClient.newCall(request).execute();
if (response.code() == 200)
{
// Parse JSON response
JsonObject json = new JsonParser().parse(response.body().string()).getAsJsonObject();
return json.get("status").getAsString();
}
else
{
// Display request error
System.out.println(response.code() + " " + response.message());
}
return "Failed";
}
public static void downloadFile(OkHttpClient webClient, String url, Path destinationFile) throws IOException
{
// Prepare request
Request request = new Request.Builder()
.url(url)
.build();
// Execute request
Response response = webClient.newCall(request).execute();
byte[] fileBytes = response.body().bytes();
// Save downloaded bytes to file
OutputStream output = new FileOutputStream(destinationFile.toFile());
output.write(fileBytes);
output.flush();
output.close();
response.close();
}
}
App.java
package $org.example;
/**
* Hello world!
*
*/
public class App
{
public static void main( String[] args )
{
System.out.println( "Hello World!" );
}
}
AppTest.java
package $org.example;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
/**
* Unit test for simple App.
*/
public class AppTest
extends TestCase
{
/**
* Create the test case
*
* @param testName name of the test case
*/
public AppTest( String testName )
{
super( testName );
}
/**
* @return the suite of tests being tested
*/
public static Test suite()
{
return new TestSuite( AppTest.class );
}
/**
* Rigourous Test :-)
*/
public void testApp()
{
assertTrue( true );
}
}
App.java
package $org.example;
/**
* Hello world!
*
*/
public class App
{
public static void main( String[] args )
{
System.out.println( "Hello World!" );
}
}
AppTest.java
package $org.example;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
/**
* Unit test for simple App.
*/
public class AppTest
extends TestCase
{
/**
* Create the test case
*
* @param testName name of the test case
*/
public AppTest( String testName )
{
super( testName );
}
/**
* @return the suite of tests being tested
*/
public static Test suite()
{
return new TestSuite( AppTest.class );
}
/**
* Rigourous Test :-)
*/
public void testApp()
{
assertTrue( true );
}
}
PDF.co Web API: the Web API with a set of tools for documents manipulation, data conversion, data extraction, splitting and merging of documents. Includes image recognition, built-in OCR, barcode generation and barcode decoders to decode bar codes from scans, pictures and pdf.