org.cyclopsgroup.jmxterm.cmd

Class SetCommand

java.lang.Object

org.cyclopsgroup.jmxterm.Command

org.cyclopsgroup.jmxterm.cmd.SetCommand

All Implemented Interfaces:

org.cyclopsgroup.jcli.AutoCompletable

@Cli(name="set",
     description="Set value of an MBean attribute")
public class SetCommand
extends Command

Command to set an attribute

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
SetCommand()

Method Summary

Modifier and Type	Method and Description
protected List<String>	doSuggestArgument() Provide a list of possible arguments for auto completion.
protected List<String>	doSuggestOption(String optionName) Provide a list of possible option values for auto completion
void	execute() Execute command
void	setArguments(List<String> arguments)
void	setBean(String bean)
void	setDomain(String domain)

Methods inherited from class org.cyclopsgroup.jmxterm.Command

getSession, isHelp, setHelp, setSession, suggestArgument, suggestOption

Methods inherited from class java.lang.Object

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

Constructor Detail

SetCommand

public SetCommand()

Method Detail

doSuggestArgument

protected List<String> doSuggestArgument()
                                  throws IOException,
                                         JMException

Description copied from class: Command

Provide a list of possible arguments for auto completion. This method returns list of arguments(not option) and is called when user presses tab key.

Overrides:

doSuggestArgument in class Command

Returns:

List of possible arguments used by auto completion or NULL

Throws:

IOException - IO errors

JMException - JMX problemo

doSuggestOption

protected List<String> doSuggestOption(String optionName)
                                throws JMException

Description copied from class: Command

Provide a list of possible option values for auto completion

Overrides:

doSuggestOption in class Command

Parameters:

optionName - Name of option

Returns:

List of possible arguments used by auto completion or NULL

Throws:

JMException - JMX errors

execute

public void execute()
             throws JMException,
                    IOException

Description copied from class: Command

Execute command

Specified by:

execute in class Command

Throws:

JMException - JMX errors

IOException - IO errors

setArguments

@MultiValue(listType=java.util.ArrayList.class,
            minValues=2)
 @Argument(description="name, value, value2...")
public final void setArguments(List<String> arguments)

Parameters:

arguments - Argument list. The first argument is attribute name

setBean

@Option(name="b",
        longName="bean",
        description="MBean name where the attribute is. Optional if bean has been set")
public final void setBean(String bean)

Parameters:

bean - Bean where the attribute is

setDomain

@Option(name="d",
        longName="domain",
        description="Domain under which the bean is")
public final void setDomain(String domain)

Parameters:

domain - Domain where the bean is