cern.laser.console

Class UserHandler

java.lang.Object

cern.laser.console.UserHandler

Direct Known Subclasses:

UserHandlerImpl

public abstract class UserHandler
extends java.lang.Object

Provides the services to handle alarm console users.

Author:

F.Calderini

See Also:

User

Constructor Summary

Constructors

Constructor and Description
UserHandler()

Method Summary

Modifier and Type	Method and Description
abstract User	createUser(java.lang.String name, java.lang.String password) Factory method.
static UserHandler	get(org.omg.CORBA.ORB orb, AcsLogger logger) Factory method.
abstract User	getUser(java.lang.String name, org.omg.CORBA.ORB orb, AcsLogger logger) Get the user by its name.
abstract java.util.Collection	getUsers() Get all the defined alarm console users.
abstract void	removeUser(java.lang.String name) Remove an alarm console user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserHandler

public UserHandler()

Method Detail

get

public static UserHandler get(org.omg.CORBA.ORB orb,
                              AcsLogger logger)
                       throws LaserConsoleException

Factory method.

Returns:

an instance of the implementation class

Throws:

LaserConsoleException - if the request can not be served

getUsers

public abstract java.util.Collection getUsers()
                                       throws LaserConsoleException

Get all the defined alarm console users.

Returns:

defined alarm console users.

Throws:

LaserConsoleException - if the request can not be served.

getUser

public abstract User getUser(java.lang.String name,
                             org.omg.CORBA.ORB orb,
                             AcsLogger logger)
                      throws LaserConsoleException

Get the user by its name.

Parameters:

name - the user name.

Returns:

the alarm console user .

Throws:

LaserConsoleException - if the request can not be served.

LaserUserNotFoundException - if the user does not exist.

createUser

public abstract User createUser(java.lang.String name,
                                java.lang.String password)
                         throws LaserConsoleException

Factory method. Define a new alarm console user.

Parameters:

name - the user name.

password - the user password.

Returns:

a new alarm console user instance.

Throws:

LaserConsoleException - if the request can not be served.

LaserUserDuplicationException - if the user already exists.

removeUser

public abstract void removeUser(java.lang.String name)
                         throws LaserConsoleException

Remove an alarm console user.

Parameters:

name - the name of the user to remove.

Throws:

LaserConsoleException - if the request can not be served.

LaserUserNotFoundException - if the user does not exist.