OdDwfxSignatureHandler Class Reference

#include <OdDwfxSignatureHandler.h>

Public Types
enum	SignatureValidationResult { kSuccess = 0 , kInvalidSignature , kCertificateChainProblem , kNotSigned }

Public Member Functions
virtual	~OdDwfxSignatureHandler ()
virtual void	setCertParameters (const OdCertParameters &certParams)=0
virtual bool	signPackage (const OdString &filePath)=0
virtual bool	removeExistingSignature (const OdString &filePath)=0
virtual bool	validatePackageSignature (const OdString &filePath, SignatureValidationResult &validationResult, OdCertParameters &certParams)=0

Detailed Description

<group OdDbRoot_Classes> This class is the interface class for the DWFx signature handler object.

Definition at line 55 of file OdDwfxSignatureHandler.h.

Member Enumeration Documentation

SignatureValidationResult

enum OdDwfxSignatureHandler::SignatureValidationResult

Enumerator
kSuccess
kInvalidSignature
kCertificateChainProblem
kNotSigned

Definition at line 64 of file OdDwfxSignatureHandler.h.

Constructor & Destructor Documentation

~OdDwfxSignatureHandler()

virtual OdDwfxSignatureHandler::~OdDwfxSignatureHandler ( )

inlinevirtual

Destructor for the OdDwfxSignatureHandler class.

Definition at line 62 of file OdDwfxSignatureHandler.h.

Member Function Documentation

removeExistingSignature()

virtual bool OdDwfxSignatureHandler::removeExistingSignature ( const OdString &  filePath )

pure virtual

Method to remove existing signature of the package.

Returns

Returns true if succeeded. Otherwise returns false.

Parameters

filePath

[in] Full path to the package.

setCertParameters()

virtual void OdDwfxSignatureHandler::setCertParameters ( const OdCertParameters &  certParams )

pure virtual

Method to set the certificate for signing the DWFx package.

Parameters

certParams

[in] Certificate description data.

signPackage()

virtual bool OdDwfxSignatureHandler::signPackage ( const OdString &  filePath )

pure virtual

Method to sign the DWFx package.

Returns

Returns true if succeeded. Otherwise returns false.

Parameters

filePath

[in] Full path to the package.

validatePackageSignature()

virtual bool OdDwfxSignatureHandler::validatePackageSignature ( const OdString &  filePath, SignatureValidationResult &  validationResult, OdCertParameters &  certParams  )

pure virtual

Method to validate signature.

Returns

Returns true if succeeded. Otherwise returns false.

Parameters

filePath	[in] Full path to the package.
validationResult	[out] The result of signature validation if method succeeds.
certParams	[out] Description data of the certificate if obtained one during the validation.

---

The documentation for this class was generated from the following file:

• OdDwfxSignatureHandler.h