|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectat.gv.egiz.pdfas.impl.api.PdfAsObject
public class PdfAsObject
Implementation of the PdfAs interface.
| Field Summary | |
|---|---|
static float |
DEFAULT_SIGNATURE_BLOCK_WIDTH_THRESHOLD
Minimal signature block width. |
| Constructor Summary | |
|---|---|
PdfAsObject()
This constructor is for internal use only - use PdfAsFactory instead. |
|
PdfAsObject(File workDirectory)
This constructor is for internal use only - use PdfAsFactory instead. |
|
PdfAsObject(File workDirectory,
boolean registerProvider)
This constructor is for internal use only - use PdfAsFactory instead. |
|
| 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. |
protected void |
fillAnalyzeParametersWithReconstructXMLDsigParameters(AnalyzeParameters ap,
ReconstructXMLDsigParameters rxp)
|
protected void |
fillAnalyzeParametersWithVerifyParameters(AnalyzeParameters ap,
VerifyParameters vp)
Copies all adequate parameters from the VerifyParameters to the
AnalyzeParameters. |
protected void |
fillReconstructXMLDsigAfterAnalysisParametersWithVerifyAfterAnalysisParameters(ReconstructXMLDsigAfterAnalysisParameters reconstructParams,
VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
|
protected void |
fillVerifyAfterAnalysisParametersWithVerifyParameters(VerifyAfterAnalysisParameters vaap,
VerifyParameters vp)
Copies all adequate parameters from the VerifyParameters to the
VerifyAfterAnalysisParameters. |
protected void |
fillVerifyAfterReconstructXMLDsigParametersWithVerifyAfterAnalysisParameters(VerifyAfterReconstructXMLDsigParameters varxp,
VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
|
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 name)
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 signatorInfo)
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final float DEFAULT_SIGNATURE_BLOCK_WIDTH_THRESHOLD
| Constructor Detail |
|---|
public PdfAsObject(File workDirectory)
throws PdfAsException
PdfAsFactory instead.
Note: IAIK JCE and IAIK ECC security providers are automatically registered.
workDirectory - The work directory.
PdfAsException - Thrown, if the configuration cannot be processed.
public PdfAsObject(File workDirectory,
boolean registerProvider)
throws PdfAsException
PdfAsFactory instead.
workDirectory - The work directory.registerProvider - true: automatically registers IAIK JCE and ECC Provider;
false: providers will NOT be automatically registered, providers
needed have to be registered by the API user
PdfAsException - Thrown, if the configuration cannot be processed.
public PdfAsObject()
throws PdfAsException
PdfAsFactory instead.
Note: IAIK JCE and IAIK ECC security providers are automatically registered.
PdfAsException - Thrown, if the configuration cannot be processed.| Method Detail |
|---|
public void reloadConfig()
throws PdfAsException
PdfAs
reloadConfig in interface PdfAsPdfAsException - Thrown, if an error occurs.PdfAs.reloadConfig()
public List getProfileInformation()
throws PdfAsException
PdfAsNote: 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.
getProfileInformation in interface PdfAsSignatureProfile objects with
information about active profiles available in the configuration.
PdfAsException - Thrown on error.PdfAs.getProfileInformation()
public SignResult sign(SignParameters signParameters)
throws PdfAsException
PdfAs
sign in interface PdfAssignParameters - The sign parameters.
PdfAsException - Thrown, if an error occurs.PdfAs.sign(at.gv.egiz.pdfas.api.sign.SignParameters)
public VerifyResults verify(VerifyParameters verifyParameters)
throws PdfAsException
PdfAs
verify in interface PdfAsverifyParameters - The verify parameters.
PdfAsException - Thrown, if an error occurs.PdfAs.verify(at.gv.egiz.pdfas.api.verify.VerifyParameters)
protected void fillAnalyzeParametersWithVerifyParameters(AnalyzeParameters ap,
VerifyParameters vp)
VerifyParameters to the
AnalyzeParameters.
ap - The AnalyzeParameters.vp - The VerifyParameters.
protected void fillAnalyzeParametersWithReconstructXMLDsigParameters(AnalyzeParameters ap,
ReconstructXMLDsigParameters rxp)
protected void fillVerifyAfterAnalysisParametersWithVerifyParameters(VerifyAfterAnalysisParameters vaap,
VerifyParameters vp)
VerifyParameters to the
VerifyAfterAnalysisParameters.
vaap - The VerifyAfterAnalysisParameters.vp - The VerifyParameters.
protected void fillReconstructXMLDsigAfterAnalysisParametersWithVerifyAfterAnalysisParameters(ReconstructXMLDsigAfterAnalysisParameters reconstructParams,
VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
public AnalyzeResult analyze(AnalyzeParameters analyzeParameters)
throws PdfAsException
PdfAs
analyze in interface PdfAsanalyzeParameters - The analyzation parameters.
PdfAsException - Thrown on error.PdfAs.analyze(at.gv.egiz.pdfas.api.analyze.AnalyzeParameters)
public VerifyResults verify(VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
throws PdfAsException
PdfAs
verify in interface PdfAsverifyAfterAnalysisParameters - The parameters.
PdfAsException - Thrown on error.PdfAs.verify(at.gv.egiz.pdfas.api.verify.VerifyAfterAnalysisParameters)
protected void fillVerifyAfterReconstructXMLDsigParametersWithVerifyAfterAnalysisParameters(VerifyAfterReconstructXMLDsigParameters varxp,
VerifyAfterAnalysisParameters verifyAfterAnalysisParameters)
public ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigParameters reconstructXMLDsigParameters)
throws PdfAsException
PdfAs
reconstructXMLDSIG in interface PdfAsreconstructXMLDsigParameters - The data from which to reconstruct the xmldsig
PdfAsException - if the reconstruction failsPdfAs.reconstructXMLDSIG(ReconstructXMLDsigParameters)
public ReconstructXMLDsigResult reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters reconstructXMLDsigParameters)
throws PdfAsException
PdfAs
reconstructXMLDSIG in interface PdfAsreconstructXMLDsigParameters - The data from which to reconstruct the xmldsigs
PdfAsExceptionPdfAs.reconstructXMLDSIG(ReconstructXMLDsigAfterAnalysisParameters)
public VerifyResults verify(VerifyAfterReconstructXMLDsigParameters verifyAfterReconstructXMLDsigParameters)
throws PdfAsException
PdfAs
verify in interface PdfAsverifyAfterReconstructXMLDsigParameters - The parameters.
PdfAsException - Thrown on error.PdfAs.verify(VerifyAfterReconstructXMLDsigParameters)
public DynamicSignatureProfile createDynamicSignatureProfile(String parentProfile,
DynamicSignatureLifetimeEnum mode)
PdfAsSignatureProfile.
createDynamicSignatureProfile in interface PdfAsparentProfile - a parent profile id to inherit all propertiesmode - lifetime mode
public DynamicSignatureProfile createEmptyDynamicSignatureProfile(DynamicSignatureLifetimeEnum mode)
PdfAsSignatureProfile.
PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that inherits from an
existing profile saving you a lot of work.
createEmptyDynamicSignatureProfile in interface PdfAsmode - lifetime mode
DynamicSignatureProfilepublic DynamicSignatureProfile loadDynamicSignatureProfile(String name)
PdfAsDynamicSignatureLifetimeEnum.MANUAL
loadDynamicSignatureProfile in interface PdfAsnull if not found.DynamicSignatureProfile
public DynamicSignatureProfile createDynamicSignatureProfile(String myUniqueName,
String parentProfile,
DynamicSignatureLifetimeEnum mode)
PdfAsSignatureProfile.
It is recommended to use PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that generates
a unique name on its own.
createDynamicSignatureProfile in interface PdfAsmyUniqueName - a unique name for the profileparentProfile - a parent profile id to inherit all propertiesmode - lifetime mode
DynamicSignatureProfile
public DynamicSignatureProfile createEmptyDynamicSignatureProfile(String myUniqueName,
DynamicSignatureLifetimeEnum mode)
PdfAsSignatureProfile.
PdfAs.createDynamicSignatureProfile(String, DynamicSignatureLifetimeEnum) that inherits from an
existing profile saving you a lot of work.
createEmptyDynamicSignatureProfile in interface PdfAsmyUniqueName - a unique name for the profilemode - lifetime mode
public SignatureDetailInformation prepareSign(SignParameters signParameters)
throws PdfAsException
PdfAs
prepareSign in interface PdfAssignParameters - The sign parameters.
SignatureDetailInformation.getSignaturePosition(), SignatureDetailInformation.getNonTextualObjects(), SignatureDetailInformation.getSignatureData() are filled.
PdfAsException - if something goes wrong during the processPdfAs.prepareSign(SignParameters)
public SignResult sign(SignParameters signParameters,
SignatureDetailInformation signatorInfo)
throws PdfAsException
PdfAsSignatorInformation which was obtained by a call to PdfAs.prepareSign(SignParameters)
sign in interface PdfAssignParameters - The sign parameters.signatorInfo - The signature information which was previously obtained by a call to PdfAs.prepareSign(SignParameters)
PdfAsException - Thrown, if an error occurs.SignParameters,
SignResult
public SignResult finishSign(SignParameters signParameters,
SignatureDetailInformation signatureDetailInformation)
throws PdfAsException
PdfAs
finishSign in interface PdfAssignParameters - 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 | |||||||||