OSB_CORBA::User_i Class Reference

Inheritance diagram for OSB_CORBA::User_i:

[legend]Collaboration diagram for OSB_CORBA::User_i:

[legend]List of all members.

---

Detailed Description

Servant class for User CORBA interface.

Definition at line 64 of file osbuser_i.h.

Public Member Functions

• User_i (const UserMgr_i &usrMgr, const Utf8String &login)

  Constructor.
  

• User_i (const UserMgr_i &usrMgr, const OSB_LIB::OsbUser &osbUser)

  Constructor.
  

• UserId id () throw (CORBA::SystemException, OsbCorbaException)

  Unique user id.
  

• Utf8String * loginName () throw (CORBA::SystemException, OsbCorbaException)

  Gets user login name.
  

• Utf8String * name () throw (CORBA::SystemException, OsbCorbaException)

  Gets user (full) name.
  

• Utf8String * email () throw (CORBA::SystemException, OsbCorbaException)

  Gets email address of the user.
  

• UserWriter_ptr getWriter () throw (CORBA::SystemException, OsbCorbaException)

  Create a writable copy of the user.
  

Modules and user groups available for the user.

• ModuleId defModule () throw (CORBA::SystemException, OsbCorbaException)

  Default OSB module of the user, it may not be set.
  

• ModuleIdSeq * availModules () throw (CORBA::SystemException, OsbCorbaException)

  List of OSB modules available to the user.
  

• CORBA::Boolean isAvailable (const ModuleId &id) throw (CORBA::SystemException, OsbCorbaException)

  Module available for the user?
  

• UserGroupId userGroup (const ModuleId &modId) throw (CORBA::SystemException, OsbCorbaException)

  Get the user group that defines the access rights for a module.
  

Static Public Attributes

• static const std::string IFC

Protected Member Functions

• OSB_LIB::RwGuard readLock ()

  Read lock osbUser_.
  

• OSB_LIB::RwGuard writeLock ()

  Write lock osbUser_.
  

Protected Attributes

• const UserMgr_i & usrMgr_

  Controlling user manager.
  

• OSB_LIB::OsbUser osbUser_

  OSB user object.
  

• OSB_LIB::RwMutex mutex_

  Mutex to protect the access to osbUser_.
  

Private Member Functions

• bool reassign (const OSB_LIB::OsbUser &osbUser)

  Reassign OSB user.
  

Friends

• class UserMgr_i

  Allow UserMgr_i to call reassign().
  

---

Constructor & Destructor Documentation

OSB_CORBA::User_i::User_i	(	const UserMgr_i &	usrMgr,
		const Utf8String &	login
	)

Constructor.

Parameters:

	usrMgr	Controlling user manager.
	login	OSB user login.

OSB_CORBA::User_i::User_i	(	const UserMgr_i &	usrMgr,
		const OSB_LIB::OsbUser &	osbUser
	)

Constructor.

Parameters:

	usrMgr	Controlling user manager.
	osbUser	OSB user.

---

Member Function Documentation

ModuleIdSeq* OSB_CORBA::User_i::availModules

(

)

throw (CORBA::SystemException, OsbCorbaException)

List of OSB modules available to the user.

ModuleId OSB_CORBA::User_i::defModule

(

)

throw (CORBA::SystemException, OsbCorbaException)

Default OSB module of the user, it may not be set.

Utf8String* OSB_CORBA::User_i::email

(

)

throw (CORBA::SystemException, OsbCorbaException)

Gets email address of the user.

UserWriter_ptr OSB_CORBA::User_i::getWriter

(

)

throw (CORBA::SystemException, OsbCorbaException)

Create a writable copy of the user.

Returns:

A CORBA object that allows to modify the user.

UserId OSB_CORBA::User_i::id

(

)

throw (CORBA::SystemException, OsbCorbaException)

Unique user id.

User id is unique and created by the system. It cannot be changed once created.

CORBA::Boolean OSB_CORBA::User_i::isAvailable

(

const ModuleId &

id

)

throw (CORBA::SystemException, OsbCorbaException)

Module available for the user?

Utf8String* OSB_CORBA::User_i::loginName

(

)

throw (CORBA::SystemException, OsbCorbaException)

Gets user login name.

Returns:

user login name.

Utf8String* OSB_CORBA::User_i::name

(

)

throw (CORBA::SystemException, OsbCorbaException)

Gets user (full) name.

The user (full) name is not used for login. It is for information only.

Returns:

user (full) name.

OSB_LIB::RwGuard OSB_CORBA::User_i::readLock

(

)

[protected]

Read lock osbUser_.

Must not be called when holding a write lock.

Exceptions:

OsbCorbaException

of the lock fails.

bool OSB_CORBA::User_i::reassign

(

const OSB_LIB::OsbUser &

osbUser

)

[private]

Reassign OSB user.

Parameters:

osbUser

Returns:

true if the object id's of the old and new OSB user are the same, else false.

UserGroupId OSB_CORBA::User_i::userGroup

(

const ModuleId &

modId

)

throw (CORBA::SystemException, OsbCorbaException)

Get the user group that defines the access rights for a module.

Parameters:

modId

Id of the module.

Returns:

The id of the user group for module,
it is 0 if the user does not have access to the module.

OSB_LIB::RwGuard OSB_CORBA::User_i::writeLock

(

)

[protected]

Write lock osbUser_.

Must not be called when holding a read lock.

Exceptions:

OsbCorbaException

of the lock fails.

---

Friends And Related Function Documentation

friend class UserMgr_i [friend]

Allow UserMgr_i to call reassign().

Definition at line 66 of file osbuser_i.h.

---

Member Data Documentation

const std::string OSB_CORBA::User_i::IFC [static]

Reimplemented in OSB_CORBA::UserWriter_i.

Definition at line 68 of file osbuser_i.h.

OSB_LIB::RwMutex OSB_CORBA::User_i::mutex_ [protected]

Mutex to protect the access to osbUser_.

Definition at line 193 of file osbuser_i.h.

OSB_LIB::OsbUser OSB_CORBA::User_i::osbUser_ [protected]

OSB user object.

Definition at line 191 of file osbuser_i.h.

const UserMgr_i& OSB_CORBA::User_i::usrMgr_ [protected]

Controlling user manager.

Definition at line 189 of file osbuser_i.h.

---

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

• osbuser_i.h

---