Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

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

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

Inheritance graph
[legend]
Collaboration diagram for cern::laser::console::UserHandler:

Collaboration graph
[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

UserHandler get () throws LaserConsoleException

Static Private Attributes

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.

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.

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.

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.

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.


Member Data Documentation

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


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:08:59 2009 for ACS Java API by doxygen 1.3.8