org.cyclopsgroup.jmxterm.cmd

Class BeansCommand

java.lang.Object

org.cyclopsgroup.jmxterm.Command

org.cyclopsgroup.jmxterm.cmd.BeansCommand

All Implemented Interfaces:

org.cyclopsgroup.jcli.AutoCompletable

@Cli(name="beans",
     description="List available beans under a domain or all domains",
     note="Without -d option, current select domain is applied. If there\'s no domain specified, all beans are listed. Example:\n beans\n beans -d java.lang")
public class BeansCommand
extends Command

Command that shows list of beans

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
BeansCommand()

Method Summary

Modifier and Type	Method and Description
List<String>	doSuggestOption(String optionName) Provide a list of possible option values for auto completion
void	execute() Execute command
static List<String>	getBeans(Session session, String domainName) Get list of bean names under current domain
void	setDomain(String domain)

Methods inherited from class org.cyclopsgroup.jmxterm.Command

doSuggestArgument, 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

BeansCommand

public BeansCommand()

Method Detail

getBeans

public static List<String> getBeans(Session session,
                                    String domainName)
                             throws MalformedObjectNameException,
                                    IOException

Get list of bean names under current domain

Parameters:

session - Current JMX session

domainName - Full domain name

Returns:

List of bean names

Throws:

MalformedObjectNameException - Input domain name is malformed

IOException - Communication error

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 MalformedObjectNameException,
                    IOException

Description copied from class: Command

Execute command

Specified by:

execute in class Command

Throws:

IOException - IO errors

MalformedObjectNameException

setDomain

@Option(name="d",
        longName="domain",
        displayName="domain",
        description="Name of domain under which beans are listed")
public final void setDomain(String domain)

Parameters:

domain - Domain under which beans are listed