Link Search Menu Expand Document

Protect PDF Document - Java

PDF Password And Security sample in Java demonstrating ‘Protect PDF Document’

import okhttp3.*;

import java.nio.file.Path;
import java.nio.file.Paths;

public class Main
    // The authentication key (API Key).
    // Get your own by registering at
    final static String API_KEY = "***********************************";

    // Direct URL of source PDF file.
    // You can also upload your own file into and use it as url. Check "Upload File" samples for code snippets:    
    final static String SourceFileUrl = "";

    // Destination PDF file name
    final static Path DestinationFile = Paths.get(".\\protected.pdf");

    // Passwords to protect PDF document
    // The owner password will be required for document modification.
    // The user password only allows to view and print the document.
    final static String OwnerPassword = "123456";
    final static String UserPassword = "654321";

    // Encryption algorithm.
    // Valid values: "RC4_40bit", "RC4_128bit", "AES_128bit", "AES_256bit".
    final static String EncryptionAlgorithm = "AES_128bit";

    // Allow or prohibit content extraction for accessibility needs.
    final static boolean AllowAccessibilitySupport = true;

    // Allow or prohibit assembling the document.
    final static boolean AllowAssemblyDocument = true;

    // Allow or prohibit printing PDF document.
    final static boolean AllowPrintDocument = true;

    // Allow or prohibit filling of interactive form fields (including signature fields) in PDF document.
    final static boolean AllowFillForms = true;

    // Allow or prohibit modification of PDF document.
    final static boolean AllowModifyDocument = true;

    // Allow or prohibit copying content from PDF document.
    final static boolean AllowContentExtraction = true;

    // Allow or prohibit interacting with text annotations and forms in PDF document.
    final static boolean AllowModifyAnnotations = true;

    // Allowed printing quality.
    // Valid values: "HighResolution", "LowResolution"
    final static String PrintQuality = "HighResolution";

    // Runs processing asynchronously.
    // Returns Use JobId that you may use with /job/check to check state of the processing (possible states: working, failed, aborted and success).
    final static boolean async = false;

    public static void main(String[] args) throws IOException
        // Create HTTP client instance
        OkHttpClient webClient = new OkHttpClient();

        // Prepare URL for `PDF Security` API call
        String query = "";

        // Make correctly escaped (encoded) URL
        URL url = null;
            url = new URI(null, query, null).toURL();
        catch (URISyntaxException e)

        // Create JSON payload
		String jsonPayload = String.format("{\n" +
                        "    \"name\": \"%s\",\n" +
                        "    \"url\": \"%s\",\n" +
                        "    \"ownerPassword\": \"%s\",\n" +
                        "    \"userPassword\": \"%s\",\n" +
                        "    \"EncryptionAlgorithm\": \"%s\",\n" +
                        "    \"AllowAccessibilitySupport\": %s,\n" +
                        "    \"AllowAssemblyDocument\": %s,\n" +
                        "    \"AllowPrintDocument\": %s,\n" +
                        "    \"AllowFillForms\": %s,\n" +
                        "    \"AllowModifyDocument\": %s,\n" +
                        "    \"AllowContentExtraction\": %s,\n" +
                        "    \"AllowModifyAnnotations\": %s,\n" +
                        "    \"PrintQuality\": \"%s\",\n" +
                        "    \"async\": %s\n" +
                DestinationFile.getFileName(), SourceFileUrl, OwnerPassword, UserPassword, EncryptionAlgorithm,
                Boolean.toString(AllowAccessibilitySupport), Boolean.toString(AllowAssemblyDocument), Boolean.toString(AllowPrintDocument),
                Boolean.toString(AllowFillForms), Boolean.toString(AllowModifyDocument), Boolean.toString(AllowContentExtraction),
                Boolean.toString(AllowModifyAnnotations),PrintQuality, Boolean.toString(async)

        // Prepare request body
        RequestBody body = RequestBody.create(MediaType.parse("application/json"), jsonPayload);
        // Prepare request
        Request request = new Request.Builder()
            .addHeader("x-api-key", API_KEY) // (!) Set API Key
            .addHeader("Content-Type", "application/json")
        // Execute request
        Response response = webClient.newCall(request).execute();

        if (response.code() == 200)
            // Parse JSON response
            JsonObject json = new JsonParser().parse(response.body().string()).getAsJsonObject();

            boolean error = json.get("error").getAsBoolean();
            if (!error)
                // Get URL of generated PDF file
                String resultFileUrl = json.get("url").getAsString();

                // Download PDF file
                downloadFile(webClient, resultFileUrl, DestinationFile.toFile());

                System.out.printf("Generated PDF file saved as \"%s\" file.", DestinationFile.toString());
                // Display service reported error
            // Display request error
            System.out.println(response.code() + " " + response.message());

    public static void downloadFile(OkHttpClient webClient, String url, File destinationFile) throws IOException
        // Prepare request
        Request request = new Request.Builder()
        // Execute request
        Response response = webClient.newCall(request).execute();

        byte[] fileBytes = response.body().bytes();

        // Save downloaded bytes to file
        OutputStream output = new FileOutputStream(destinationFile);

} 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.

Get your API key here!

Download Source Code (.zip)

return to the previous page explore PDF Password And Security endpoint