org.lsst.ccs.subsystem.shell

Class AgentLockServiceCommands

java.lang.Object

org.lsst.ccs.subsystem.shell.AgentLockServiceCommands

public class AgentLockServiceCommands
extends Object

Commands for agent lock service.

Author:

emarin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentLockServiceCommands.SetGetLevelCommands

Method Summary

Modifier and Type	Method and Description
int	get(AgentLockServiceCommands.SetGetLevelCommands what)
int	get(AgentLockServiceCommands.SetGetLevelCommands what, String agentName)
List<String>	getAllWorkerAgents()
int	getLevel(String agentName)
List<String>	getLockableAgents()
List<String>	getLockedAgents()
void	lock(String agentName)
void	login(String userId)
void	logout()
void	set(AgentLockServiceCommands.SetGetLevelCommands what, int level)
void	set(AgentLockServiceCommands.SetGetLevelCommands what, String agentName, int level)
void	setLevel(String agentName, int level)
void	unlock(String agentName)

Methods inherited from class java.lang.Object

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

Method Detail

setLevel

@Command(description="Set this agent\'s authorized operational level for the given subsystem")
public void setLevel(@Argument(allowedValueProvider="getAllWorkerAgents")
                                                                                                                    String agentName,
                                                                                                                    int level)
                                                                                                             throws Exception

Throws:

Exception

getLevel

@Command(description="Get this agent\'s authorized operatinal level for the given subsystem")
public int getLevel(@Argument(allowedValueProvider="getAllWorkerAgents")
                                                                                                                  String agentName)

set

@Command(description="Set the level of an agent",
         level=0)
public void set(@Argument(name="item")
                                                                                    AgentLockServiceCommands.SetGetLevelCommands what,
                                                                                    @Argument(allowedValueProvider="getAllWorkerAgents")
                                                                                    String agentName,
                                                                                    int level)
                                                                             throws Exception

Throws:

Exception

set

@Command(description="Set the level of an agent",
         level=0)
public void set(@Argument(name="item")
                                                                                    AgentLockServiceCommands.SetGetLevelCommands what,
                                                                                    int level)
                                                                             throws Exception

Throws:

Exception

get

@Command(description="Get the level of an agent",
         level=0)
public int get(@Argument(name="item")
                                                                                   AgentLockServiceCommands.SetGetLevelCommands what,
                                                                                   @Argument(allowedValueProvider="getAllWorkerAgents")
                                                                                   String agentName)
                                                                            throws Exception

Throws:

Exception

get

@Command(description="Get the level of an agent",
         level=0)
public int get(@Argument(name="item")
                                                                                   AgentLockServiceCommands.SetGetLevelCommands what)
                                                                            throws Exception

Throws:

Exception

lock

@Command(description="Lock the given subsystem")
public void lock(@Argument(allowedValueProvider="getLockableAgents",defaultValue="CurrentTarget")
                                                                  String agentName)
                                                           throws Exception

Throws:

Exception

unlock

@Command(description="Unlock the given subsystem")
public void unlock(@Argument(allowedValueProvider="getLockedAgents",defaultValue="CurrentTarget")
                                                                      String agentName)
                                                               throws Exception

Throws:

Exception

getLockedAgents

@Command(description="Show locked agents")
public List<String> getLockedAgents()

getLockableAgents

@Command(description="Show agents that could be locked")
public List<String> getLockableAgents()

getAllWorkerAgents

public List<String> getAllWorkerAgents()

login

@Command(description="Set the user ID for the current console in order to take locks")
public void login(String userId)
                                                                                                  throws Exception

Throws:

Exception

logout

@Command(description="Disconnect the user from the console")
public void logout()