|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface PdfAs
The PDF-AS API main interface.
Create an Object implementing this interface using the proper factory.
| Method Summary | |
|---|---|
AnalyzeResult |
analyze(AnalyzeParameters analyzeParameters)
Analyzes a document for signatures and returns a verify-able list of such. |
DynamicSignatureProfile |
createDynamicSignatureProfile(String parentProfile,
DynamicSignatureLifetimeEnum mode)
Create a signature profile dynamically. |
DynamicSignatureProfile |
createDynamicSignatureProfile(String myUniqueName,
String parentProfile,
DynamicSignatureLifetimeEnum mode)
Create a signature profile dynamically. |
DynamicSignatureProfile |
createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode)
Create a signature profile dynamically. |
DynamicSignatureProfile |
createEmptyDynamicSignatureProfile(String myUniqueName,
DynamicSignatureLifetimeEnum mode)
Create a signature profile dynamically. |
SignResult |
finishSign(SignParameters signParameters,
SignatureDetailInformation signatureDetailInformation)
Finish the signature process. |
List |
getProfileInformation()
Returns the list of information objects about activated profiles available in the configuration. |
DynamicSignatureProfile |
loadDynamicSignatureProfile(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 |
ReconstructXMLDsigResult |
reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters)
Reconstruct the |
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. |
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. |
| Method Detail |
|---|
SignResult sign(SignParameters signParameters)
throws PdfAsException
signParameters - The sign parameters.
PdfAsException - Thrown, if an error occurs.SignParameters,
SignResult
SignResult sign(SignParameters signParameters,
SignatureDetailInformation signatureDetailInformation)
throws PdfAsException
SignatorInformation which was obtained by a call to prepareSign(SignParameters)
signParameters - The sign parameters.signatureDetailInformation - The signature information which was previously obtained by a call to prepareSign(SignParameters)
PdfAsException - Thrown, if an error occurs.SignParameters,
SignResult
VerifyResults verify(VerifyParameters verifyParameters)
throws PdfAsException
verifyParameters - The verify parameters.
PdfAsException - Thrown, if an error occurs.VerifyParameters,
VerifyResults,
VerifyResult
AnalyzeResult analyze(AnalyzeParameters analyzeParameters)
throws PdfAsException
analyzeParameters - The analyzation parameters.
PdfAsException - Thrown on error.AnalyzeParameters,
AnalyzeResult,
#verify(AnalyzeResult)}
ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters)
throws PdfAsException
reconstructXMLDsigParameters - The data from which to reconstruct the xmldsig
PdfAsException - if the reconstruction fails
ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters reconstructXMLDsigParameters)
throws PdfAsException
reconstructXMLDsigParameters - The data from which to reconstruct the xmldsigs
PdfAsException
VerifyResults verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
throws PdfAsException
verifyAfterAnalysisParameters - The parameters.
PdfAsException - Thrown on error.AnalyzeResult,
VerifyAfterAnalysisParameters,
VerifyResults,
VerifyResult,
#analyze(AnalyzeParameters)}
VerifyResults verify(VerifyAfterReconstructXMLDsigParameters verifyAfterReconstructXMLDsigParameters)
throws PdfAsException
verifyAfterReconstructXMLDsigParameters - The parameters.
PdfAsException - Thrown on error.
void reloadConfig()
throws PdfAsException
PdfAsException - Thrown, if an error occurs.
List getProfileInformation()
throws PdfAsException
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.
SignatureProfile objects with
information about active profiles available in the configuration.
PdfAsException - Thrown on error.SignatureProfile
DynamicSignatureProfile createDynamicSignatureProfile(String parentProfile,
DynamicSignatureLifetimeEnum mode)
SignatureProfile.
parentProfile - a parent profile id to inherit all propertiesmode - lifetime mode
DynamicSignatureProfile createDynamicSignatureProfile(String myUniqueName,
String parentProfile,
DynamicSignatureLifetimeEnum mode)
SignatureProfile.
It is recommended to use createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that generates
a unique name on its own.
parentProfile - a parent profile id to inherit all propertiesmyUniqueName - a unique name for the profilemode - lifetime mode
DynamicSignatureProfileDynamicSignatureProfile createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode)
SignatureProfile.
createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that inherits from an
existing profile saving you a lot of work.
mode - lifetime mode
DynamicSignatureProfile
DynamicSignatureProfile createEmptyDynamicSignatureProfile(String myUniqueName,
DynamicSignatureLifetimeEnum mode)
SignatureProfile.
createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that inherits from an
existing profile saving you a lot of work.
myUniqueName - a unique name for the profilemode - lifetime mode
DynamicSignatureProfile loadDynamicSignatureProfile(String profileName)
DynamicSignatureLifetimeEnum.MANUAL
profileName -
null if not found.DynamicSignatureProfile
SignatureDetailInformation prepareSign(SignParameters signParameters)
throws PdfAsException
signParameters - The sign parameters.
SignatureDetailInformation.getSignaturePosition(), SignatureDetailInformation.getNonTextualObjects(), SignatureDetailInformation.getSignatureData() are filled.
PdfAsException - if something goes wrong during the process
SignResult finishSign(SignParameters signParameters,
SignatureDetailInformation signatureDetailInformation)
throws PdfAsException
signParameters - The sign parameters.signatureDetailInformation - The signature detail information.
PdfAsException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||