From 87c9269152f8c631123525b796cf07dc0cca7398 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Wed, 5 Feb 2014 09:20:54 +0100 Subject: Documentation + Documentation building --- docs/index-all.html | 576 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 576 insertions(+) create mode 100644 docs/index-all.html (limited to 'docs/index-all.html') diff --git a/docs/index-all.html b/docs/index-all.html new file mode 100644 index 00000000..093e71af --- /dev/null +++ b/docs/index-all.html @@ -0,0 +1,576 @@ + + + + + + +Index (PDF-AS 4.0.0-SNAPSHOT Library) + + + + + + + +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+ + +
A B C D F G H I L M N P S T V  + + +

A

+
+
at.gv.egiz.pdfas.lib.api - package at.gv.egiz.pdfas.lib.api
+
 
+
at.gv.egiz.pdfas.lib.api.sign - package at.gv.egiz.pdfas.lib.api.sign
+
 
+
at.gv.egiz.pdfas.lib.api.verify - package at.gv.egiz.pdfas.lib.api.verify
+
 
+
+ + + +

B

+
+
bos - Variable in class at.gv.egiz.pdfas.lib.api.ByteArrayDataSink
+
 
+
ByteArrayDataSink - Class in at.gv.egiz.pdfas.lib.api
+
+
A simple byte array data sink
+
+
ByteArrayDataSink() - Constructor for class at.gv.egiz.pdfas.lib.api.ByteArrayDataSink
+
 
+
ByteArrayDataSource - Class in at.gv.egiz.pdfas.lib.api
+
+
A simple byte array data source
+
+
ByteArrayDataSource(byte[]) - Constructor for class at.gv.egiz.pdfas.lib.api.ByteArrayDataSource
+
 
+
+ + + +

C

+
+
Configuration - Interface in at.gv.egiz.pdfas.lib.api
+
+
Configuration interface + + This interface is used to configure one PDF-AS run.
+
+
createOutputStream() - Method in class at.gv.egiz.pdfas.lib.api.ByteArrayDataSink
+
 
+
createOutputStream() - Method in interface at.gv.egiz.pdfas.lib.api.DataSink
+
+
Creates an output stream to receive the data
+
+
createPdfAs(File) - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
+
Create a new instance of PDF-AS
+
+
createSignParameter(Configuration, DataSource) - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
+
Creates a sign parameter
+
+
createVerifyParameter(Configuration, DataSource) - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
+
Creates a verification parameter
+
+
+ + + +

D

+
+
DataSink - Interface in at.gv.egiz.pdfas.lib.api
+
+
Data Sink interface.
+
+
DataSource - Interface in at.gv.egiz.pdfas.lib.api
+
+
Data Source interface + + All data sources in PDF-AS implement this interface.
+
+
DEFAULT - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
DEFAULT_SIGNATURE_PROFILE - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
deployDefaultConfiguration(File) - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
+
Deploy default configuration to targetDirectory + + The targetDirectory will be deleted and
+
+
dontConfigureLog4j() - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
 
+
+ + + +

F

+
+
FALSE - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
finishSign(StatusRequest) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAs
+
+
Finishes a signature process
+
+
+ + + +

G

+
+
getByteData() - Method in class at.gv.egiz.pdfas.lib.api.ByteArrayDataSource
+
 
+
getByteData() - Method in interface at.gv.egiz.pdfas.lib.api.DataSource
+
+
Gets the contained data
+
+
getCertificate() - Method in interface at.gv.egiz.pdfas.lib.api.sign.IPlainSigner
+
+
Gets the signing certificate
+
+
getCertificateCheck() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Returns the result of the certificate check.
+
+
getCode() - Method in interface at.gv.egiz.pdfas.lib.api.verify.SignatureCheck
+
+
Returns the response code of the check.
+
+
getConfiguration() - Method in interface at.gv.egiz.pdfas.lib.api.PdfAs
+
+
Gets a copy of the PDF-AS configuration, to allow the application to + override configuration parameters at runtime.
+
+
getConfiguration() - Method in interface at.gv.egiz.pdfas.lib.api.PdfAsParameter
+
+
Gets the configuration associated with the parameter
+
+
getData() - Method in class at.gv.egiz.pdfas.lib.api.ByteArrayDataSink
+
+
Returns the output data
+
+
getDataSource() - Method in interface at.gv.egiz.pdfas.lib.api.PdfAsParameter
+
+
Gets the data source of the parameter
+
+
getHeight() - Method in interface at.gv.egiz.pdfas.lib.api.SignaturePosition
+
+
Returns the height of the signature.
+
+
getManifestCheckCode() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Returns the result of the manifest check.
+
+
getMessage() - Method in interface at.gv.egiz.pdfas.lib.api.verify.SignatureCheck
+
+
Returns the textual response message of the check (corresponding to the + code).
+
+
getMIMEType() - Method in class at.gv.egiz.pdfas.lib.api.ByteArrayDataSource
+
 
+
getMIMEType() - Method in interface at.gv.egiz.pdfas.lib.api.DataSource
+
+
Gets the MIME Type of the contained data.
+
+
getOutput() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Gets the data sink for the signature process
+
+
getOutputDocument() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignResult
+
+
Returns the filled output data sink.
+
+
getPage() - Method in interface at.gv.egiz.pdfas.lib.api.SignaturePosition
+
+
Returns the page on which the signature was placed.
+
+
getPDFFilter() - Method in interface at.gv.egiz.pdfas.lib.api.sign.IPlainSigner
+
+
Gets the PDF Filter for this signer
+
+
getPDFSubFilter() - Method in interface at.gv.egiz.pdfas.lib.api.sign.IPlainSigner
+
+
Gets the PDF Subfilter for this signer
+
+
getPlainSigner() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Gets the signer to use.
+
+
getSCMRevision() - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
+
Gets the PDF-AS SCM Revision
+
+
getSignatureData() - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
Gets the data to be signed
+
+
getSignatureData() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Gets the signed data for the signature
+
+
getSignatureDataByteRange() - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
Gets the byte range of the data to be signed
+
+
getSignaturePosition() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Gets the signature position
+
+
getSignaturePosition() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignResult
+
+
Returns the position where the signature is finally placed.
+
+
getSignatureProfileId() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Gets the signature profile to use
+
+
getSignerCertificate() - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignResult
+
+
Returns the certificate of the signer.
+
+
getSignerCertificate() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Gets the signer certificate
+
+
getValue(String) - Method in interface at.gv.egiz.pdfas.lib.api.Configuration
+
+
Gets a specific Value
+
+
getValueCheckCode() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Returns the result of the value (and hash) check.
+
+
getVerificationException() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Returns a verification exception if any.
+
+
getVerificationTime() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyParameter
+
+
Gets the verification time
+
+
getVersion() - Static method in class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
+
Gets the PDF-AS Version
+
+
getWhichSignature() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyParameter
+
+
Gets which signature should be verified + + This is a 0 based index of the signatures
+
+
getWidth() - Method in interface at.gv.egiz.pdfas.lib.api.SignaturePosition
+
+
Returns the width of the signature.
+
+
getX() - Method in interface at.gv.egiz.pdfas.lib.api.SignaturePosition
+
+
Returns the x position.
+
+
getY() - Method in interface at.gv.egiz.pdfas.lib.api.SignaturePosition
+
+
Returns the y position.
+
+
+ + + +

H

+
+
hasValue(String) - Method in interface at.gv.egiz.pdfas.lib.api.Configuration
+
+
Is the configuration key set
+
+
+ + + +

I

+
+
IConfigurationConstants - Interface in at.gv.egiz.pdfas.lib.api
+
 
+
IPlainSigner - Interface in at.gv.egiz.pdfas.lib.api.sign
+
+
Signer interface + + PDF-AS uses an IPlainSigner instance to create the signature.
+
+
isQualifiedCertificate() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Returns true, if the signer's certificate is a qualified certificate.
+
+
isReady() - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
If true finishSign in PdfAs can be called to retrieve the signed pdf
+
+
isVerificationDone() - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyResult
+
+
Returns if the verification was possible or could not even be startet.
+
+
+ + + +

L

+
+
LEGACY_POSITIONING - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
+ + + +

M

+
+
MAIN - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
+ + + +

N

+
+
needCertificate() - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
If true PDF-AS requires the signature certificate + + Retrieve the signing certificate and set it via setCertificate
+
+
needSignature() - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
If true PDF-AS requires a the CAdES signature + + use getSignatureData() and getSignatureDataByteRange() to retrieve the + data to be signed and set the signature via setSigature
+
+
+ + + +

P

+
+
PdfAs - Interface in at.gv.egiz.pdfas.lib.api
+
 
+
PdfAsFactory - Class in at.gv.egiz.pdfas.lib.api
+
 
+
PdfAsFactory() - Constructor for class at.gv.egiz.pdfas.lib.api.PdfAsFactory
+
 
+
PdfAsParameter - Interface in at.gv.egiz.pdfas.lib.api
+
 
+
PLACEHOLDER_SEARCH_ENABLED - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
POS - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
process(StatusRequest) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAs
+
+
Continues an ongoing signature process
+
+
+ + + +

S

+
+
SEPERATOR - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
setCertificate(byte[]) - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
Sets the signing certificate
+
+
setConfiguration(Configuration) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAsParameter
+
+
Sets the configuration associated with the parameter
+
+
setDataSource(DataSource) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAsParameter
+
+
Sets the data source of the parameter
+
+
setOutput(DataSink) - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Sets the data sink for the signature process
+
+
setPlainSigner(IPlainSigner) - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Sets the signer to use
+
+
setSigature(byte[]) - Method in interface at.gv.egiz.pdfas.lib.api.StatusRequest
+
+
Sets the signature
+
+
setSignaturePosition(String) - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Sets the signature position
+
+
setSignatureProfileId(String) - Method in interface at.gv.egiz.pdfas.lib.api.sign.SignParameter
+
+
Sets the signature profile to use
+
+
setValue(String, String) - Method in interface at.gv.egiz.pdfas.lib.api.Configuration
+
+
Sets or overrides a configuration value
+
+
setVerificationTime(Date) - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyParameter
+
+
Sets the verification time.
+
+
setWhichSignature(int) - Method in interface at.gv.egiz.pdfas.lib.api.verify.VerifyParameter
+
+
Sets which signature should be verified + + This is a 0 based index of the signatures
+
+
SIG_OBJECT - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
sign(SignParameter) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAs
+
+
Signs a PDF document using PDF-AS.
+
+
sign(byte[], int[]) - Method in interface at.gv.egiz.pdfas.lib.api.sign.IPlainSigner
+
+
Sign the document
+
+
SignatureCheck - Interface in at.gv.egiz.pdfas.lib.api.verify
+
 
+
SignaturePosition - Interface in at.gv.egiz.pdfas.lib.api
+
 
+
SignParameter - Interface in at.gv.egiz.pdfas.lib.api.sign
+
 
+
SignResult - Interface in at.gv.egiz.pdfas.lib.api.sign
+
 
+
startSign(SignParameter) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAs
+
+
Starts a signature process + + After the process has to be startet the status request has to be services by the user application
+
+
StatusRequest - Interface in at.gv.egiz.pdfas.lib.api
+
+
Status of a signture process
+
+
+ + + +

T

+
+
TABLE - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
TRUE - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
TYPE - Static variable in interface at.gv.egiz.pdfas.lib.api.IConfigurationConstants
+
 
+
+ + + +

V

+
+
verify(VerifyParameter) - Method in interface at.gv.egiz.pdfas.lib.api.PdfAs
+
+
Verifies a document with (potentially multiple) PDF-AS signatures.
+
+
VerifyParameter - Interface in at.gv.egiz.pdfas.lib.api.verify
+
 
+
VerifyResult - Interface in at.gv.egiz.pdfas.lib.api.verify
+
 
+
+A B C D F G H I L M N P S T V 
+ +
+ + + + + +
PDF-AS 4.0.0-SNAPSHOT Library 4.0.0-SNAPSHOT [6b692931c81fd0e09d8d21eb81e05a5f08af8342]
+
+ + + + -- cgit v1.2.3