OSB_CORBA::UserMgr_i Class Reference

Inheritance diagram for OSB_CORBA::UserMgr_i:

[legend]Collaboration diagram for OSB_CORBA::UserMgr_i:

[legend]List of all members.

---

Detailed Description

Servant class for PrivilegeManager CORBA interface.

Definition at line 61 of file osbusermgr_i.h.

Public Member Functions

• UserMgr_i (PortableServer::POA_ptr rootPoa, PortableServer::POAManager_ptr poaManager)

  Constructor.
  

• PortableServer::POA_ptr writerPoa () const

  Get Writer POA.
  

User management:

• User_ptr login (const Utf8String &loginName, const Utf8String &password) throw (CORBA::SystemException, OsbCorbaException)

  Enables a user to login.
  

• User_ptr getUser (const UserId &userId) throw (CORBA::SystemException, OsbCorbaException)

  Get OSB user object.
  

• UserSeq * getUsers () throw (CORBA::SystemException, OsbCorbaException)

  Get list of OSB users.
  

• UserWriter_ptr createUser (const Utf8String &loginName, const Utf8String &password) throw (CORBA::SystemException, OsbCorbaException)

  Creates a new user.
  

• CORBA::Boolean removeUser (const UserId &userId, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Delete an OSB user in the database.
  

User groups:

• UserGroup * userGroup (const UserGroupId &grpId) throw (CORBA::SystemException, OsbCorbaException)

  Get information about a user group.
  

• UserGroupSeq * userGroups (const ModuleId &modId) throw (CORBA::SystemException)

  Get list of user groups for a module.
  

• UserGroupSeq * allUserGroups () throw (CORBA::SystemException)

  Get the list of all user groups.
  

Static Public Attributes

• static const std::string IFC

  Name of servant class.
  

Private Types

• typedef corba::osbadm::UserMgr::UserSeq UserSeq

  Short-hand for a list of OSB users.
  

• typedef corba::osbadm::UserMgr::UserGroupSeq UserGroupSeq

  Short-hand for a list of user groups.
  

Private Member Functions

• UserMgr_i (const UserMgr_i &)

  Prevent copying: not implemented.
  

• UserMgr_i & operator= (const UserMgr_i &)

  Prevent assignment: not implemented.
  

• void createUserPoa (PortableServer::POA_ptr rootPoa, PortableServer::POAManager_ptr poaManager)

  Create User POA.
  

• void createWriterPoa (PortableServer::POA_ptr rootPoa, PortableServer::POAManager_ptr poaManager)

  Create Writer POA.
  

• User_ptr userServant (const OSB_LIB::OsbUser &user)

  Get or create servant for an OSB user.
  

Private Attributes

• PortableServer::POA_var userPoa_

  OSB User Poa.
  

• Locators userLoc_

  OSB user servant locator.
  

• PortableServer::POA_var writerPoa_

  POA for OSB user writers.
  

---

Member Typedef Documentation

typedef corba::osbadm::UserMgr::UserGroupSeq OSB_CORBA::UserMgr_i::UserGroupSeq [private]

Short-hand for a list of user groups.

Definition at line 66 of file osbusermgr_i.h.

typedef corba::osbadm::UserMgr::UserSeq OSB_CORBA::UserMgr_i::UserSeq [private]

Short-hand for a list of OSB users.

Definition at line 64 of file osbusermgr_i.h.

---

Constructor & Destructor Documentation

OSB_CORBA::UserMgr_i::UserMgr_i	(	PortableServer::POA_ptr	rootPoa,
		PortableServer::POAManager_ptr	poaManager
	)

Constructor.

Parameters:

	rootPoa	Pointer to Root POA.
	poaManager	Pointer to POA Manager.

OSB_CORBA::UserMgr_i::UserMgr_i

(

const UserMgr_i &

)

[private]

Prevent copying: not implemented.

---

Member Function Documentation

UserGroupSeq* OSB_CORBA::UserMgr_i::allUserGroups

(

)

throw (CORBA::SystemException)

Get the list of all user groups.

UserWriter_ptr OSB_CORBA::UserMgr_i::createUser	(	const Utf8String &	loginName,
		const Utf8String &	password
	)			throw (CORBA::SystemException, OsbCorbaException)

Creates a new user.

Parameters:

	loginName	Login name of the user.
	password	Password of the user.

Returns:

Newly created, writable User.

Exceptions:

OsbCorbaException

login name is empty or too long. password is too long. in case of database errors.

void OSB_CORBA::UserMgr_i::createUserPoa	(	PortableServer::POA_ptr	rootPoa,
		PortableServer::POAManager_ptr	poaManager
	)			[private]

Create User POA.

Parameters:

	rootPoa	Root POA.
	poaManager	POA Manager.

void OSB_CORBA::UserMgr_i::createWriterPoa	(	PortableServer::POA_ptr	rootPoa,
		PortableServer::POAManager_ptr	poaManager
	)			[private]

Create Writer POA.

Parameters:

	rootPoa	Root POA.
	poaManager	POA Manager.

User_ptr OSB_CORBA::UserMgr_i::getUser

(

const UserId &

userId

)

throw (CORBA::SystemException, OsbCorbaException)

Get OSB user object.

Parameters:

userId

The Id of the OSB user.

Returns:

OSB user.

Exceptions:

OsbCorbaException

if the user does not exist.

UserSeq* OSB_CORBA::UserMgr_i::getUsers

(

)

throw (CORBA::SystemException, OsbCorbaException)

Get list of OSB users.

Exceptions:

OsbCorbaException

in case of a database error while reading the users.

User_ptr OSB_CORBA::UserMgr_i::login	(	const Utf8String &	loginName,
		const Utf8String &	password
	)			throw (CORBA::SystemException, OsbCorbaException)

Enables a user to login.

Parameters:

	loginName	Login name of the user.
	password	Password of the user.

Returns:

True on successful login else false.

Exceptions:

OsbCorbaException

in case of database errors.

UserMgr_i& OSB_CORBA::UserMgr_i::operator=

(

const UserMgr_i &

)

[private]

Prevent assignment: not implemented.

CORBA::Boolean OSB_CORBA::UserMgr_i::removeUser	(	const UserId &	userId,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException)

Delete an OSB user in the database.

Parameters:

	userId	Id of the OSB user to remove.
	noWait	Wait for database locks.

Returns:

true if the user does no more exist in the database after the function returns, else false.

Exceptions:

OsbCorbaException

in case of a database error.

UserGroup* OSB_CORBA::UserMgr_i::userGroup

(

const UserGroupId &

grpId

)

throw (CORBA::SystemException, OsbCorbaException)

Get information about a user group.

Exceptions:

OsbCorbaException

if the group does not exist or was not read from the database.

UserGroupSeq* OSB_CORBA::UserMgr_i::userGroups

(

const ModuleId &

modId

)

throw (CORBA::SystemException)

Get list of user groups for a module.

Parameters:

modId

The id of the module to use.

Returns:

The user groups that define access rights for modId, it is empty if no matching user groups exist.

User_ptr OSB_CORBA::UserMgr_i::userServant

(

const OSB_LIB::OsbUser &

user

)

[private]

Get or create servant for an OSB user.

PortableServer::POA_ptr OSB_CORBA::UserMgr_i::writerPoa

(

)

const [inline]

Get Writer POA.

Definition at line 184 of file osbusermgr_i.h.

References writerPoa_.

---

Member Data Documentation

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

Name of servant class.

Definition at line 70 of file osbusermgr_i.h.

Locators OSB_CORBA::UserMgr_i::userLoc_ [private]

OSB user servant locator.

Definition at line 218 of file osbusermgr_i.h.

PortableServer::POA_var OSB_CORBA::UserMgr_i::userPoa_ [private]

OSB User Poa.

Definition at line 216 of file osbusermgr_i.h.

PortableServer::POA_var OSB_CORBA::UserMgr_i::writerPoa_ [private]

POA for OSB user writers.

Definition at line 221 of file osbusermgr_i.h.

Referenced by writerPoa().

---

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

• osbusermgr_i.h

---