Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions

Modifier and Type	Field and Description
public static final int	DEFAULT_SIGNATURE_SIZE
private int	pageNo
private RandomAccessRead	pdfSource
private int	preferredSignatureSize
private COSDocument	visualSignature

Access	Constructor and Description
public	SignatureOptions() Creates the default signature options.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes the visual signature COSDocument, if any.
public int	Returns: the page number getPage() Get the 0-based page number.
public int	Returns: the preferred size of the signature in bytes. getPreferredSignatureSize() Get the preferred size of the signature.
public COSDocument	Returns: the visual signature getVisualSignature() Get the visual signature.
private void	initFromRandomAccessRead(RandomAccessRead rar)
public void	setPage(int the page number pageNo) Set the 0-based page number.
public void	setPreferredSignatureSize(int the size of the signature in bytes. Only values above 0 will be considered. size) Set the preferred size of the signature.
public void	setVisualSignature(File the file containing the visual signature file) Reads the visual signature from the given file.
public void	setVisualSignature(InputStream the input stream containing the visual signature is) Reads the visual signature from the given input stream.
public void	setVisualSignature(PDVisibleSigProperties the `PDVisibleSigProperties` object containing the visual signature visSignatureProperties) Reads the visual signature from the given visual signature properties

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

DEFAULT_SIGNATURE_SIZE	back to summary
public static final int DEFAULT_SIGNATURE_SIZE

pageNo	back to summary
private int pageNo

pdfSource	back to summary
private RandomAccessRead pdfSource

preferredSignatureSize	back to summary
private int preferredSignatureSize

visualSignature	back to summary
private COSDocument visualSignature

SignatureOptions	back to summary
public SignatureOptions() Creates the default signature options.

Method Detail

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Closes the visual signature COSDocument, if any. Do not call this before you're saved your signed PDF document, or saving will fail because COSStream objects held both by the COSDocument and by the signed document would no longer be available. Annotations @Override Exceptions IOException: if the document could not be closed

back to summary

public void close() throws IOException

Implements java.io.Closeable.close.

Closes the visual signature COSDocument, if any. Do not call this before you're saved your signed PDF document, or saving will fail because COSStream objects held both by the COSDocument and by the signed document would no longer be available.

Annotations

@Override

Exceptions

IOException:: if the document could not be closed

getPage	back to summary
public int getPage() Get the 0-based page number. Returns:int the page number

getPage

back to summary

public int getPage()

Get the 0-based page number.

Returns:int: the page number

getPreferredSignatureSize	back to summary
public int getPreferredSignatureSize() Get the preferred size of the signature. Returns:int the preferred size of the signature in bytes.

getPreferredSignatureSize

back to summary

public int getPreferredSignatureSize()

Get the preferred size of the signature.

Returns:int: the preferred size of the signature in bytes.

getVisualSignature	back to summary
public COSDocument getVisualSignature() Get the visual signature. Returns:COSDocument the visual signature

getVisualSignature

back to summary

public COSDocument getVisualSignature()

Get the visual signature.

Returns:COSDocument: the visual signature

initFromRandomAccessRead	back to summary
private void initFromRandomAccessRead(RandomAccessRead rar) throws IOException

setPage	back to summary
public void setPage(int pageNo) Set the 0-based page number. Parameters pageNo:int the page number

setPage

back to summary

public void setPage(int pageNo)

Set the 0-based page number.

Parameters

pageNo:int: the page number

setPreferredSignatureSize	back to summary
public void setPreferredSignatureSize(int size) Set the preferred size of the signature. Parameters size:int the size of the signature in bytes. Only values above 0 will be considered.

setPreferredSignatureSize

back to summary

public void setPreferredSignatureSize(int size)

Set the preferred size of the signature.

Parameters

size:int: the size of the signature in bytes. Only values above 0 will be considered.

setVisualSignature	back to summary
public void setVisualSignature(File file) throws IOException Reads the visual signature from the given file. Parameters file:File the file containing the visual signature Exceptions IOException: when something went wrong during parsing

setVisualSignature

back to summary

public void setVisualSignature(File file) throws IOException

Reads the visual signature from the given file.

Parameters

file:File: the file containing the visual signature

Exceptions

IOException:: when something went wrong during parsing

setVisualSignature	back to summary
public void setVisualSignature(InputStream is) throws IOException Reads the visual signature from the given input stream. Parameters is:InputStream the input stream containing the visual signature Exceptions IOException: when something went wrong during parsing

setVisualSignature

back to summary

public void setVisualSignature(InputStream is) throws IOException

Reads the visual signature from the given input stream.

Parameters

is:InputStream: the input stream containing the visual signature

Exceptions

IOException:: when something went wrong during parsing

setVisualSignature back to summary

setVisualSignature	back to summary
public void setVisualSignature(PDVisibleSigProperties visSignatureProperties) throws IOException Reads the visual signature from the given visual signature properties Parameters visSignatureProperties:PDVisibleSigProperties the `PDVisibleSigProperties` object containing the visual signature Exceptions IOException: when something went wrong during parsing

public void setVisualSignature(PDVisibleSigProperties visSignatureProperties) throws IOException

Reads the visual signature from the given visual signature properties

Parameters

visSignatureProperties:PDVisibleSigProperties: the PDVisibleSigProperties object containing the visual signature

Exceptions

IOException:: when something went wrong during parsing

public Class SignatureOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail