org.lsst.ccs.services

Class RemoteAgentLockService

java.lang.Object

org.lsst.ccs.services.AbstractAgentLockServiceDelegate

org.lsst.ccs.services.RemoteAgentLockService

All Implemented Interfaces:

AgentPresenceListener, AgentLockServiceDelegate, AgentLoginService.AgentLoginUpdateListener

public class RemoteAgentLockService
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
RemoteAgentLockService(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	lockAgent(String agentName)
void	preInit()
void	preStart()
void	setLevelForAgent(String agentName, int level)
void	unlockAgent(String agentName)

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

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

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, disconnected, disconnecting

Constructor Detail

RemoteAgentLockService

public RemoteAgentLockService(AgentLockService svc)

Method Detail

preInit

public void preInit()

Specified by:

preInit in interface AgentLockServiceDelegate

Overrides:

preInit in class AbstractAgentLockServiceDelegate

preStart

public void preStart()

Specified by:

preStart in interface AgentLockServiceDelegate

Overrides:

preStart in class AbstractAgentLockServiceDelegate

setLevelForAgent

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

Throws:

UnauthorizedLevelException

UnauthorizedLockException

attachLock

public void attachLock(String agentName)
                throws UnauthorizedLockException

Throws:

UnauthorizedLockException

detachLock

public void detachLock(String agentName)
                throws UnauthorizedLockException

Throws:

UnauthorizedLockException

lockAgent

public void lockAgent(String agentName)
               throws UnauthorizedLockException

Throws:

UnauthorizedLockException

unlockAgent

public void unlockAgent(String agentName)
                 throws UnauthorizedLockException

Throws:

UnauthorizedLockException

destroyLock

public void destroyLock(String agentName,
                        String userId)