org.cyclopsgroup.jmxterm.cmd

Class WatchCommand

java.lang.Object

org.cyclopsgroup.jmxterm.Command

org.cyclopsgroup.jmxterm.cmd.WatchCommand

All Implemented Interfaces:

org.cyclopsgroup.jcli.AutoCompletable

@Cli(name="watch",
     description="Watch the value of one MBean attribute constantly",
     note="DO NOT call this command in a script and expect decent output")
public class WatchCommand
extends Command

Command to watch an MBean attribute TODO Consider the use case for CSV file backend generation

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
WatchCommand()

Method Summary

Modifier and Type	Method and Description
List<String>	doSuggestArgument() Provide a list of possible arguments for auto completion.
void	execute() Execute command
void	setAttributes(List<String> attributes)
void	setOutputFormat(String outputFormat)
void	setRefreshInterval(int refreshInterval)
void	setReport(boolean report)
void	setStopAfter(int stopAfter)

Methods inherited from class org.cyclopsgroup.jmxterm.Command

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

WatchCommand

public WatchCommand()

Method Detail

doSuggestArgument

public 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

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

setAttributes

@MultiValue(listType=java.util.ArrayList.class,
            minValues=1)
 @Argument(displayName="attr",
          description="Name of attributes to watch")
public final void setAttributes(List<String> attributes)

Parameters:

attributes - Name of attributes to watch

setOutputFormat

@Option(name="f",
        longName="format",
        displayName="expr",
        description="Java pattern(java.text.MessageFormat) to print attribute values")
public final void setOutputFormat(String outputFormat)

Parameters:

outputFormat - Pattern used in MessageFormat

setRefreshInterval

@Option(name="i",
        longName="interval",
        displayName="sec",
        description="Optional number of seconds between consecutive poll, default is 1 second",
        defaultValue="1")
public final void setRefreshInterval(int refreshInterval)

Parameters:

refreshInterval - Refreshing interval in seconds

setReport

@Option(name="r",
        longName="report",
        description="Output result line by line as report")
public final void setReport(boolean report)

Parameters:

report - True to output result line by line as report

setStopAfter

@Option(name="s",
        longName="stopafter",
        displayName="sec",
        description="Stop after watching a number of seconds")
public final void setStopAfter(int stopAfter)

Parameters:

stopAfter - After this number of seconds, stop watching