corba::osbadm::UserMgr Interface Reference

List of all members.

---

Detailed Description

Manages the privileges of the user.

This CORBA interface enables new user creation, login and logout of existing users.

Definition at line 55 of file osbusermgr.idl.

User groups:

• typedef sequence< UserGroup > UserGroupSeq

  List of OSB user groups.
  

• UserGroup userGroup (in UserGroupId grpId) raises (common::OsbCorbaException)

  Get information about a user group.
  

• UserGroupSeq userGroups (in ModuleId modId)

  Get list of user groups for a module.
  

• UserGroupSeq allUserGroups ()

  Get the list of all user groups.
  

User management:

• typedef sequence< User > UserSeq

  List of OSB users.
  

• User login (in common::Utf8String loginName, in common::Utf8String password) raises (common::OsbCorbaException)

  Enables a user to login.
  

• UserWriter createUser (in common::Utf8String loginName, in common::Utf8String password) raises (common::OsbCorbaException)

  Creates a new user.
  

• User getUser (in UserId id) raises (common::OsbCorbaException)

  Get OSB user by its id.
  

• boolean removeUser (in UserId id, in boolean noWait) raises (common::OsbCorbaException)

  Delete an OSB user in the database.
  

• UserSeq getUsers () raises (common::OsbCorbaException)

  Get list of OSB users.
  

---

Member Typedef Documentation

typedef sequence<UserGroup> corba::osbadm::UserMgr::UserGroupSeq

List of OSB user groups.

Definition at line 59 of file osbusermgr.idl.

typedef sequence<User> corba::osbadm::UserMgr::UserSeq

List of OSB users.

Definition at line 138 of file osbusermgr.idl.

---

Member Function Documentation

UserGroupSeq corba::osbadm::UserMgr::allUserGroups

(

)

Get the list of all user groups.

UserWriter corba::osbadm::UserMgr::createUser	(	in common::Utf8String	loginName,
		in common::Utf8String	password
	)			raises (common::OsbCorbaException)

Creates a new user.

Parameters:

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

Returns:

Newly created, writable User.

Exceptions:

OsbCorbaException

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

User corba::osbadm::UserMgr::getUser

(

in UserId

id

)

raises (common::OsbCorbaException)

Get OSB user by its id.

Parameters:

id

The id of the OSB user.

Returns:

OSB user.

Exceptions:

OsbCorbaException

if user does not exist.

UserSeq corba::osbadm::UserMgr::getUsers

(

)

raises (common::OsbCorbaException)

Get list of OSB users.

Exceptions:

OsbCorbaException

in case of a database error while reading the users.

User corba::osbadm::UserMgr::login	(	in common::Utf8String	loginName,
		in common::Utf8String	password
	)			raises (common::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.

boolean corba::osbadm::UserMgr::removeUser	(	in UserId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Delete an OSB user in the database.

Parameters:

	id	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 corba::osbadm::UserMgr::userGroup

(

in UserGroupId

grpId

)

raises (common::OsbCorbaException)

Get information about a user group.

Exceptions:

OsbCorbaException

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

UserGroupSeq corba::osbadm::UserMgr::userGroups

(

in ModuleId

modId

)

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.

---

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

• osbusermgr.idl

---