org.lsst.ccs.services

Class LocalAgentLockService

java.lang.Object

org.lsst.ccs.services.AbstractAgentLockServiceDelegate

org.lsst.ccs.services.LocalAgentLockService

All Implemented Interfaces:

AgentPresenceListener, AgentLockServiceDelegate, AgentLoginService.AgentLoginUpdateListener

public class LocalAgentLockService
extends AbstractAgentLockServiceDelegate

Client side locking service, for a given agent. It is attached to an instance of Agent, which is any agent with type >= CONSOLE. It provides an API both for consoles that need to lock/unlock a WORKER subsystem, and for WORKER subsystem that need to check the validity of a lock attached with a command request. It encapsulates the communication protocol with the centralized LockManager subsystem.

Author:

LSST CCS Team

Field Summary

Fields inherited from class org.lsst.ccs.services.AbstractAgentLockServiceDelegate

agentLevels, agentLockUpdateListeners, allLocks, heldLocks, listenerUpdatesLock, log, myCurrentLock, svc

Constructor Summary

Constructors

Constructor and Description
LocalAgentLockService(AgentLockService svc)

Method Summary

Modifier and Type	Method and Description
void	attachLock(String agentName)
void	destroyLock(String agentName, String userId)
void	detachLock(String agentName)
void	disconnected(AgentInfo... agents) Invoked when one or more agents are disconnected from this cluster, either because the shutdown or because they were lost.
Map<String,AgentLock>	getLocks()
void	lockAgent(String agentName)
void	preInit()
void	preStart()
void	setLevelForAgent(String agentName, int level)
void	unlockAgent(String agentName)
String	validateLock(DictionaryCommand command, AgentLock lock, int level)

Methods inherited from class org.lsst.ccs.services.AbstractAgentLockServiceDelegate

addAgentLockUpdateListener, addHeldLock, getAgent, getAgentStateService, getAllWorkerAgents, getAttachableAgents, getCurrentLock, getDetachableAgents, getExistingLockForAgent, getHeldLocks, getLevelForAgent, getLocallyLockedAgents, getLockableAgents, getLockedAgents, getLockForAgent, getMaxLevel, notifyGlobalLockListeners, notifyHeldLockListeners, notifyLevelListeners, notifyLockListeners, notifyLockVisibility, onAgentLoginUpdate, removeAgentLockUpdateListener, removeCurrentLock, removeHeldLock, setCurrentLock, setLevelInternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.messaging.AgentPresenceListener

connected, connecting, disconnecting

Constructor Detail

LocalAgentLockService

public LocalAgentLockService(AgentLockService svc)

Method Detail

setLevelForAgent

public void setLevelForAgent(String agentName,
                             int level)
                      throws UnauthorizedLevelException,
                             UnauthorizedLockException

Throws:

UnauthorizedLevelException

UnauthorizedLockException

lockAgent

public void lockAgent(String agentName)
               throws UnauthorizedLockException

Throws:

UnauthorizedLockException

attachLock

public void attachLock(String agentName)
                throws UnauthorizedLockException

Throws:

UnauthorizedLockException

detachLock

public void detachLock(String agentName)
                throws UnauthorizedLockException

Throws:

UnauthorizedLockException

unlockAgent

public void unlockAgent(String agentName)

disconnected

public void disconnected(AgentInfo... agents)

Description copied from interface: AgentPresenceListener

Invoked when one or more agents are disconnected from this cluster, either because the shutdown or because they were lost. The implementation should return immediately : any blocking operations should be scheduled on a separate thread.

getLocks

public Map<String,AgentLock> getLocks()

Specified by:

getLocks in interface AgentLockServiceDelegate

Overrides:

getLocks in class AbstractAgentLockServiceDelegate

preStart

public void preStart()

Specified by:

preStart in interface AgentLockServiceDelegate

Overrides:

preStart in class AbstractAgentLockServiceDelegate

preInit

public void preInit()

Specified by:

preInit in interface AgentLockServiceDelegate

Overrides:

preInit in class AbstractAgentLockServiceDelegate

validateLock

public String validateLock(DictionaryCommand command,
                           AgentLock lock,
                           int level)

Specified by:

validateLock in interface AgentLockServiceDelegate

Overrides:

validateLock in class AbstractAgentLockServiceDelegate

destroyLock

public void destroyLock(String agentName,
                        String userId)