at.gv.egiz.pdfas.api
Interface PdfAs

All Known Implementing Classes:

PdfAsObject

public interface PdfAs

The PDF-AS API main interface.

Create an Object implementing this interface using the proper factory.

Author:

wprinz

Method Summary

AnalyzeResult	analyze(AnalyzeParameters analyzeParameters) Analyzes a document for signatures and returns a verify-able list of such.
List	getProfileInformation() Returns the list of information objects about the profiles available in the configuration.
void	reloadConfig() Reloads the configuration from the work directory.
SignResult	sign(SignParameters signParameters) Signs a PDF document using PDF-AS.
VerifyResults	verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters) Verifies a list of signatures that have been analyzed previously.
VerifyResults	verify(VerifyParameters verifyParameters) Verifies a document with (potentially multiple) PDF-AS signatures.

Method Detail

sign

public SignResult sign(SignParameters signParameters)
                throws PdfAsException

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

verify

public VerifyResults verify(VerifyParameters verifyParameters)
                     throws PdfAsException

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

public AnalyzeResult analyze(AnalyzeParameters analyzeParameters)
                      throws PdfAsException

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, {@link #verify(AnalyzeResult)}

verify

public VerifyResults verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
                     throws PdfAsException

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, {@link #analyze(AnalyzeParameters)}

reloadConfig

public void reloadConfig()
                  throws PdfAsException

Reloads the configuration from the work directory.

Throws:

PdfAsException - Thrown, if an error occurs.

getProfileInformation

public List getProfileInformation()
                           throws PdfAsException

Returns the list of information objects about the 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 the profiles available in the configuration.

Throws:

PdfAsException - Thrown on error.

See Also:

SignatureProfile