LibLogicalAccess  2.5.0
An Open Source RFID Library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
logicalaccess::LicenseCheckerService Class Referenceabstract

#include <license_checker_service.hpp>

Inheritance diagram for logicalaccess::LicenseCheckerService:
logicalaccess::ReaderService

Public Member Functions

 LicenseCheckerService (ReaderUnitPtr ru)
 
virtual ~LicenseCheckerService ()=default
 
virtual void writeLicenseKey (const KeyStoragePtr &storage_info, const KeyPtr &key, KeyPtr oldKey=nullptr)=0
 
virtual bool validateLicenseKey (const KeyStoragePtr &storage_info, const KeyPtr &key)=0
 
- Public Member Functions inherited from logicalaccess::ReaderService
 ReaderService (ReaderUnitPtr reader_unit, ReaderServiceType service_type)
 
virtual ~ReaderService ()=default
 
ReaderUnitPtr getReader () const
 
virtual ReaderServiceType getServiceType () const
 

Additional Inherited Members

- Protected Attributes inherited from logicalaccess::ReaderService
ReaderUnitPtr reader_unit_
 
ReaderServiceType service_type_
 

Detailed Description

The license checker service permits verification of license keys that are stored on a physical RFID reader.

The service implementation being dependant on the type of reader unit, the service is instantiated through the ReaderUnit class. The implementation may live in other DLL (lla-private) and the LibraryManager will be needed to instantiated the correct implementation for the reader.

Constructor & Destructor Documentation

◆ LicenseCheckerService()

logicalaccess::LicenseCheckerService::LicenseCheckerService ( ReaderUnitPtr  ru)
inlineexplicit

◆ ~LicenseCheckerService()

virtual logicalaccess::LicenseCheckerService::~LicenseCheckerService ( )
virtualdefault

Member Function Documentation

◆ validateLicenseKey()

virtual bool logicalaccess::LicenseCheckerService::validateLicenseKey ( const KeyStoragePtr storage_info,
const KeyPtr key 
)
pure virtual

Attempt to validate the license key against the one stored on the reader.

This operation may involve changing the reader's security mode, as well as re-authenticate against the reader, canceling any previous authenticated session that may exists. This operation is non-destruction as it will not write anything on the reader.

Parameters
storage_infois the KeyStorage describing which key to authenticate against.
keyis the key that will be used to attempt the authentication.

◆ writeLicenseKey()

virtual void logicalaccess::LicenseCheckerService::writeLicenseKey ( const KeyStoragePtr storage_info,
const KeyPtr key,
KeyPtr  oldKey = nullptr 
)
pure virtual

Write the license key to the reader.

This operation may involve changing the current security mode in which the reader operate, as well as overwrite previous key stored at the location provided by storage_info.

Parameters
storage_infois the KeyStorage description where to write the license key. Most underlying LicenseCheckerService will expect the object to be of type ReaderMemoryKeyStorage.
keyis the key object that will be written in the reader's key slot. The underlying depends on what type of key can be stored on a given reader.
oldkeyis the actually that is currently on the reader and that we need to use in order to authenticate and change the. It is optional, and if not specified will default to representing the default key.

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