com.lacunasoftware.restpki

Class PadesSignatureStarter2

java.lang.Object

com.lacunasoftware.restpki.SignatureStarter2

com.lacunasoftware.restpki.PadesSignatureStarter2

public class PadesSignatureStarter2
extends SignatureStarter2

Field Summary

Fields inherited from class com.lacunasoftware.restpki.SignatureStarter2

callbackArgument, certificateBase64, client, ignoreRevocationStatusUnknown, securityContextId, signaturePolicyId

Constructor Summary

Constructors

Constructor and Description
PadesSignatureStarter2(RestPkiClient client) Create a new instance using the given RestPkiClient.

Method Summary

Modifier and Type	Method and Description
void	addPdfMark(PdfMark pdfMark) Adds a new PDF mark to the list.
void	setBypassMarksIfSigned(boolean bypassMarksIfSigned) Denotes whether to bypass the PDF marks if the PDF is already signed (default true).
void	setMeasurementUnits(PadesMeasurementUnits measurementUnits) Optional, sets the unit of measurement used to edit the pdf marks and visual representations.
void	setPageOptimization(PadesPageOptimization pageOptimization) Optional, sets the page size used to calculate the conversion between centimeter measurements and PDF points.
void	setPdfMarks(java.util.List<PdfMark> pdfMarks) Optional, sets the setting to mark the pdf with the signature.
void	setPdfToSign(byte[] content) Sets the PDF to be signed via a byte array.
void	setPdfToSign(FileResult fileResult) Sets the PDF to be signed from a previous signature's result to be co-signed.
void	setPdfToSign(java.io.InputStream stream) Sets the PDF to be signed via a stream object.
void	setPdfToSign(java.nio.file.Path path) Sets the file path of the PDF to be signed.
void	setPdfToSign(java.lang.String path) Sets the file path of the PDF to be signed.
void	setVisualRepresentation(PadesVisualRepresentation visualRepresentation) Optional, sets the settings for the signature's visual representation.
SignatureStartResult	start() Performs the first step, should be called after setting the necessary parameters.
SignatureStartWithWebPkiResult	startWithWebPki() Performs the first step, should be called after setting the necessary parameters.

Methods inherited from class com.lacunasoftware.restpki.SignatureStarter2

setCallbackArgument, setIgnoreRevocationStatusUnknown, setSecurityContext, setSignaturePolicy, setSignerCertificate, setSignerCertificateBase64, setSignerCertificateRaw

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PadesSignatureStarter2

public PadesSignatureStarter2(RestPkiClient client)

Create a new instance using the given RestPkiClient.

Parameters:

client - the RestPkiClient which shall be used.

Method Detail

setPdfToSign

public void setPdfToSign(java.io.InputStream stream)

Sets the PDF to be signed via a stream object.

Parameters:

stream - A pre-opened InputStream linked to the PDF that will be signed. The stream is NOT closed by this method.

setPdfToSign

public void setPdfToSign(byte[] content)

Sets the PDF to be signed via a byte array.

Parameters:

content - Binary content of the PDF.

setPdfToSign

public void setPdfToSign(java.lang.String path)

Sets the file path of the PDF to be signed.

Parameters:

path - File path of the PDF to be signed.

setPdfToSign

public void setPdfToSign(java.nio.file.Path path)

Sets the file path of the PDF to be signed.

Parameters:

path - File path of the PDF to be signed.

setPdfToSign

public void setPdfToSign(FileResult fileResult)

Sets the PDF to be signed from a previous signature's result to be co-signed.

Parameters:

fileResult - FileResult from previous signature with Rest PKI.

setBypassMarksIfSigned

public void setBypassMarksIfSigned(boolean bypassMarksIfSigned)

Denotes whether to bypass the PDF marks if the PDF is already signed (default true). PDF marks can only be added if the PDF has no previous signatures. This property controls the behavior when PDF marks are requested but the PDF already contains signatures. If true (default), the marks are simply bypassed. If false, an error is returned.

Parameters:

bypassMarksIfSigned - Chosen behavior

setPageOptimization

public void setPageOptimization(PadesPageOptimization pageOptimization)

Optional, sets the page size used to calculate the conversion between centimeter measurements and PDF points. If omitted, the page size is automatically detected between A4, Legal or Letter.

Parameters:

pageOptimization - Page size and orientation.

setMeasurementUnits

public void setMeasurementUnits(PadesMeasurementUnits measurementUnits)

Optional, sets the unit of measurement used to edit the pdf marks and visual representations.

Parameters:

measurementUnits - Unit of Measurement.

setVisualRepresentation

public void setVisualRepresentation(PadesVisualRepresentation visualRepresentation)

Optional, sets the settings for the signature's visual representation.

Parameters:

visualRepresentation - The visual representation's settings.

setPdfMarks

public void setPdfMarks(java.util.List<PdfMark> pdfMarks)

Optional, sets the setting to mark the pdf with the signature.

Parameters:

pdfMarks - List with PDF marks.

addPdfMark

public void addPdfMark(PdfMark pdfMark)

Adds a new PDF mark to the list.

Parameters:

pdfMark - PDF mark.

start

public SignatureStartResult start()
                           throws RestException,
                                  java.io.IOException

Performs the first step, should be called after setting the necessary parameters. If you intend to use the Web PKI component on the client-side, use the startWithWebPki() method instead.

Specified by:

start in class SignatureStarter2

Returns:

An instance of SignatureStartResult with the information necessary to perform the client-side signature and later call the server back with the results.

Throws:

RestException - if an error occurs when calling REST PKI.

java.io.IOException - if an error occurs when trying to obtain the file to be signed or be cosign or when trying to compute all hashes from this file, both files had to be provided before this method is called.

startWithWebPki

public SignatureStartWithWebPkiResult startWithWebPki()
                                               throws RestException,
                                                      java.io.IOException

Performs the first step, should be called after setting the necessary parameters. This method should be used if the Web PKI component is being used on the client-side.

Specified by:

startWithWebPki in class SignatureStarter2

Returns:

An instance of SignatureStartWithWebPkiResult containing the token that should be passed on the signWithRestPki() method of the Web PKI component (on the client-side logic) and the signer's certificate.

Throws:

RestException - if an error occurs when calling REST PKI.

java.io.IOException - if an error occurs when trying to obtain the file to be signed or be cosign or when trying to compute all hashes from this file, both files had to be provided before this method is called.