cern::laser::console::UserHandler Class Reference

Inheritance diagram for cern::laser::console::UserHandler:

[legend]

Collaboration diagram for cern::laser::console::UserHandler:

[legend]

List of all members.

Public Member Functions
abstract Collection	getUsers () throws LaserConsoleException
abstract User	getUser (String name) throws LaserConsoleException
abstract User	createUser (String name, String password) throws LaserConsoleException
abstract void	removeUser (String name) throws LaserConsoleException
Static Public Member Functions
static UserHandler	get () throws LaserConsoleException
Static Private Attributes
static UserHandler	instance = null

---

Detailed Description

Provides the services to handle alarm console users.

Author:

F.Calderini

See also:

cern.laser.console.User

---

Member Function Documentation

abstract User cern::laser::console::UserHandler::createUser	(	String	name,
		String	password
	)			throws LaserConsoleException [pure virtual]

Factory method. Define a new alarm console user.

Parameters:

	name	the user name.
	password	the user password.

Returns:

a new alarm console user instance.

Exceptions:

	LaserConsoleException	if the request can not be served.
	LaserUserDuplicationException	if the user already exists.

Implemented in cern::laser::console::impl::UserHandlerImpl, and cern::laser::guiplatform::user::helpers::UserHandler.

Referenced by com::cosylab::acs::alarm::AlarmUserTest::notestUserConfiguration(), com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler(), cern::laser::test::TestUserCreation::TestUserCreation(), and cern::laser::console::TestUserCreation::TestUserCreation().

static UserHandler cern::laser::console::UserHandler::get

(

)

throws LaserConsoleException [inline, static]

Factory method.

Returns:

an instance of the implementation class

Exceptions:

LaserConsoleException

if the request can not be served

Reimplemented in cern::laser::guiplatform::user::helpers::UserHandler.

References instance.

Referenced by cern::laser::guiplatform::user::UserHandlerFactory::getHandler().

abstract User cern::laser::console::UserHandler::getUser

(

String

name

)

throws LaserConsoleException [pure virtual]

Get the user by its name.

Parameters:

name

the user name.

Returns:

the alarm console user .

Exceptions:

	LaserConsoleException	if the request can not be served.
	LaserUserNotFoundException	if the user does not exist.

Implemented in cern::laser::console::impl::UserHandlerImpl, and cern::laser::guiplatform::user::helpers::UserHandler.

Referenced by cern::laser::test::junit::TestConsoleUser::getUser(), cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler(), cern::laser::test::TestConfiguration::TestConfiguration(), cern::laser::console::TestConfiguration::TestConfiguration(), cern::laser::test::TestConfigurationWindow::testConsoleConfigurationWindow(), cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration(), and cern::laser::test::TstConfiguration2::TstConfiguration2().

abstract Collection cern::laser::console::UserHandler::getUsers

(

)

throws LaserConsoleException [pure virtual]

Get all the defined alarm console users.

Returns:

defined alarm console users.

Exceptions:

LaserConsoleException

if the request can not be served.

Implemented in cern::laser::console::impl::UserHandlerImpl, and cern::laser::guiplatform::user::helpers::UserHandler.

Referenced by com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler(), and cern::laser::console::TestConfigurationBrowsing::TestConfigurationBrowsing().

abstract void cern::laser::console::UserHandler::removeUser

(

String

name

)

throws LaserConsoleException [pure virtual]

Remove an alarm console user.

Parameters:

name

the name of the user to remove.

Exceptions:

	LaserConsoleException	if the request can not be served.
	LaserUserNotFoundException	if the user does not exist.

Implemented in cern::laser::console::impl::UserHandlerImpl, and cern::laser::guiplatform::user::helpers::UserHandler.

Referenced by com::cosylab::acs::alarm::AlarmUserTest::notestUserConfiguration(), com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler(), and com::cosylab::acs::alarm::AlarmUserTest::tearDown().

---

Member Data Documentation

UserHandler cern::laser::console::UserHandler::instance = null [static, private]

Referenced by get().

---

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

• laser-console/src/cern/laser/console/UserHandler.java