org.cyclopsgroup.jmxterm.cmd

Class BeanCommand

java.lang.Object

org.cyclopsgroup.jmxterm.Command

org.cyclopsgroup.jmxterm.cmd.BeanCommand

All Implemented Interfaces:

org.cyclopsgroup.jcli.AutoCompletable

@Cli(name="bean",
     description="Display or set current selected MBean. ",
     note="Without any parameter, it displays current selected bean, otherwise it selects the bean defined by the first parameter. eg. bean java.lang:type=Memory")
public class BeanCommand
extends Command

Command to display or set current bean

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
BeanCommand()

Method Summary

Modifier and Type	Method and Description
List<String>	doSuggestArgument() Provide a list of possible arguments for auto completion.
List<String>	doSuggestOption(String optionName) Provide a list of possible option values for auto completion
void	execute() Execute command
static String	getBeanName(String bean, String domain, Session session) Get full MBean name with given bean name, domain and session
(package private) static List<String>	getCandidateBeanNames(Session session) Gets a list of candidate beans.
void	setBean(String bean) Set bean option
void	setDomain(String domain) Set domain option

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

BeanCommand

public BeanCommand()

Method Detail

getBeanName

public static String getBeanName(String bean,
                                 String domain,
                                 Session session)
                          throws JMException,
                                 IOException

Get full MBean name with given bean name, domain and session

Parameters:

bean - Name of bean. It can be NULL so that session#getBean() is returned

domain - Domain for bean

session - Current session

Returns:

Full qualified name of MBean

Throws:

JMException - Thrown when given MBean name is malformed

IOException - allows IO exceptions.

getCandidateBeanNames

static List<String> getCandidateBeanNames(Session session)
                                   throws MalformedObjectNameException

Gets a list of candidate beans.

Throws:

MalformedObjectNameException

doSuggestArgument

public List<String> doSuggestArgument()
                               throws IOException,
                                      MalformedObjectNameException

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

MalformedObjectNameException

doSuggestOption

public List<String> doSuggestOption(String optionName)
                             throws IOException

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:

IOException - Network communication errors

execute

public void execute()
             throws IOException,
                    JMException

Description copied from class: Command

Execute command

Specified by:

execute in class Command

Throws:

IOException - IO errors

JMException - JMX errors

setBean

@Argument(displayName="bean",
          description="MBean name with or without domain")
public final void setBean(String bean)

Set bean option

Parameters:

bean - Bean to set

setDomain

@Option(name="d",
        longName="domain",
        description="Domain name")
public final void setDomain(String domain)

Set domain option

Parameters:

domain - Domain option to set