org.lsst.ccs.services

Interface AgentLockServiceDelegate

All Known Implementing Classes:

AbstractAgentLockServiceDelegate, LocalAgentLockService, RemoteAgentLockService

public interface AgentLockServiceDelegate

Method Summary

Modifier and Type	Method and Description
void	addAgentLevelListener(AgentLockService.AgentLevelListener l)
void	addAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener slul)
List<String>	getAllWorkerAgents()
Map<String,AgentLock>	getHeldLocks()
int	getLevelForAgent(String agentName)
List<String>	getLockableAgents()
List<String>	getLockedAgents()
AgentLock	getLockForAgent(String agentName)
Map<String,AgentLock>	getLocks()
void	lockAgent(String agentName)
void	preInit()
void	preStart()
void	removeAgentLevelListener(AgentLockService.AgentLevelListener l)
void	removeAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener l)
void	setLevelForAgent(String agentName, int level) Set this agent's operational level for the given subsystem.
void	unlockAgent(String agentName)
boolean	validateLock(AgentLock lock)

Method Detail

preInit

void preInit()

preStart

void preStart()

setLevelForAgent

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

Set this agent's operational level for the given subsystem. If this agent does not hold a lock on the subsystem, this method will first attempt to acquire a lock on the subsystem. If successful, registered AgentLevelListener will be notified with the new level value

Parameters:

agentName - the subsystem for which to change the level

level - the level to set

Throws:

UnauthorizedLevelException - if the requested level cannot be set. This happens if this agent owns a lock on the given subsystem and that lock defines a maximum level that is lower than the requested level, or if this agent does not hold a lock on the given subsystem and this agent's default subsystem level is lower than the requested level.

UnauthorizedLockException - if the user is not allowed to acquire a lock on the specified Agent

IOException - if there was a communication problem on the buses.

lockAgent

void lockAgent(String agentName)
        throws UnauthorizedLockException,
               IOException

Throws:

UnauthorizedLockException

IOException

unlockAgent

void unlockAgent(String agentName)
          throws IOException

Throws:

IOException

validateLock

boolean validateLock(AgentLock lock)

getLocks

Map<String,AgentLock> getLocks()

getLevelForAgent

int getLevelForAgent(String agentName)

getLockForAgent

AgentLock getLockForAgent(String agentName)

getHeldLocks

Map<String,AgentLock> getHeldLocks()

addAgentLevelListener

void addAgentLevelListener(AgentLockService.AgentLevelListener l)

removeAgentLevelListener

void removeAgentLevelListener(AgentLockService.AgentLevelListener l)

addAgentLockUpdateListener

void addAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener slul)

removeAgentLockUpdateListener

void removeAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener l)

getLockableAgents

List<String> getLockableAgents()

getLockedAgents

List<String> getLockedAgents()

getAllWorkerAgents

List<String> getAllWorkerAgents()