OSB_LIB::UserMgmtCfg Class Reference

Collaboration diagram for OSB_LIB::UserMgmtCfg:

[legend]List of all members.

Detailed Description

Management of OSB modules, users, groups and access rights.

Definition at line 63 of file usermgmt.h.

Public Member Functions

Evaluation of access rights.

bool allowed (const OsbUser::Oid &userId, const ModuleId &module)
Check if a user has access to a module.
bool allowed (const OsbUser::Oid &userId, const ModuleId &module, const std::string &rootTag)
Check if a user has access to a root window.

Information about OSB modules.

const Modules & modules () const
Get all OSB modules.
const Module & get (ModuleId id) const
Get a specific OSB module.
void readModules (const OSB_DB::Session &session)
Read the OSB modules from the database.
void readModuleAccess (const OSB_DB::Session &session)
Read OSB modules and access rights from the database.
void expModuleAccess (std::ostream &os) const
Export module access rights, CSV format.

Maintain module access rights:

void insert (const OSB_DB::Session &session, ModAccess &access)
Add or replace an access right for a module.
void remove (const OSB_DB::Session &session, ModAccess access)
Remove a module access right and all its children.

User management.

bool login (const OSB_DB::Session &session, OsbUser &user)
Login an OSB user.
const OsbUser & get (const OsbUser::Oid &userId) const
Get an OSB user.
const Users & users () const
Get all loaded users.
const OsbUser & read (const OSB_DB::Session &session, const OsbUser::Oid &userId)
Read OSB user from the database.
void readUsers (const OSB_DB::Session &session)
Read the users from the database.
bool usersRead () const
All users read from the database?
void save (const OSB_DB::Session &session, OsbUser &user)
Update an OSB user.
bool remove (const OSB_DB::Session &session, const OsbUser::Oid userId)
Remove a user from the list.

User group management.

const UserGroups & groups () const
Get all user groups.
const UserGroup & get (const UserGroup::Oid &grpId) const
Get a user group.
void readGroups (const OSB_DB::Session &session)
Read the OSB modules from the database.
void save (const OSB_DB::Session &session, UserGroup &grp)
Insert a group into the list.
bool remove (const OSB_DB::Session &session, const UserGroup::Oid grpId)
Remove a group from the list.

Group access rights.

void insert (const OSB_DB::Session &session, GrpAccess &access)
Add or replace an access right for a user group.
void remove (const OSB_DB::Session &session, GrpAccess access)
Remove a group access right and all its children.

Static Public Member Functions

static UserMgmtCfg & instance ()
Get the only instance of the class.

Private Member Functions

void readGroupAccess (const OSB_DB::Session &session, const ModuleId moduleId)
Read group access rights for a specific module.
UserMgmtCfg ()
Private construction only.
~UserMgmtCfg ()
Private destruction only.
UserMgmtCfg (const UserMgmtCfg &)
Prevent copying: not implemented.

Private Attributes

Modules modules_
List of OSB modules.
Users users_
List of OSB users.
UserGroups groups_
List of OSB user groups.

Static Private Attributes

static UserMgmtCfg * instance_
The only instance of the class.
static Destroy destroy_
Make sure the instance is deleted at program end.

Friends

struct Destroy
Allow to delete instance_.

Classes

struct Destroy
Structure to control deletion of UserMgmtCfg::instance_. More...

Constructor & Destructor Documentation

OSB_LIB::UserMgmtCfg::UserMgmtCfg ( ) [private]

Private construction only.

OSB_LIB::UserMgmtCfg::~UserMgmtCfg ( ) [private]

Private destruction only.

OSB_LIB::UserMgmtCfg::UserMgmtCfg ( const UserMgmtCfg & ) [private]

Prevent copying: not implemented.

Member Function Documentation

bool OSB_LIB::UserMgmtCfg::allowed	(	const OsbUser::Oid &	userId,
		const ModuleId &	module,
		const std::string &	rootTag
	)

Check if a user has access to a root window.

Parameters:

	userId	Object id of the user.
	module	OSB module of rootTag.
	rootTag	Access identifier of the root window.

Returns:: true if the user is allowed to access the window as identified by rootTag, else false.

bool OSB_LIB::UserMgmtCfg::allowed	(	const OsbUser::Oid &	userId,
		const ModuleId &	module
	)

Check if a user has access to a module.

Parameters:

	userId	Object id of the user.
	module	OSB module to verify.

Returns:: true if the user is allowed to access module, else false.

void OSB_LIB::UserMgmtCfg::expModuleAccess ( std::ostream & os ) const

Export module access rights, CSV format.

Parameters:

Stream to write to.

Writes the module access rights to os, one per line:
object id, module, access tag, parent_id.

const UserGroup& OSB_LIB::UserMgmtCfg::get ( const UserGroup::Oid & grpId ) const

Get a user group.

Parameters:

grpId

The object id of the user group.

Returns:: The user group for grpId.

Exceptions:

ObjectNotFound

if the user group is not found.

const OsbUser& OSB_LIB::UserMgmtCfg::get ( const OsbUser::Oid & userId ) const

Get an OSB user.

Parameters:

userId

The object id of the user.

Returns:: The OSB user for userId.

Exceptions:

ObjectNotFound

if the user is not found.

const Module& OSB_LIB::UserMgmtCfg::get ( ModuleId id ) const

Get a specific OSB module.

Parameters:

The id of the module to retrieve.

Exceptions:

ObjectNotFound

if the module does not exist.

Returns:: The module for id.

const UserGroups& OSB_LIB::UserMgmtCfg::groups ( ) const

Get all user groups.

void OSB_LIB::UserMgmtCfg::insert	(	const OSB_DB::Session &	session,
		GrpAccess &	access
	)

Add or replace an access right for a user group.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions.
	access	Group access to add or replace, for new access rights the object id is set.

Exceptions:

	ObjectNotFound	if the user group of access does not exist.
	OsbException	from GrpAccessMap::check().

void OSB_LIB::UserMgmtCfg::insert	(	const OSB_DB::Session &	session,
		ModAccess &	access
	)

Add or replace an access right for a module.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions.
	access	Module access to add or replace, for new access rights the object id is set.

Exceptions:

	ObjectNotFound	if the module of access does not exist.
	OsbException	from ModAccessMap::check().

static UserMgmtCfg& OSB_LIB::UserMgmtCfg::instance ( ) [static]

Get the only instance of the class.

bool OSB_LIB::UserMgmtCfg::login	(	const OSB_DB::Session &	session,
		OsbUser &	user
	)

Parameters:

	session	Database session to use.
	user	OSB user to login: login name and password must be set.

Returns:: true if the user is logged in, else false.

The function reads the user from database and valiates the password.
At the same time user management loads the user groups that are granted to the user.

const Modules& OSB_LIB::UserMgmtCfg::modules ( ) const

Get all OSB modules.

const OsbUser& OSB_LIB::UserMgmtCfg::read	(	const OSB_DB::Session &	session,
		const OsbUser::Oid &	userId
	)

Read OSB user from the database.

Parameters:

	session	Database session to use.
	userId	The id of the user to read.

Exceptions:

ObjectNotFound

if the user does not exist in the database.

void OSB_LIB::UserMgmtCfg::readGroupAccess	(	const OSB_DB::Session &	session,
		const ModuleId	moduleId
	)			`[private]`

Read group access rights for a specific module.

Reads the access rights for each user group who's module is moduleId.

void OSB_LIB::UserMgmtCfg::readGroups ( const OSB_DB::Session & session )

Read the OSB modules from the database.

The function only reads the group descriptions (id, name et al.), call readGroupAccess() to read the access rights as well.

void OSB_LIB::UserMgmtCfg::readModuleAccess ( const OSB_DB::Session & session )

Read OSB modules and access rights from the database.

Calls readModules() and then reads the access rights for each module.

void OSB_LIB::UserMgmtCfg::readModules ( const OSB_DB::Session & session )

Read the OSB modules from the database.

The function only reads the module descriptions (name, type), call readModuleAccess() to read the access rights as well.

void OSB_LIB::UserMgmtCfg::readUsers ( const OSB_DB::Session & session )

Read the users from the database.

void OSB_LIB::UserMgmtCfg::remove	(	const OSB_DB::Session &	session,
		GrpAccess	access
	)

Remove a group access right and all its children.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions.
	access	User group access to remove.

bool OSB_LIB::UserMgmtCfg::remove	(	const OSB_DB::Session &	session,
		const UserGroup::Oid	grpId
	)

Remove a group from the list.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions if the function returns true.
	grpId	The object id of the user group to remove.

Returns:: true if the group was removed from the database and the internal list, else false.
In either case the group does no more exist in the internal list after the function returns.

bool OSB_LIB::UserMgmtCfg::remove	(	const OSB_DB::Session &	session,
		const OsbUser::Oid	userId
	)

Remove a user from the list.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions if the function returns true.
	userId	The object id of the user to remove.

Returns:: true if the user was removed from the database and the internal list, else false.
In either case the user does no more exist in the internal list after the function returns.

void OSB_LIB::UserMgmtCfg::remove	(	const OSB_DB::Session &	session,
		ModAccess	access
	)

Remove a module access right and all its children.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions.
	access	Module access to remove.

void OSB_LIB::UserMgmtCfg::save	(	const OSB_DB::Session &	session,
		UserGroup &	grp
	)

Insert a group into the list.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions.
	grp	The user group to save, it replaces an already existing group with the same object id. After the function returns grp is a copy of the user group stored internally.

Exceptions:

OsbException

from UserGroup::save() if the user group can not be saved.

void OSB_LIB::UserMgmtCfg::save	(	const OSB_DB::Session &	session,
		OsbUser &	user
	)

Update an OSB user.

Parameters:

	session	Database session to use. The caller is reponsible to commit the transactions.
	user	The user to save, it replaces an already existing user with the same object id. After the function returns user is a copy of the user stored internally.

Exceptions:

OsbException

from OsbUser::insert() or OsbUser::update if the user can not be saved.

const Users& OSB_LIB::UserMgmtCfg::users ( ) const

Get all loaded users.

bool OSB_LIB::UserMgmtCfg::usersRead ( ) const

All users read from the database?