certmanager/lib

Constructor, destructor and setting of 'active' flag

Functions

 CryptPlugWrapper::CryptPlugWrapper (const TQString &name=TQString(), const TQString &libName=TQString(), const TQString &update=TQString(), bool active=false)
 
 CryptPlugWrapper::~CryptPlugWrapper ()
 
void CryptPlugWrapper::setActive (bool active)
 
bool CryptPlugWrapper::active () const
 
bool CryptPlugWrapper::setLibName (const TQString &libName)
 
TQString CryptPlugWrapper::libName () const
 
void CryptPlugWrapper::setDisplayName (const TQString &name)
 
TQString CryptPlugWrapper::displayName () const
 

Detailed Description

The functions in this section are used for general administration of this CRYPTPLUG wrapper class and for maintaining a separate active flag for environments using more than one CRYPTPLUG library simultaneously.

Function Documentation

◆ active()

bool CryptPlugWrapper::active ( ) const

Returns this CRYPTPLUG wrapper's internal active flag.

Returns
whether the relative library is to be used or not.
See also
setActive

Definition at line 449 of file cryptplugwrapper.cpp.

◆ CryptPlugWrapper()

CryptPlugWrapper::CryptPlugWrapper ( const TQString &  name = TQString(),
const TQString &  libName = TQString(),
const TQString &  update = TQString(),
bool  active = false 
)

Constructor of CRYPTPLUG wrapper class.

This constructor does not call the initialize() method but just stores some information for later use.

Note
Since more than one crypto plug-in might be specified (using multiple instances of the warpper class) it is necessary to set active at least one them. Only wrappers that have been activated may be initialized or configured or used to perform crypto actions.
Parameters
nameThe external name that is visible in lists, messages, etc.
libNameComplete path+name of CRYPTPLUG library that is to be used by this instance of CryptPlugWrapper.
updatethe URL from where updates can be downloaded
activeSpecify whether the relative library is to be used or not.
See also
~CryptPlugWrapper, setActive, active, initialize, deinitialize
iniStatus

Definition at line 418 of file cryptplugwrapper.cpp.

◆ displayName()

TQString CryptPlugWrapper::displayName ( ) const

Returns the external name.

Returns
the external name used for display purposes

Definition at line 484 of file cryptplugwrapper.cpp.

◆ libName()

TQString CryptPlugWrapper::libName ( ) const

Returns the CRYPTPLUG library name.

Returns
the complete path+name of CRYPTPLUG library that is to be used by this instance of CryptPlugWrapper.
See also
setLibName

Definition at line 464 of file cryptplugwrapper.cpp.

◆ setActive()

void CryptPlugWrapper::setActive ( bool  active)

Set this CRYPTPLUG wrapper's internal active flag.

Since more than one crypto plug-in might be specified (using multiple instances of the warpper class) it is necessary to set active at least one them. Only wrappers that have been activated may be initialized or configured or used to perform crypto actions.

This flag may be set in the constructor or by calling setActive().

Note
Deactivating does not mean resetting the internal structures - if just prevents the normal functions from being called erroneously. When deactivated only the following functions are operational: constructor , destructor , setActive , active, setLibName , libName , iniStatus; calling other functions will be ignored and their return values will be undefined.
Parameters
activeSpecify whether the relative library is to be used or not.
See also
active, CryptPlugWrapper(), ~CryptPlugWrapper
deinitialize, initialize, iniStatus

Definition at line 443 of file cryptplugwrapper.cpp.

◆ setDisplayName()

void CryptPlugWrapper::setDisplayName ( const TQString &  name)

Specifies the external name that is visible in lists, messages, etc.

Definition at line 478 of file cryptplugwrapper.cpp.

◆ setLibName()

bool CryptPlugWrapper::setLibName ( const TQString &  libName)

Set the CRYPTPLUG library name.

Complete path+name of CRYPTPLUG library that is to be used by this instance of CryptPlugWrapper.

This name may be set in the constructor or by calling setLibName().

Note
Setting/changing the library name may only be done when the iniStatus() is not IniStatus_Ok. If you want to change the name of the library after successfully having called initialize() please make sure to unload it by calling the deinitialize() function.
Parameters
libNamelibName Complete path+name of CRYPTPLUG library that is to be used by this CryptPlugWrapper.
Returns
whether the library name could be changed; library name can only be changed when library is not initialized - see above 'note'.
See also
libName, CryptPlugWrapper(), ~CryptPlugWrapper
deinitialize, initialize, iniStatus

Definition at line 456 of file cryptplugwrapper.cpp.

◆ ~CryptPlugWrapper()

CryptPlugWrapper::~CryptPlugWrapper ( )

Destructor of CRYPTPLUG wrapper class.

This destructor does call the deinitialize() method in case this was not done by explicitly calling it before.

See also
deinitialize, initialize, CryptPlugWrapper(), setActive, active

Definition at line 437 of file cryptplugwrapper.cpp.