Top Description Fields Constructors Methods

org.apache.pdfbox.tools

public final Class Encrypt

Class Inheritance

extends Object
implements Callable<Integer>

java.lang.Object
org.apache.pdfbox.tools.Encrypt

All Implemented Interfaces

java.util.concurrent.Callable

Annotations

@Command
name:encrypt
header:Encrypts a PDF document
description:${COMMAND-NAME} will read an unencrypted document and encrypt it either using a password or a certificate.%n, While encrypting the document permissions can be set which will allow/disallow certain functionality
versionProvider:Version
mixinStandardHelpOptions:true

Imports

java.io.File, .FileInputStream, .IOException, .InputStream, .PrintStream, java.security.cert.CertificateException, .CertificateFactory, .X509Certificate, java.util.ArrayList, .List, java.util.concurrent.Callable, org.apache.pdfbox.Loader, org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.encryption.AccessPermission, .PublicKeyProtectionPolicy, .PublicKeyRecipient, .StandardProtectionPolicy, picocli.CommandLine, .CommandLine.Command, .CommandLine.Option

This will read a document from the filesystem, encrypt it and and then write the results to the filesystem.

Author: Ben Litchfield

Field Summary

Modifier and Type	Field and Description
private boolean	canAssembleDocument
private boolean	canExtractContent
private boolean	canExtractForAccessibility
private boolean	canFillInForm
private boolean	canModify
private boolean	canModifyAnnotations
private boolean	canPrint
private boolean	canPrintFaithful
private List<File>	certFileList
private File	infile
private int	keyLength
private File	outfile
private String	ownerPassword
private final PrintStream	SYSERR
private String	userPassword

Constructor Summary

Access	Constructor and Description
public	Encrypt() Constructor.

Method Summary

Modifier and Type	Method and Description
public Integer	call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
public static void	main(String[] The command-line arguments. args) This is the entry point for the application.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

canAssembleDocument	back to summary
private boolean canAssembleDocument Annotations @Option names:-canAssemble description:set the assemble permission (default: ${DEFAULT-VALUE})

canExtractContent	back to summary
private boolean canExtractContent Annotations @Option names:-canExtractContent description:set the extraction permission (default: ${DEFAULT-VALUE})

canExtractForAccessibility	back to summary
private boolean canExtractForAccessibility Annotations @Option names:-canExtractForAccessibility description:set the extraction permission (default: ${DEFAULT-VALUE})

canFillInForm	back to summary
private boolean canFillInForm Annotations @Option names:-canFillInForm description:set the form fill in permission (default: ${DEFAULT-VALUE})

canModify	back to summary
private boolean canModify Annotations @Option names:-canModify description:set the modify permission (default: ${DEFAULT-VALUE})

canModifyAnnotations	back to summary
private boolean canModifyAnnotations Annotations @Option names:-canModifyAnnotations description:set the modify annots permission (default: ${DEFAULT-VALUE})

canPrint	back to summary
private boolean canPrint Annotations @Option names:-canPrint description:set the print permission (default: ${DEFAULT-VALUE})

canPrintFaithful	back to summary
private boolean canPrintFaithful Annotations @Option names:-canPrintFaithful description:set the print faithful permission (default: ${DEFAULT-VALUE})

certFileList	back to summary
private List<File> certFileList Annotations @Option names:-certFile paramLabel:certFile description:Path to X.509 certificate (repeat both if needed)

infile	back to summary
private File infile Annotations @Option names:-i, --input description:the PDF file to encrypt required:true

keyLength	back to summary
private int keyLength Annotations @Option names:-keyLength description:Key length in bits (valid values: 40, 128 or 256) (default: ${DEFAULT-VALUE})

outfile	back to summary
private File outfile Annotations @Option names:-o, --output description:the encrypted PDF file. If omitted the original file is overwritten.

ownerPassword	back to summary
private String ownerPassword Annotations @Option names:-O description:set the owner password (ignored if certFile is set) arity:0..1 interactive:true

SYSERR	back to summary
private final PrintStream SYSERR Annotations @SuppressWarnings:squid:S106

userPassword	back to summary
private String userPassword Annotations @Option names:-U description:set the user password (ignored if certFile is set) arity:0..1 interactive:true

Constructor Detail

Encrypt	back to summary
public Encrypt() Constructor.

Method Detail

call

back to summary

public Integer call()

Implements java.util.concurrent.Callable.call.

Doc from java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

Returns:Integer: computed result

main

back to summary

public static void main(String[] args)

This is the entry point for the application.

Parameters

args:String[]: The command-line arguments.