AgentLockServiceDelegate (LSST CCS - Toolkit (Pom) 6.1.14 API)

All Known Implementing Classes:

AbstractAgentLockServiceDelegate, LocalAgentLockService, RemoteAgentLockService
```
public interface AgentLockServiceDelegate
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener slul)`
`void`	`attachLock(String agentName)`
`void`	`destroyLock(String agentName, String userId)`
`void`	`detachLock(String agentName)`
`List<String>`	`getAllWorkerAgents()`
`List<String>`	`getAttachableAgents()`
`List<String>`	`getDetachableAgents()`
`AgentLock`	`getExistingLockForAgent(String agentName)`
`Map<String,AgentLock>`	`getHeldLocks()`
`int`	`getLevelForAgent(String agentName)`
`List<String>`	`getLocallyLockedAgents()`
`List<String>`	`getLockableAgents()`
`List<String>`	`getLockedAgents()`
`AgentLock`	`getLockForAgent(String agentName)`
`Map<String,AgentLock>`	`getLocks()`
`void`	`lockAgent(String agentName)` Request for this agent to obtain a lock on the given subsystem.
`void`	`preInit()`
`void`	`preStart()`
`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
```
    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.
    
    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
```
    Request for this agent to obtain a lock on the given subsystem. If successful, this agent will own a lock on the requested subsystem. registered AgentLockUpdateListener will be notified. The list of owned valid locks will be updated.
    
    Parameters:
    
    agentName -
    
    Throws:
    
    UnauthorizedLockException - if the user is not allowed to acquire a lock on the specified Agent
  - unlockAgent
```
void unlockAgent(String agentName)
          throws UnauthorizedLockException
```
    Throws:
    
    UnauthorizedLockException
  - attachLock
```
void attachLock(String agentName)
         throws UnauthorizedLockException
```
    Throws:
    
    UnauthorizedLockException
  - detachLock
```
void detachLock(String agentName)
         throws UnauthorizedLockException
```
    Throws:
    
    UnauthorizedLockException
  - 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()
```
  - addAgentLockUpdateListener
```
void addAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener slul)
```
  - removeAgentLockUpdateListener
```
void removeAgentLockUpdateListener(AgentLockService.AgentLockUpdateListener l)
```
  - getAttachableAgents
```
List<String> getAttachableAgents()
```
  - getDetachableAgents
```
List<String> getDetachableAgents()
```
  - getLockableAgents
```
List<String> getLockableAgents()
```
  - getLockedAgents
```
List<String> getLockedAgents()
```
  - getAllWorkerAgents
```
List<String> getAllWorkerAgents()
```
  - getLocallyLockedAgents
```
List<String> getLocallyLockedAgents()
```
  - getExistingLockForAgent
```
AgentLock getExistingLockForAgent(String agentName)
```
  - destroyLock
```
void destroyLock(String agentName,
                 String userId)
```

Interface AgentLockServiceDelegate

Method Summary

Method Detail

preInit

preStart

setLevelForAgent

lockAgent

unlockAgent

attachLock

detachLock

validateLock

getLocks

getLevelForAgent

getLockForAgent

getHeldLocks

addAgentLockUpdateListener

removeAgentLockUpdateListener

getAttachableAgents

getDetachableAgents

getLockableAgents

getLockedAgents

getAllWorkerAgents

getLocallyLockedAgents

getExistingLockForAgent

destroyLock