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
void	attachLock(String agentName)
void	destroyLock(String agentName)
void	detachLock(String agentName)
int	get(AgentLockServiceCommands.SetGetLevelCommands what)
int	get(AgentLockServiceCommands.SetGetLevelCommands what, String agentName)
List<String>	getAllLockedOrLockableAgents()
List<String>	getAttachableAgents()
List<String>	getDetachableAgents()
int	getLevel(String agentName) Deprecated.
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) Deprecated.
String	showAllLocks()
String	showLocalLocks()
String	showLock(String agentName)
String	showLocks(String user)
void	unlock(String agentName)
String	whoami()

Methods inherited from class java.lang.Object

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

Method Detail

setLevel

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

Deprecated.

Throws:

Exception

getLevel

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

Deprecated.

set

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

Throws:

Exception

set

@Command(description="Set the level of an agent",
         level=0,
         type=QUERY)
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,
         type=QUERY)
public int get(@Argument(name="item")
                                                                                                        AgentLockServiceCommands.SetGetLevelCommands what,
                                                                                                        @Argument(allowedValueProvider="getAllLockedOrLockableAgents")
                                                                                                        String agentName)
                                                                                                 throws Exception

Throws:

Exception

get

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

Throws:

Exception

lock

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

Throws:

Exception

unlock

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

Throws:

Exception

attachLock

@Command(description="Attach the lock on the given subsystem to the current agent",
         type=QUERY)
public void attachLock(@Argument(allowedValueProvider="getAttachableAgents",defaultValue="CurrentTarget")
                                                                                                                                String agentName)
                                                                                                                         throws Exception

Throws:

Exception

detachLock

@Command(description="Detach the lock on the given subsystem from the current agent",
         type=QUERY)
public void detachLock(@Argument(allowedValueProvider="getDetachableAgents",defaultValue="CurrentTarget")
                                                                                                                                  String agentName)
                                                                                                                           throws Exception

Throws:

Exception

getLockedAgents

@Command(description="List subsystems locked by the current user",
         type=QUERY)
public List<String> getLockedAgents()

destroyLock

@Command(description="Unlock the given subsystem, even if it is locked by another user",
         type=QUERY)
public void destroyLock(@Argument(defaultValue="CurrentTarget")
                                                                                                                                      String agentName)
                                                                                                                               throws Exception

Throws:

Exception

getLockableAgents

@Command(description="List subsystems that are currently online and can be locked",
         type=QUERY)
public List<String> getLockableAgents()

getAttachableAgents

@Command(description="List locked subsystems that could be attached to the current agent",
         type=QUERY)
public List<String> getAttachableAgents()

getDetachableAgents

@Command(description="List locked and attached subsystems that could be detached from the current agent",
         type=QUERY)
public List<String> getDetachableAgents()

getAllLockedOrLockableAgents

public List<String> getAllLockedOrLockableAgents()

showLock

@Command(description="Show lock for the specified subsystem",
         type=QUERY)
public String showLock(@Argument(allowedValueProvider="getAllLockedOrLockableAgents",defaultValue="CurrentTarget")
                                                                                                          String agentName)

showLocks

@Command(description="List all locks owned by the specified user. If no user name is given, list locks owned by the current user.",
         type=QUERY)
public String showLocks(@Argument(defaultValue="")
                                                                                                                                                                                 String user)

showLocalLocks

@Command(description="List attached locks",
         type=QUERY)
public String showLocalLocks()

showAllLocks

@Command(description="List all existing locks",
         type=QUERY)
public String showAllLocks()

login

@Command(description="Set a specific user ID for the current console",
         type=QUERY)
public void login(String userId)
                                                                                                       throws Exception

Throws:

Exception

logout

@Command(description="Disconnect the user ID from the current console",
         type=QUERY)
public void logout()
                                                                                                         throws Exception

Throws:

Exception

whoami

@Command(description="Display current user ID",
         type=QUERY)
public String whoami()
                                                                                   throws Exception

Throws:

Exception