OSB_LIB::ModAccessMap Class Reference

Collaboration diagram for OSB_LIB::ModAccessMap:

[legend]List of all members.

---

Detailed Description

List of access rights for one module.

Definition at line 197 of file osbaccess.h.

Public Types

• typedef std::map< ModAccess::Oid,
  ModAccess > Entries

  STL container to store the access rights of a module.
  

Public Member Functions

• ModAccessMap (const ModuleId module=mdUnknown)

  Constructor with optional module.
  

• ModuleId module () const

  The module of the access map.
  

• const ModAccess * find (const ModAccess::Oid &maId) const

  Find a module access right.
  

• const ModAccess & get (const ModAccess::Oid &maId) const

  Get a module access right.
  

• void accessRights (std::list< ModAccess > &dest, const ModAccess::Oid &parId=ModAccess::Oid()) const

  Get child access rights.
  

• void read (const OSB_DB::Session &session)

  Read the access rights from the database.
  

Private Member Functions

• void check (const ModAccess &access) const

  Check a module access.
  

• void insert (const ModAccess &access)

  Add or replace an access right.
  

Private Attributes

• ModuleId module_

  The module of the access map.
  

• Entries entries_

  Access rights for module_.
  

Friends

• class OSB_DB::ModAccessGw

  Allow insert().
  

• class UserMgmtCfg

  Allow insert().
  

---

Member Typedef Documentation

typedef std::map<ModAccess::Oid, ModAccess> OSB_LIB::ModAccessMap::Entries

STL container to store the access rights of a module.

Definition at line 204 of file osbaccess.h.

---

Constructor & Destructor Documentation

OSB_LIB::ModAccessMap::ModAccessMap

(

const ModuleId

module = mdUnknown

)

[explicit]

Constructor with optional module.

---

Member Function Documentation

void OSB_LIB::ModAccessMap::accessRights	(	std::list< ModAccess > &	dest,
		const ModAccess::Oid &	parId = ModAccess::Oid()
	)			const

Get child access rights.

Parameters:

	dest	STL-container to populate. It is empty if no childs for parId exist.
	parId	The parent of the access rights to retrieve, if not set the 1st level (root) rights of the module are returned.

void OSB_LIB::ModAccessMap::check

(

const ModAccess &

access

)

const [private]

Check a module access.

Parameters:

access

Module access to verify.

Exceptions:

	ObjectNotFound	if the parent of access does not exist.
	OsbException	in case of duplicate access tags for the same parent.
	OsbException	(internal) if the module id's do not match.

const ModAccess* OSB_LIB::ModAccessMap::find

(

const ModAccess::Oid &

maId

)

const

Find a module access right.

Parameters:

maId

The object of the module access to retrieve.

Returns:

The module access right for maId,
0 if the access does not exist.

const ModAccess& OSB_LIB::ModAccessMap::get

(

const ModAccess::Oid &

maId

)

const

Get a module access right.

Parameters:

maId

The object of the module access to retrieve.

Exceptions:

ObjectNotFound

if the module access for maId does not exist in the list.

Returns:

The module access right for maId.

void OSB_LIB::ModAccessMap::insert

(

const ModAccess &

access

)

[private]

Add or replace an access right.

Parameters:

access

Module access to add or replace.

Note:

Except for the database gateway, check() should be called() before calling this function.

ModuleId OSB_LIB::ModAccessMap::module

(

)

const

The module of the access map.

void OSB_LIB::ModAccessMap::read

(

const OSB_DB::Session &

session

)

Read the access rights from the database.

Parameters:

session

Database to use.

Reads all access rights for module() from the database.

---

Friends And Related Function Documentation

friend class OSB_DB::ModAccessGw [friend]

Allow insert().

Definition at line 199 of file osbaccess.h.

friend class UserMgmtCfg [friend]

Allow insert().

Definition at line 201 of file osbaccess.h.

---

Member Data Documentation

Entries OSB_LIB::ModAccessMap::entries_ [private]

Access rights for module_.

Definition at line 293 of file osbaccess.h.

ModuleId OSB_LIB::ModAccessMap::module_ [private]

The module of the access map.

Definition at line 291 of file osbaccess.h.

---

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

• osbaccess.h

---