org.lsst.ccs.gconsole.services.lock

Class LockService

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.services.lock.LockService

All Implemented Interfaces:

ConsoleService

@Plugin(name="Lock Service Plugin",
        id="lock-service",
        description="Graphical console service that provides interface between GUI components and Agent services dealing with locks, levels, logins, etc.")
public class LockService
extends ConsolePlugin
implements ConsoleService

Class that handles interactions between various command browser components and agent services involved in lock management.

Getters provided by this class should be used to retrieve lock management information related to multiple remote agents. For information on a specific agent, getters of the corresponding Locker instance can be used. All getters should be called on EDT.

To be notified of changes, command browser components register listeners through this class. LockService.Listener instances added through addListener(Listener) method are notified whenever the set of watched agents changes (a remote agent is watched if it is either connected to the buses or is locked by someone). To be notified of changes related to a specific agent, a ChangeListener should be registered on the corresponding Locker instance. Listener registration and removal can be requested on any thread, but the callbacks are always executed on EDT. Note that if an unlocked subsystem disconnects from the buses, the corresponding Locker instance is destroyed. Listeners that wish to resume receiving subsystem-specific events once the subsystem reconnects, should listen to service events and register themselves on the new Locker when it is created.

To initiate lock management related operations, clients can call one of the executeOperation(Operation, String, int), executeBulkOperation(Operation, List), and login(String, String) methods. These methods can be called on any thread. If the requested operation involves communicating over the buses, it will be offloaded to a worker thread.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LockService.Listener Listener interface for receiving notifications of changes in the set of agents watched by this service, and of changes in userID.
static class	LockService.Operation Lock management operations.
static class	LockService.State States of remote agents with respect to lock management.

Constructor Summary

Constructors

Constructor and Description
LockService()

Method Summary

Modifier and Type	Method and Description
void	addListener(LockService.Listener listener) Adds a listener to be notified of changes in the set of agents watched by this service, and of changes in userID.
void	executeBulkOperation(LockService.Operation op, List<String> agentNames) Executes the specified operation on multiple agents.
void	executeOperation(LockService.Operation op, String agentName, int level) Executes the specified operation on the given agent.
Locker	getAgent(String agentName) Returns Locker for the specified agent.
List<String>	getAgentNames(LockService.State... states) Lists names of agents in the specified states.
List<Locker>	getAgents(LockService.State... states) Returns Lockers for agents in one of the specified states.Like all getters of this class, this method should be called on EDT.
static LockService	getService()
String	getUserId() Returns user ID of this console.
void	login(String userID, String credentials) Changes user ID associated with this console.
void	removeListener(LockService.Listener listener) Removes a listener.
void	startService()
void	stopService()

Methods inherited from class org.lsst.ccs.gconsole.base.ConsolePlugin

getConsole, getServices, initialize, propertiesChanged, restore, save, setServicesProvider, shutdown, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

LockService

public LockService()

Method Detail

getService

public static LockService getService()

startService

public void startService()

Specified by:

startService in interface ConsoleService

stopService

public void stopService()

Specified by:

stopService in interface ConsoleService

getAgent

public Locker getAgent(String agentName)

Returns Locker for the specified agent. Like all getters of this class, this method should be called on EDT.

Parameters:

agentName - Agent name.

Returns:

Locker for the specified agent, or null if the agent is unlocked and offline.

getAgents

public List<Locker> getAgents(LockService.State... states)

Returns Lockers for agents in one of the specified states.Like all getters of this class, this method should be called on EDT.

Parameters:

states - States to include.

Returns:

Locker for the specified agent, or null if the agent is unlocked and offline.

getUserId

public String getUserId()

Returns user ID of this console. Like all getters of this class, this method should be called on EDT.

Returns:

User ID.

getAgentNames

public List<String> getAgentNames(LockService.State... states)

Lists names of agents in the specified states. Like all getters of this class, this method should be called on EDT.

Parameters:

states - States to include.

Returns:

List of agent names.

executeBulkOperation

public void executeBulkOperation(LockService.Operation op,
                                 List<String> agentNames)

Executes the specified operation on multiple agents. This method can be called on any thread. If the requested operation involves communicating over the buses, it will be offloaded to a worker thread.

Parameters:

op - Operation.

agentNames - Agent names.

executeOperation

public void executeOperation(LockService.Operation op,
                             String agentName,
                             int level)

Executes the specified operation on the given agent. This method can be called on any thread. If the requested operation involves communicating over the buses, it will be offloaded to a worker thread.

Parameters:

op - Operation.

agentName - Agent name.

level - Desired level (ignored for operations other than LEVEL.

login

public void login(String userID,
                  String credentials)

Changes user ID associated with this console. This method can be called on any thread. If the requested operation involves communicating over the buses, it will be offloaded to a worker thread.

Parameters:

userID - Desired user ID, or null if the user ID should be reset to system user name.

credentials - Ignored in the current implementation.

addListener

public void addListener(LockService.Listener listener)

Adds a listener to be notified of changes in the set of agents watched by this service, and of changes in userID.

Parameters:

listener - Listener to add.

removeListener

public void removeListener(LockService.Listener listener)

Removes a listener.

Parameters:

listener - Listener to remove.