LibreOffice Module comphelper (master)  1
Public Member Functions | List of all members
comphelper::IDocPasswordVerifier Class Referenceabstract

Base class for a password verifier used by the DocPasswordHelper class below. More...

#include <docpasswordhelper.hxx>

Public Member Functions

virtual ~IDocPasswordVerifier ()
 
virtual DocPasswordVerifierResult verifyPassword (const OUString &rPassword, css::uno::Sequence< css::beans::NamedValue > &o_rEncryptionData)=0
 Will be called every time a password needs to be verified. More...
 
virtual DocPasswordVerifierResult verifyEncryptionData (const css::uno::Sequence< css::beans::NamedValue > &o_rEncryptionData)=0
 Will be called every time an encryption data needs to be verified. More...
 

Detailed Description

Base class for a password verifier used by the DocPasswordHelper class below.

Users have to implement the virtual functions and pass an instance of the verifier to one of the password request functions.

Definition at line 48 of file docpasswordhelper.hxx.

Constructor & Destructor Documentation

comphelper::IDocPasswordVerifier::~IDocPasswordVerifier ( )
virtual

Definition at line 82 of file docpasswordhelper.cxx.

Member Function Documentation

virtual DocPasswordVerifierResult comphelper::IDocPasswordVerifier::verifyEncryptionData ( const css::uno::Sequence< css::beans::NamedValue > &  o_rEncryptionData)
pure virtual

Will be called every time an encryption data needs to be verified.

Parameters
rEncryptionDataThe data will be validated
Returns
The result of the verification.
  • DocPasswordVerifierResult_OK, if and only if the passed encryption data is valid and can be used to process the related document.
  • DocPasswordVerifierResult_WRONG_PASSWORD, if the encryption data is wrong.
  • DocPasswordVerifierResult_ABORT, if an unrecoverable error occurred while data verification. The password request loop will be aborted.

Referenced by comphelper::DocPasswordHelper::requestAndVerifyDocPassword().

virtual DocPasswordVerifierResult comphelper::IDocPasswordVerifier::verifyPassword ( const OUString &  rPassword,
css::uno::Sequence< css::beans::NamedValue > &  o_rEncryptionData 
)
pure virtual

Will be called every time a password needs to be verified.

Parameters
rPasswordThe password to be verified
o_rEncryptionDataOutput parameter, that is filled with the EncryptionData generated from the password. The data is filled only if the validation was successful.
Returns
The result of the verification.
  • DocPasswordVerifierResult_OK, if and only if the passed password is valid and can be used to process the related document.
  • DocPasswordVerifierResult_WRONG_PASSWORD, if the password is wrong. The user may be asked again for a new password.
  • DocPasswordVerifierResult_ABORT, if an unrecoverable error occurred while password verification. The password request loop will be aborted.

Referenced by comphelper::DocPasswordHelper::requestAndVerifyDocPassword().


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