at.gv.egiz.pdfas.api.internal
Interface PdfAsInternal

All Known Implementing Classes:
PdfAsInternalObject

public interface PdfAsInternal

The methods of this interface are used by the pdf-as-web project and are not for external use.
Using this API is inadvisable as its functionality might change without notice from release to release.

Author:
exthex

Method Summary
 AnalyzeResult analyzeFromRawText(String rawText, Map sigValues)
          Create an AnalyzeResult from raw text, instead of a PDF.
 SignResult finishLocalSign(PdfAs pdfAs, SignParameters signParameters, SignatureDetailInformation sdi, LocalBKUParams bkuParams, boolean multipart, String xmlResponse)
          Finish the sign process.
 VerifyResult finishLocalVerify(SignatureInformation sigInfo, String connector, String profile, String loc_ref_url, String xmlResponse)
          Parse the given xml_response - must be a VerifyXMLSignatureResponse - from the BKU or Mocca and generates a VerifyResult from it.
 Map getConnectorsAvailableForWeb()
          Get a map of all connectors available for web.
 String getLocalServiceAddress(String profile, String device)
          Get the security layer address for the given connector.
 SignatureEntry getSignatureEntryFromSignatureInformation(String key, SignatureInformation sigInfo)
          Get the SignatureEntry corresponding to a given SignatureInformation
 String getSignedText(SignatureInformation sigInfo)
          Get the signed text for a given sigInfo.
 String prepareLocalSignRequest(SignParameters signParameters, boolean multipart, String loc_ref_url, SignatureDetailInformation sdi)
          Get the CreateXMLSignatureRequest for the given parameters.
 String prepareLocalVerifyRequest(SignatureInformation sigInfo, String connector, String profile, String loc_ref_url)
          Create the SecurityLayer VerifyXMLSignatureRequest for the given parameters.
 void verifyBKUSupport(LocalBKUParams bkuParams)
          Check if a BKU with the given parameters is supported.
 

Method Detail

verifyBKUSupport

void verifyBKUSupport(LocalBKUParams bkuParams)
                      throws ConnectorException,
                             SettingsException
Check if a BKU with the given parameters is supported.

Parameters:
bkuParams -
Throws:
ConnectorException - if the BKU is not supported
SettingsException - if the BKU is not supported

finishLocalSign

SignResult finishLocalSign(PdfAs pdfAs,
                           SignParameters signParameters,
                           SignatureDetailInformation sdi,
                           LocalBKUParams bkuParams,
                           boolean multipart,
                           String xmlResponse)
                           throws PdfAsException
Finish the sign process.

Parameters:
pdfAs -
signParameters -
sdi - This info will most likely come from a PdfAs.prepareSign(SignParameters) call
bkuParams -
xmlResponse - the SecurityLayer response from the BKU
Returns:
the signed document + additional info
Throws:
PdfAsException

getLocalServiceAddress

String getLocalServiceAddress(String profile,
                              String device)
                              throws SettingsException
Get the security layer address for the given connector. (zB: http://127.0.0.1:3495/http-security-layer-request)

Parameters:
profile -
device -
Returns:
Throws:
SettingsException

prepareLocalSignRequest

String prepareLocalSignRequest(SignParameters signParameters,
                               boolean multipart,
                               String loc_ref_url,
                               SignatureDetailInformation sdi)
                               throws ConnectorException
Get the CreateXMLSignatureRequest for the given parameters. The request will use the given callback address to retrieve the data to sign.

Parameters:
signParameters - the sign parameters. SignParameters.getSignatureDevice() determines the connector to use.
multipart - true to select a LocalConnector that uses multipart requests
loc_ref_url - the URL where to retrieve the PDF to sign
sdi - SignatureDetailInformation.getSignatureData() provides the data to be signed.
Returns:
Throws:
ConnectorException

analyzeFromRawText

AnalyzeResult analyzeFromRawText(String rawText,
                                 Map sigValues)
                                 throws SignatureException,
                                        SettingsException,
                                        SignatureTypesException,
                                        NormalizeException
Create an AnalyzeResult from raw text, instead of a PDF.

Parameters:
rawText -
sigValues - the signature values
Returns:
Throws:
SignatureException
SettingsException
SignatureTypesException
NormalizeException

prepareLocalVerifyRequest

String prepareLocalVerifyRequest(SignatureInformation sigInfo,
                                 String connector,
                                 String profile,
                                 String loc_ref_url)
                                 throws SignatureException,
                                        ConnectorException
Create the SecurityLayer VerifyXMLSignatureRequest for the given parameters.

Parameters:
sigInfo -
connector -
profile -
loc_ref_url -
Returns:
Throws:
SignatureException
ConnectorException

finishLocalVerify

VerifyResult finishLocalVerify(SignatureInformation sigInfo,
                               String connector,
                               String profile,
                               String loc_ref_url,
                               String xmlResponse)
                               throws SignatureException,
                                      ConnectorException
Parse the given xml_response - must be a VerifyXMLSignatureResponse - from the BKU or Mocca and generates a VerifyResult from it.

Parameters:
sigInfo -
connector -
profile -
loc_ref_url -
xmlResponse -
Returns:
Throws:
SignatureException
ConnectorException

getSignatureEntryFromSignatureInformation

SignatureEntry getSignatureEntryFromSignatureInformation(String key,
                                                         SignatureInformation sigInfo)
Get the SignatureEntry corresponding to a given SignatureInformation

Parameters:
key -
sigInfo -
Returns:

getSignedText

String getSignedText(SignatureInformation sigInfo)
Get the signed text for a given sigInfo.
If this signature is not text based this method will return null.

Parameters:
sigInfo -
Returns:

getConnectorsAvailableForWeb

Map getConnectorsAvailableForWeb()
                                 throws ConnectorFactoryException
Get a map of all connectors available for web. The key is the connector id, the value is the description.

Returns:
Throws:
ConnectorFactoryException


Copyright © 2006-2011. All Rights Reserved.