at.gv.egiz.pdfas.wrapper

Class PdfAsObject

java.lang.Object

at.gv.egiz.pdfas.wrapper.PdfAsObject

All Implemented Interfaces:

PdfAs

public class PdfAsObject
extends java.lang.Object
implements PdfAs

Constructor Summary

Constructors

Constructor and Description
PdfAsObject(java.io.File workdirectory)

Method Summary

Methods

Modifier and Type	Method and Description
AnalyzeResult	analyze(AnalyzeParameters analyzeParameters) Analyzes a document for signatures and returns a verify-able list of such.
DynamicSignatureProfile	createDynamicSignatureProfile(java.lang.String parentProfile, DynamicSignatureLifetimeEnum mode) Create a signature profile dynamically.
DynamicSignatureProfile	createDynamicSignatureProfile(java.lang.String myUniqueName, java.lang.String parentProfile, DynamicSignatureLifetimeEnum mode) Create a signature profile dynamically.
DynamicSignatureProfile	createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode) Create a signature profile dynamically.
DynamicSignatureProfile	createEmptyDynamicSignatureProfile(java.lang.String myUniqueName, DynamicSignatureLifetimeEnum mode) Create a signature profile dynamically.
SignResult	finishSign(SignParameters signParameters, SignatureDetailInformation signatureDetailInformation) Finish the signature process.
java.util.List	getProfileInformation() Returns the list of information objects about activated profiles available in the configuration.
DynamicSignatureProfile	loadDynamicSignatureProfile(java.lang.String profileName) Loads an existing dynamic signature profile by its name.
SignatureDetailInformation	prepareSign(SignParameters signParameters) Prepares the signature of the given PDF document.
ReconstructXMLDsigResult	reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters reconstructXMLDsigParameters) Reconstruct the from the given parameters.
ReconstructXMLDsigResult	reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters) Reconstruct the from the given parameters.
void	reloadConfig() Reloads the configuration from the work directory.
SignResult	sign(SignParameters signParameters) Signs a PDF document using PDF-AS.
SignResult	sign(SignParameters signParameters, SignatureDetailInformation signatureDetailInformation) Signs a PDF document using PDF-AS. This uses the SignatorInformation which was obtained by a call to PdfAs.prepareSign(SignParameters)
VerifyResults	verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters) Verifies a list of signatures that have been analyzed previously.
VerifyResults	verify(VerifyAfterReconstructXMLDsigParameters verifyAfterReconstructXMLDsigParameters) Verifies a list of signatures that have been analyzed previously and the xmldsigs have been reconstructed.
VerifyResults	verify(VerifyParameters verifyParameters) Verifies a document with (potentially multiple) PDF-AS signatures.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfAsObject

public PdfAsObject(java.io.File workdirectory)

Method Detail

sign

public SignResult sign(SignParameters signParameters)
                throws PdfAsException

Description copied from interface: PdfAs

Signs a PDF document using PDF-AS.

Specified by:

sign in interface PdfAs

Parameters:

signParameters - The sign parameters.

Returns:

Returns the signed document plus additional information.

Throws:

PdfAsException - Thrown, if an error occurs.

See Also:

SignParameters, SignResult

sign

public SignResult sign(SignParameters signParameters,
              SignatureDetailInformation signatureDetailInformation)
                throws PdfAsException

Description copied from interface: PdfAs

Signs a PDF document using PDF-AS.
This uses the SignatorInformation which was obtained by a call to PdfAs.prepareSign(SignParameters)

Specified by:

sign in interface PdfAs

Parameters:

signParameters - The sign parameters.

signatureDetailInformation - The signature information which was previously obtained by a call to PdfAs.prepareSign(SignParameters)

Returns:

Returns the signed document plus additional information.

Throws:

PdfAsException - Thrown, if an error occurs.

See Also:

SignParameters, SignResult

verify

public VerifyResults verify(VerifyParameters verifyParameters)
                     throws PdfAsException

Description copied from interface: PdfAs

Verifies a document with (potentially multiple) PDF-AS signatures.

Specified by:

verify in interface PdfAs

Parameters:

verifyParameters - The verify parameters.

Returns:

Returns the verification results.

Throws:

PdfAsException - Thrown, if an error occurs.

See Also:

VerifyParameters, VerifyResults, VerifyResult

analyze

public AnalyzeResult analyze(AnalyzeParameters analyzeParameters)
                      throws PdfAsException

Description copied from interface: PdfAs

Analyzes a document for signatures and returns a verify-able list of such.

Specified by:

analyze in interface PdfAs

Parameters:

analyzeParameters - The analyzation parameters.

Returns:

Returns a list of verify-able signatures that were found in the document.

Throws:

PdfAsException - Thrown on error.

See Also:

AnalyzeParameters, AnalyzeResult, #verify(AnalyzeResult)}

reconstructXMLDSIG

public ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters)
                                            throws PdfAsException

Description copied from interface: PdfAs

Reconstruct the from the given parameters.

Specified by:

reconstructXMLDSIG in interface PdfAs

Parameters:

reconstructXMLDsigParameters - The data from which to reconstruct the xmldsig

Returns:

a list of xmldsigs, one for each signature in the document

Throws:

PdfAsException - if the reconstruction fails

reconstructXMLDSIG

public ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters reconstructXMLDsigParameters)
                                            throws PdfAsException

Description copied from interface: PdfAs

Reconstruct the from the given parameters.

Specified by:

reconstructXMLDSIG in interface PdfAs

Parameters:

reconstructXMLDsigParameters - The data from which to reconstruct the xmldsigs

Returns:

a list of xmldsigs, one for each signature in the document

Throws:

PdfAsException

verify

public VerifyResults verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
                     throws PdfAsException

Description copied from interface: PdfAs

Verifies a list of signatures that have been analyzed previously.

Specified by:

verify in interface PdfAs

Parameters:

verifyAfterAnalysisParameters - The parameters.

Returns:

Returns the verification results.

Throws:

PdfAsException - Thrown on error.

See Also:

AnalyzeResult, VerifyAfterAnalysisParameters, VerifyResults, VerifyResult, #analyze(AnalyzeParameters)}

verify

public VerifyResults verify(VerifyAfterReconstructXMLDsigParameters verifyAfterReconstructXMLDsigParameters)
                     throws PdfAsException

Description copied from interface: PdfAs

Verifies a list of signatures that have been analyzed previously and the xmldsigs have been reconstructed.

Specified by:

verify in interface PdfAs

Parameters:

verifyAfterReconstructXMLDsigParameters - The parameters.

Returns:

the verification results.

Throws:

PdfAsException - Thrown on error.

reloadConfig

public void reloadConfig()
                  throws PdfAsException

Description copied from interface: PdfAs

Reloads the configuration from the work directory.

Specified by:

reloadConfig in interface PdfAs

Throws:

PdfAsException - Thrown, if an error occurs.

getProfileInformation

public java.util.List getProfileInformation()
                                     throws PdfAsException

Description copied from interface: PdfAs

Returns the list of information objects about activated profiles available in the configuration.

Note: Currently the profile information consists of the profile Id and the MOA Key Id only.

Note: In near future the profile management will be moved out of the config file into an API class representation of the profiles which may render this (and related) methods obsolete.

Specified by:

getProfileInformation in interface PdfAs

Returns:

Returns the list of SignatureProfile objects with information about active profiles available in the configuration.

Throws:

PdfAsException - Thrown on error.

See Also:

SignatureProfile

createDynamicSignatureProfile

public DynamicSignatureProfile createDynamicSignatureProfile(java.lang.String parentProfile,
                                                    DynamicSignatureLifetimeEnum mode)

Description copied from interface: PdfAs

Create a signature profile dynamically. You have do apply() it for usage. See SignatureProfile.

Specified by:

createDynamicSignatureProfile in interface PdfAs

Parameters:

parentProfile - a parent profile id to inherit all properties

mode - lifetime mode

Returns:

the created signature profile to work with.

createDynamicSignatureProfile

public DynamicSignatureProfile createDynamicSignatureProfile(java.lang.String myUniqueName,
                                                    java.lang.String parentProfile,
                                                    DynamicSignatureLifetimeEnum mode)

Description copied from interface: PdfAs

Create a signature profile dynamically. You have to provide a unique name and have do apply() it for usage. See SignatureProfile. It is recommended to use PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that generates a unique name on its own.

Specified by:

createDynamicSignatureProfile in interface PdfAs

Parameters:

myUniqueName - a unique name for the profile

parentProfile - a parent profile id to inherit all properties

mode - lifetime mode

Returns:

the created signature profile to work with.

See Also:

DynamicSignatureProfile

createEmptyDynamicSignatureProfile

public DynamicSignatureProfile createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode)

Description copied from interface: PdfAs

Create a signature profile dynamically. You have fill it with properties and apply() it for usage. See SignatureProfile.
It is recommended to use PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that inherits from an existing profile saving you a lot of work.

Specified by:

createEmptyDynamicSignatureProfile in interface PdfAs

Parameters:

mode - lifetime mode

Returns:

the created signature profile to work with.

See Also:

DynamicSignatureProfile

createEmptyDynamicSignatureProfile

public DynamicSignatureProfile createEmptyDynamicSignatureProfile(java.lang.String myUniqueName,
                                                         DynamicSignatureLifetimeEnum mode)

Description copied from interface: PdfAs

Create a signature profile dynamically. You have fill it with properties and apply() it for usage. See SignatureProfile.
It is recommended to use PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that inherits from an existing profile saving you a lot of work.

Specified by:

createEmptyDynamicSignatureProfile in interface PdfAs

Parameters:

myUniqueName - a unique name for the profile

mode - lifetime mode

Returns:

the created signature profile to work with.

loadDynamicSignatureProfile

public DynamicSignatureProfile loadDynamicSignatureProfile(java.lang.String profileName)

Description copied from interface: PdfAs

Loads an existing dynamic signature profile by its name. Profiles are saved when they are applied and it has DynamicSignatureLifetimeEnum.MANUAL

Specified by:

loadDynamicSignatureProfile in interface PdfAs

Returns:

the signature profile or null if not found.

See Also:

DynamicSignatureProfile

prepareSign

public SignatureDetailInformation prepareSign(SignParameters signParameters)
                                       throws PdfAsException

Description copied from interface: PdfAs

Prepares the signature of the given PDF document. The table for the signature data is placed but not filled.
Usually used for preview.

Specified by:

prepareSign in interface PdfAs

Parameters:

signParameters - The sign parameters.

Returns:

Only the SignatureDetailInformation.getSignaturePosition(), SignatureDetailInformation.getNonTextualObjects(), SignatureDetailInformation.getSignatureData() are filled.

Throws:

PdfAsException - if something goes wrong during the process

finishSign

public SignResult finishSign(SignParameters signParameters,
                    SignatureDetailInformation signatureDetailInformation)
                      throws PdfAsException

Description copied from interface: PdfAs

Finish the signature process. The PDF is filled with the signature data.
Usually used if some steps like the actual signing are to be performed externally.

Specified by:

finishSign in interface PdfAs

Parameters:

signParameters - The sign parameters.

signatureDetailInformation - The signature detail information.

Returns:

Throws:

PdfAsException