Public Member Functions | Static Public Member Functions

cern.laser.console.UserHandler Class Reference

Inheritance diagram for cern.laser.console.UserHandler:
cern.laser.console.impl.UserHandlerImpl

List of all members.

Public Member Functions

abstract Collection getUsers () throws LaserConsoleException
abstract User getUser (String name, ORB orb, AcsLogger logger) 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 (ORB orb, AcsLogger logger) throws LaserConsoleException

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.

static UserHandler cern.laser.console.UserHandler.get ( ORB  orb,
AcsLogger  logger 
) throws LaserConsoleException [static]

Factory method.

Returns:
an instance of the implementation class
Exceptions:
LaserConsoleException if the request can not be served
abstract User cern.laser.console.UserHandler.getUser ( String  name,
ORB  orb,
AcsLogger  logger 
) 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.

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.

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.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:30 for ACS-10.0 Java API by  doxygen 1.7.0