IPlainSigner (PDF-AS 4.0.0-RC5 Library)

-
-
-
```
public interface IPlainSigner
```
-
Signer interface - - PDF-AS uses an IPlainSigner instance to create the signature. Also custom IPlainSigner - may be used to sign PDF-AS documents.
-

- -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`iaik.x509.X509Certificate`	`getCertificate(SignParameter parameter)` - Gets the signing certificate -
`String`	`getPDFFilter()` - Gets the PDF Filter for this signer -
`String`	`getPDFSubFilter()` - Gets the PDF Subfilter for this signer -
`byte[]`	`sign(byte[] input, - int[] byteRange, - SignParameter parameter)` - Sign the document -

- -
- - - -
  Method Detail
  - - - -
  - -
    getCertificate
    -
```
iaik.x509.X509Certificate getCertificate(SignParameter parameter)
-                                         throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
```
    -
    Gets the signing certificate
    -
    Returns:
    -
    Throws:
    -
    at.gv.egiz.pdfas.common.exceptions.PdfAsException
    -
  - - - -
  - -
    sign
    -
```
byte[] sign(byte[] input,
-          int[] byteRange,
-          SignParameter parameter)
-            throws at.gv.egiz.pdfas.common.exceptions.PdfAsException
```
    -
    Sign the document
    -
    Parameters:
    input -
    byteRange -
    -
    Returns:
    -
    Throws:
    -
    at.gv.egiz.pdfas.common.exceptions.PdfAsException
    -
  - - - -
  - -
    getPDFSubFilter
    -
```
String getPDFSubFilter()
```
    -
    Gets the PDF Subfilter for this signer
    -
    Returns:
    -
  - - - -
  - -
    getPDFFilter
    -
```
String getPDFFilter()
```
    -
    Gets the PDF Filter for this signer
    -
    Returns:
    -
  -
-

-
-
All Superinterfaces:
-
PdfAsParameter
-
-
-
All Known Implementing Classes:
-
SignParameterImpl
-
-
-
-
```
public interface SignParameter
-extends PdfAsParameter
```
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`DataSink`	`getOutput()` - Gets the data sink for the signature process -
`IPlainSigner`	`getPlainSigner()` - Gets the signer to use. -
`String`	`getSignaturePosition()` - Gets the signature position -
`String`	`getSignatureProfileId()` - Gets the signature profile to use -
`void`	`setOutput(DataSink output)` - Sets the data sink for the signature process -
`void`	`setPlainSigner(IPlainSigner signer)` - Sets the signer to use -
`void`	`setSignaturePosition(String signaturePosition)` - Sets the signature position -
`void`	`setSignatureProfileId(String signatureProfileId)` - Sets the signature profile to use -

- - -
Methods inherited from interface at.gv.egiz.pdfas.lib.api.PdfAsParameter
-getConfiguration, getDataSource, getTransactionId, setConfiguration, setDataSource, setTransactionId

- -
- - - -
  Method Detail
  - - - -
  - -
    getSignatureProfileId
    -
```
String getSignatureProfileId()
```
    -
    Gets the signature profile to use
    -
    Returns:
    -
  - - - -
  - -
    setSignatureProfileId
    -
```
void setSignatureProfileId(String signatureProfileId)
```
    -
    Sets the signature profile to use
    -
    Parameters:
    signatureProfileId - The signature profile
    -
  - - - -
  - -
    getSignaturePosition
    -
```
String getSignaturePosition()
```
    -
    Gets the signature position
    -
    Returns:
    -
  - - - -
  - -
    setSignaturePosition
    -
```
void setSignaturePosition(String signaturePosition)
```
    -
    Sets the signature position
    -
    Parameters:
    signaturePosition - The signature position string
    -
  - - - -
  - -
    setOutput
    -
```
void setOutput(DataSink output)
```
    -
    Sets the data sink for the signature process
    -
    Parameters:
    output -
    -
  - - - -
  - -
    getOutput
    -
```
DataSink getOutput()
```
    -
    Gets the data sink for the signature process
    -
    Returns:
    -
  - - - -
  - -
    setPlainSigner
    -
```
void setPlainSigner(IPlainSigner signer)
```
    -
    Sets the signer to use
    -
    Parameters:
    signer -
    -
  - - - -
  - -
    getPlainSigner
    -
```
IPlainSigner getPlainSigner()
```
    -
    Gets the signer to use.
    -
    Returns:
    -
  -
-

-
-
All Known Implementing Classes:
-
SignResultImpl
-
-
-
-
```
public interface SignResult
```
-

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`DataSink`	`getOutputDocument()` - Returns the filled output data sink. -
`SignaturePosition`	`getSignaturePosition()` - Returns the position where the signature is finally placed. -
`X509Certificate`	`getSignerCertificate()` - Returns the certificate of the signer. -

- -
- - - -
  Method Detail
  - - - -
  - -
    getOutputDocument
    -
```
DataSink getOutputDocument()
```
    -
    Returns the filled output data sink.
    -
    Returns:
    Returns the filled output data sink.
    -
  - - - -
  - -
    getSignerCertificate
    -
```
X509Certificate getSignerCertificate()
```
    -
    Returns the certificate of the signer.
    -
    Returns:
    Returns the certificate of the signer.
    -
  - - - -
  - -
    getSignaturePosition
    -
```
SignaturePosition getSignaturePosition()
```
    -
    Returns the position where the signature is finally placed. - -
    - This information can be useful for post-processing the document. -
    - -
    - Consult the PDF-AS documentation section Commandline for further - information about positioning. -
    -
    Returns:
    Returns the position where the signature is finally placed. May - return null if no position information is available.
    -
  -
-

- - - - - - - - - - - - - - - - - - - - -
Packages that use IPlainSigner
Package Description
at.gv.egiz.pdfas.lib.api.sign
at.gv.egiz.pdfas.lib.impl
at.gv.egiz.pdfas.lib.impl.signing.pdfbox
-

Packages that use IPlainSigner
Package	Description
at.gv.egiz.pdfas.lib.api.sign
at.gv.egiz.pdfas.lib.impl
at.gv.egiz.pdfas.lib.impl.signing.pdfbox

- - -
Uses of IPlainSigner in at.gv.egiz.pdfas.lib.api.sign
- - - - - - - - - - - - -
Methods in at.gv.egiz.pdfas.lib.api.sign that return IPlainSigner
Modifier and Type Method and Description
IPlainSigner SignParameter.getPlainSigner() -
Gets the signer to use.
-
- - - - - - - - - - - - -
Methods in at.gv.egiz.pdfas.lib.api.sign with parameters of type IPlainSigner
Modifier and Type Method and Description
void SignParameter.setPlainSigner(IPlainSigner signer) -
Sets the signer to use
-
-
- - -
Uses of IPlainSigner in at.gv.egiz.pdfas.lib.impl
- - - - - - - - - - - - -
Fields in at.gv.egiz.pdfas.lib.impl declared as IPlainSigner
Modifier and Type Field and Description
protected IPlainSigner SignParameterImpl.signer
- - - - - - - - - - - - -
Methods in at.gv.egiz.pdfas.lib.impl that return IPlainSigner
Modifier and Type Method and Description
IPlainSigner SignParameterImpl.getPlainSigner()
- - - - - - - - - - - - -
Methods in at.gv.egiz.pdfas.lib.impl with parameters of type IPlainSigner
Modifier and Type Method and Description
void SignParameterImpl.setPlainSigner(IPlainSigner signer)
-

Methods in at.gv.egiz.pdfas.lib.api.sign that return IPlainSigner
Modifier and Type	Method and Description
`IPlainSigner`	SignParameter.`getPlainSigner()` - Gets the signer to use. -

Methods in at.gv.egiz.pdfas.lib.api.sign with parameters of type IPlainSigner
Modifier and Type	Method and Description
`void`	SignParameter.`setPlainSigner(IPlainSigner signer)` - Sets the signer to use -

Fields in at.gv.egiz.pdfas.lib.impl declared as IPlainSigner
Modifier and Type	Field and Description
`protected IPlainSigner`	SignParameterImpl.`signer`

Methods in at.gv.egiz.pdfas.lib.impl that return IPlainSigner
Modifier and Type	Method and Description
`IPlainSigner`	SignParameterImpl.`getPlainSigner()`

Methods in at.gv.egiz.pdfas.lib.impl with parameters of type IPlainSigner
Modifier and Type	Method and Description
`void`	SignParameterImpl.`setPlainSigner(IPlainSigner signer)`

- - -

Uses of IPlainSigner in at.gv.egiz.pdfas.lib.impl.signing.pdfbox

- - - - - - - - - - -

Constructors in at.gv.egiz.pdfas.lib.impl.signing.pdfbox with parameters of type IPlainSigner
Constructor and Description
`PdfboxSignerWrapper(IPlainSigner signer, - SignParameter parameters)`

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Packages that use SignParameter
Package	Description
at.gv.egiz.pdfas.lib.api
at.gv.egiz.pdfas.lib.api.sign
at.gv.egiz.pdfas.lib.impl
at.gv.egiz.pdfas.lib.impl.signing.pdfbox
at.gv.egiz.pdfas.lib.impl.status
at.gv.egiz.sl.util

- - -

Uses of SignParameter in at.gv.egiz.pdfas.lib.api

- - - - - - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.api that return SignParameter
Modifier and Type	Method and Description
`static SignParameter`	PdfAsFactory.`createSignParameter(Configuration configuration, - DataSource dataSource)` - Creates a sign parameter -
`SignParameter`	StatusRequest.`getSignParameter()`

- - - - - - - - - - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.api with parameters of type SignParameter
Modifier and Type	Method and Description
`Image`	PdfAs.`generateVisibleSignaturePreview(SignParameter parameter, - iaik.x509.X509Certificate cert, - int resolution)` - Generates a Image of the visual signatur block as Preview -
`SignResult`	PdfAs.`sign(SignParameter parameter)` - Signs a PDF document using PDF-AS. -
`StatusRequest`	PdfAs.`startSign(SignParameter parameter)` - Starts a signature process - - After the process has to be startet the status request has to be services by the user application -

- - -

Uses of SignParameter in at.gv.egiz.pdfas.lib.api.sign

- - - - - - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.api.sign with parameters of type SignParameter
Modifier and Type	Method and Description
`iaik.x509.X509Certificate`	IPlainSigner.`getCertificate(SignParameter parameter)` - Gets the signing certificate -
`byte[]`	IPlainSigner.`sign(byte[] input, - int[] byteRange, - SignParameter parameter)` - Sign the document -

- - -

Uses of SignParameter in at.gv.egiz.pdfas.lib.impl

- - - - - - - - - - - - -

Classes in at.gv.egiz.pdfas.lib.impl that implement SignParameter
Modifier and Type	Class and Description
`class`	`SignParameterImpl`

- - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.impl that return SignParameter
Modifier and Type	Method and Description
`SignParameter`	StatusRequestImpl.`getSignParameter()`

- - - - - - - - - - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.impl with parameters of type SignParameter
Modifier and Type	Method and Description
`Image`	PdfAsImpl.`generateVisibleSignaturePreview(SignParameter parameter, - iaik.x509.X509Certificate cert, - int resolution)`
`SignResult`	PdfAsImpl.`sign(SignParameter parameter)`
`StatusRequest`	PdfAsImpl.`startSign(SignParameter parameter)`

- - -

Uses of SignParameter in at.gv.egiz.pdfas.lib.impl.signing.pdfbox

- - - - - - - - - - -

Constructors in at.gv.egiz.pdfas.lib.impl.signing.pdfbox with parameters of type SignParameter
Constructor and Description
`PdfboxSignerWrapper(IPlainSigner signer, - SignParameter parameters)`

- - -

Uses of SignParameter in at.gv.egiz.pdfas.lib.impl.status

- - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.impl.status that return SignParameter
Modifier and Type	Method and Description
`SignParameter`	OperationStatus.`getSignParamter()`

- - - - - - - - - - - - -

Methods in at.gv.egiz.pdfas.lib.impl.status with parameters of type SignParameter
Modifier and Type	Method and Description
`void`	OperationStatus.`setSignParamter(SignParameter signParamter)`

- - - - - - - - - - -

Constructors in at.gv.egiz.pdfas.lib.impl.status with parameters of type SignParameter
Constructor and Description
`OperationStatus(at.gv.egiz.pdfas.common.settings.ISettings configuration, - SignParameter signParameter)`

- - -

Uses of SignParameter in at.gv.egiz.sl.util

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods in at.gv.egiz.sl.util with parameters of type SignParameter
Modifier and Type	Method and Description
`RequestPackage`	BaseSLConnector.`createCMSRequest(byte[] signatureData, - int[] byteRange, - SignParameter parameter)`
`RequestPackage`	ISLConnector.`createCMSRequest(byte[] signatureData, - int[] byteRange, - SignParameter parameter)`
`InfoboxReadRequestType`	BaseSLConnector.`createInfoboxReadRequest(SignParameter parameter)`
`InfoboxReadRequestType`	ISLConnector.`createInfoboxReadRequest(SignParameter parameter)`
`iaik.x509.X509Certificate`	ISignatureConnector.`getCertificate(SignParameter parameter)`
`iaik.x509.X509Certificate`	MOAConnector.`getCertificate(SignParameter parameter)`
`iaik.x509.X509Certificate`	ISignatureConnectorSLWrapper.`getCertificate(SignParameter parameter)`
`CreateCMSSignatureResponseType`	ISLConnector.`sendCMSRequest(RequestPackage pack, - SignParameter parameter)`
`CreateCMSSignatureResponseType`	BKUSLConnector.`sendCMSRequest(RequestPackage pack, - SignParameter parameter)`
`InfoboxReadResponseType`	ISLConnector.`sendInfoboxReadRequest(InfoboxReadRequestType request, - SignParameter parameter)`
`InfoboxReadResponseType`	BKUSLConnector.`sendInfoboxReadRequest(InfoboxReadRequestType request, - SignParameter parameter)`
`byte[]`	ISignatureConnector.`sign(byte[] input, - int[] byteRange, - SignParameter parameter)`
`byte[]`	MOAConnector.`sign(byte[] input, - int[] byteRange, - SignParameter parameter)`
`byte[]`	ISignatureConnectorSLWrapper.`sign(byte[] input, - int[] byteRange, - SignParameter parameter)`

Modifier and Type	Method and Description
`SignResult`	PdfAs.`finishSign(StatusRequest statusRequest)` - Finishes a signature process -
`SignResult`	PdfAs.`sign(SignParameter parameter)` - Signs a PDF document using PDF-AS. -

Modifier and Type	Method and Description
`SignResult`	PdfAsImpl.`finishSign(StatusRequest statusRequest)`
`SignResult`	PdfAsImpl.`sign(SignParameter parameter)`

Interface	Description
IPlainSigner	- Signer interface - - PDF-AS uses an IPlainSigner instance to create the signature. -
SignParameter
SignResult

Interface IPlainSigner

Method Summary

Method Detail

getCertificate

sign

getPDFSubFilter

getPDFFilter

Interface SignParameter

Method Summary

Methods inherited from interface at.gv.egiz.pdfas.lib.api.PdfAsParameter

Method Detail

getSignatureProfileId

setSignatureProfileId

getSignaturePosition

setSignaturePosition

setOutput

getOutput

setPlainSigner

getPlainSigner

Interface SignResult

Method Summary

Method Detail

getOutputDocument

getSignerCertificate

getSignaturePosition

Uses of Interfaceat.gv.egiz.pdfas.lib.api.sign.IPlainSigner

Uses of IPlainSigner in at.gv.egiz.pdfas.lib.api.sign

Uses of IPlainSigner in at.gv.egiz.pdfas.lib.impl

Uses of IPlainSigner in at.gv.egiz.pdfas.lib.impl.signing.pdfbox

Uses of Interfaceat.gv.egiz.pdfas.lib.api.sign.SignParameter

Uses of SignParameter in at.gv.egiz.pdfas.lib.api

Uses of SignParameter in at.gv.egiz.pdfas.lib.api.sign

Uses of SignParameter in at.gv.egiz.pdfas.lib.impl

Uses of SignParameter in at.gv.egiz.pdfas.lib.impl.signing.pdfbox

Uses of SignParameter in at.gv.egiz.pdfas.lib.impl.status

Uses of SignParameter in at.gv.egiz.sl.util

Uses of Interfaceat.gv.egiz.pdfas.lib.api.sign.SignResult

Uses of SignResult in at.gv.egiz.pdfas.lib.api

Uses of SignResult in at.gv.egiz.pdfas.lib.impl

at.gv.egiz.pdfas.lib.api.sign

Interfaces

Package at.gv.egiz.pdfas.lib.api.sign

Hierarchy For Package at.gv.egiz.pdfas.lib.api.sign

Interface Hierarchy

Uses of Packageat.gv.egiz.pdfas.lib.api.sign

Uses of Interface
at.gv.egiz.pdfas.lib.api.sign.IPlainSigner

Uses of Interface
at.gv.egiz.pdfas.lib.api.sign.SignParameter

Uses of Interface
at.gv.egiz.pdfas.lib.api.sign.SignResult

Uses of Package
at.gv.egiz.pdfas.lib.api.sign