Leosac  0.8.0
Open Source Access Control
Leosac::Module::SMTP::SMTPAudit Class Reference

Keeps track of SMTP event. More...

#include <SMTPAudit.hpp>

+ Inheritance diagram for Leosac::Module::SMTP::SMTPAudit:
+ Collaboration diagram for Leosac::Module::SMTP::SMTPAudit:

Classes

struct  ConstructorAccess
 A tag struct to be able to call std::make_shared() despite a private ctor. More...
 

Public Member Functions

 SMTPAudit (const ConstructorAccess &)
 
virtual std::string generate_description () const override
 Generate a description for this event. More...
 
- Public Member Functions inherited from Leosac::Audit::AuditEntry
 AuditEntry (const AuditEntry &)=delete
 
virtual ~AuditEntry ()=default
 
virtual AuditEntryId id () const override
 Retrieve the identifier of the entry. More...
 
virtual void finalize () override
 Mark the entry as finalized, and update it wrt the database. More...
 
virtual bool finalized () const override
 Is this entry finalized. More...
 
virtual void event_mask (const EventMask &mask) override
 Set the event mask for the entry. More...
 
virtual const EventMaskevent_mask () const override
 Retrieve the current event mask. More...
 
virtual void author (Auth::UserPtr user) override
 Set the author of the entry. More...
 
virtual Auth::UserId author_id () const override
 Retrieve the user id of the author of this entry. More...
 
virtual void set_parent (IAuditEntryPtr parent) override
 Set parent as the parent audit entry for this entry. More...
 
virtual IAuditEntryPtr parent () const override
 Retrieve the parent of this entry. More...
 
virtual void remove_parent () override
 Remove the parent-child relationship between this entry and its parent. More...
 
virtual size_t children_count () const override
 Returns the number of children that this entry has. More...
 
virtual size_t version () const override
 Returns the ODB version of the object. More...
 
virtual void reload () override
 Reload the object from the database. More...
 
virtual boost::posix_time::ptime timestamp () const override
 Retrieve unix timestamp. More...
 
void database (DBPtr db)
 Set the database pointer. More...
 
- Public Member Functions inherited from Leosac::Audit::IAuditEntry
 MAKE_VISITABLE ()
 
- Public Member Functions inherited from Leosac::Tools::IVisitable
virtual void accept (::Leosac::Tools::BaseVisitor &)=0
 Accept a visitor that may mutate this. More...
 
virtual void accept (::Leosac::Tools::BaseVisitor &) const =0
 Accept a visitor that will not mutate this. More...
 

Static Public Member Functions

static SMTPAuditPtr create (const DBPtr &database, Audit::IAuditEntryPtr parent)
 Factory function, similar to those found in Audit::Factory. More...
 
- Static Public Member Functions inherited from Leosac::Audit::AuditEntry
static AuditEntryPtr get_last_audit (DBPtr db)
 Retrieve the last (finalized) audit entry. More...
 

Private Member Functions

 MAKE_VISITABLE ()
 
 SMTPAudit ()=default
 

Friends

class odb::access
 

Additional Inherited Members

- Protected Member Functions inherited from Leosac::Audit::AuditEntry
 AuditEntry ()
 
- Static Protected Member Functions inherited from Leosac::Tools::IVisitable
template<class T >
static bool visitor_dispatch (T &visited, BaseVisitor &visitor, bool abort_on_failure)
 
- Protected Attributes inherited from Leosac::Audit::AuditEntry
AuditEntryWPtr parent_
 
std::string msg_
 
Auth::UserLPtr author_
 The user at the source of the entry. More...
 
EventMask event_mask_
 
size_t duration_
 How long did it take for the Audit object to be finalized. More...
 
bool finalized_
 Audit entry are sometime persisted multiple time before reaching their final state. More...
 
DBPtr database_
 Pointer to the database. More...
 
Tools::ElapsedTimeCounter etc_
 Keep track of how long the object has been alive. More...
 

Detailed Description

Keeps track of SMTP event.

Definition at line 39 of file SMTPAudit.hpp.

Constructor & Destructor Documentation

◆ SMTPAudit() [1/2]

Leosac::Module::SMTP::SMTPAudit::SMTPAudit ( )
privatedefault

◆ SMTPAudit() [2/2]

Leosac::Module::SMTP::SMTPAudit::SMTPAudit ( const ConstructorAccess )
explicit

Definition at line 35 of file SMTPAudit.cpp.

Member Function Documentation

◆ create()

SMTPAuditPtr Leosac::Module::SMTP::SMTPAudit::create ( const DBPtr database,
Audit::IAuditEntryPtr  parent 
)
static

Factory function, similar to those found in Audit::Factory.

Definition at line 44 of file SMTPAudit.cpp.

◆ generate_description()

std::string Leosac::Module::SMTP::SMTPAudit::generate_description ( ) const
overridevirtual

Generate a description for this event.

todo: should be pure virtual

Reimplemented from Leosac::Audit::IAuditEntry.

Definition at line 39 of file SMTPAudit.cpp.

◆ MAKE_VISITABLE()

Leosac::Module::SMTP::SMTPAudit::MAKE_VISITABLE ( )
private

Friends And Related Function Documentation

◆ odb::access

friend class odb::access
friend

Definition at line 65 of file SMTPAudit.hpp.


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