at.gv.egiz.pdfas.api

Interface PdfAs

All Known Implementing Classes:

PdfAsObject

Deprecated.

@Deprecated
public interface PdfAs

The PDF-AS API main interface.

Create an Object implementing this interface using the proper factory.

Method Summary

Methods

Modifier and Type	Method and Description
AnalyzeResult	analyze(AnalyzeParameters analyzeParameters) Deprecated.
DynamicSignatureProfile	createDynamicSignatureProfile(java.lang.String parentProfile, DynamicSignatureLifetimeEnum mode) Deprecated.
DynamicSignatureProfile	createDynamicSignatureProfile(java.lang.String myUniqueName, java.lang.String parentProfile, DynamicSignatureLifetimeEnum mode) Deprecated.
DynamicSignatureProfile	createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode) Deprecated.
DynamicSignatureProfile	createEmptyDynamicSignatureProfile(java.lang.String myUniqueName, DynamicSignatureLifetimeEnum mode) Deprecated.
SignResult	finishSign(SignParameters signParameters, SignatureDetailInformation signatureDetailInformation) Deprecated.
java.util.List	getProfileInformation() Deprecated.
DynamicSignatureProfile	loadDynamicSignatureProfile(java.lang.String profileName) Deprecated.
SignatureDetailInformation	prepareSign(SignParameters signParameters) Deprecated.
ReconstructXMLDsigResult	reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters reconstructXMLDsigParameters) Deprecated.
ReconstructXMLDsigResult	reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters) Deprecated.
void	reloadConfig() Deprecated.
SignResult	sign(SignParameters signParameters) Deprecated.
SignResult	sign(SignParameters signParameters, SignatureDetailInformation signatureDetailInformation) Deprecated.
VerifyResults	verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters) Deprecated.
VerifyResults	verify(VerifyAfterReconstructXMLDsigParameters verifyAfterReconstructXMLDsigParameters) Deprecated.
VerifyResults	verify(VerifyParameters verifyParameters) Deprecated.

Method Detail

sign

@Deprecated
SignResult sign(SignParameters signParameters)
                throws PdfAsException

Deprecated.

Signs a PDF document using PDF-AS.

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

@Deprecated
SignResult sign(SignParameters signParameters,
                         SignatureDetailInformation signatureDetailInformation)
                throws PdfAsException

Deprecated.

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

Parameters:

signParameters - The sign parameters.

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

Returns:

Returns the signed document plus additional information.

Throws:

PdfAsException - Thrown, if an error occurs.

See Also:

SignParameters, SignResult

verify

@Deprecated
VerifyResults verify(VerifyParameters verifyParameters)
                     throws PdfAsException

Deprecated.

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

Parameters:

verifyParameters - The verify parameters.

Returns:

Returns the verification results.

Throws:

PdfAsException - Thrown, if an error occurs.

See Also:

VerifyParameters, VerifyResults, VerifyResult

analyze

@Deprecated
AnalyzeResult analyze(AnalyzeParameters analyzeParameters)
                      throws PdfAsException

Deprecated.

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

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

@Deprecated
ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters)
                                            throws PdfAsException

Deprecated.

Reconstruct the from the given parameters.

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

@Deprecated
ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters reconstructXMLDsigParameters)
                                            throws PdfAsException

Deprecated.

Reconstruct the from the given parameters.

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

@Deprecated
VerifyResults verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
                     throws PdfAsException

Deprecated.

Verifies a list of signatures that have been analyzed previously.

Parameters:

verifyAfterAnalysisParameters - The parameters.

Returns:

Returns the verification results.

Throws:

PdfAsException - Thrown on error.

See Also:

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

verify

@Deprecated
VerifyResults verify(VerifyAfterReconstructXMLDsigParameters verifyAfterReconstructXMLDsigParameters)
                     throws PdfAsException

Deprecated.

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

Parameters:

verifyAfterReconstructXMLDsigParameters - The parameters.

Returns:

the verification results.

Throws:

PdfAsException - Thrown on error.

reloadConfig

@Deprecated
void reloadConfig()
                  throws PdfAsException

Deprecated.

Reloads the configuration from the work directory.

Throws:

PdfAsException - Thrown, if an error occurs.

getProfileInformation

@Deprecated
java.util.List getProfileInformation()
                                     throws PdfAsException

Deprecated.

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.

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

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

Deprecated.

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

Parameters:

parentProfile - a parent profile id to inherit all properties

mode - lifetime mode

Returns:

the created signature profile to work with.

createDynamicSignatureProfile

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

Deprecated.

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 createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that generates a unique name on its own.

Parameters:

parentProfile - a parent profile id to inherit all properties

myUniqueName - a unique name for the profile

mode - lifetime mode

Returns:

the created signature profile to work with.

See Also:

DynamicSignatureProfile

createEmptyDynamicSignatureProfile

@Deprecated
DynamicSignatureProfile createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode)

Deprecated.

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

Parameters:

mode - lifetime mode

Returns:

the created signature profile to work with.

See Also:

DynamicSignatureProfile

createEmptyDynamicSignatureProfile

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

Deprecated.

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

Parameters:

myUniqueName - a unique name for the profile

mode - lifetime mode

Returns:

the created signature profile to work with.

loadDynamicSignatureProfile

@Deprecated
DynamicSignatureProfile loadDynamicSignatureProfile(java.lang.String profileName)

Deprecated.

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

Parameters:

profileName -

Returns:

the signature profile or null if not found.

See Also:

DynamicSignatureProfile

prepareSign

@Deprecated
SignatureDetailInformation prepareSign(SignParameters signParameters)
                                       throws PdfAsException

Deprecated.

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

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

@Deprecated
SignResult finishSign(SignParameters signParameters,
                               SignatureDetailInformation signatureDetailInformation)
                      throws PdfAsException

Deprecated.

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.

Parameters:

signParameters - The sign parameters.

signatureDetailInformation - The signature detail information.

Returns:

Throws:

PdfAsException