org.cyclopsgroup.jmxterm.boot

Class CliMainOptions

java.lang.Object

org.cyclopsgroup.jmxterm.boot.CliMainOptions

@Cli(name="jmxterm",
     description="Main executable of JMX terminal CLI tool",
     note="Without any option, this command opens an interactive command line based console. With a given input file, commands in file will be executed and process ends after file is processed")
public class CliMainOptions
extends Object

Options for main class

Author:

Jiaqi Guo

Field Summary

Fields

Modifier and Type	Field and Description
static String	STDERR Constant stderr that identifies standard error output
static String	STDIN Constant stdin that identifies standard input
static String	STDOUT Constant stdout that identifies standard output

Constructor Summary

Constructors

Constructor and Description
CliMainOptions()

Method Summary

Modifier and Type	Method and Description
String	getInput()
String	getOutput()
String	getPassword()
String	getUrl()
String	getUser()
String	getVerboseLevel()
boolean	isAppendToOutput()
boolean	isExitOnFailure()
boolean	isHelp()
boolean	isNonInteractive()
boolean	isSecureRmiRegistry()
void	setAppendToOutput(boolean appendToOutput)
void	setExitOnFailure(boolean exitOnFailure)
void	setHelp(boolean help)
void	setInput(String file)
void	setNonInteractive(boolean nonInteractive)
void	setOutput(String outputFile)
void	setPassword(String password)
void	setSecureRmiRegistry(boolean isSecureRmiRegistry)
void	setUrl(String url)
void	setUser(String user)
void	setVerboseLevel(String verboseLevel)

Methods inherited from class java.lang.Object

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

Field Detail

STDERR

public static final String STDERR

Constant stderr that identifies standard error output

See Also:

Constant Field Values

STDIN

public static final String STDIN

Constant stdin that identifies standard input

See Also:

Constant Field Values

STDOUT

public static final String STDOUT

Constant stdout that identifies standard output

See Also:

Constant Field Values

Constructor Detail

CliMainOptions

public CliMainOptions()

Method Detail

getInput

public final String getInput()

Returns:

#setInput(String)

getOutput

public final String getOutput()

Returns:

#setOutput(String)

getPassword

public final String getPassword()

Returns:

Password for user/password authentication

getUrl

public final String getUrl()

Returns:

#setUrl(String)

getUser

public final String getUser()

Returns:

User name for user/password authentication

getVerboseLevel

public final String getVerboseLevel()

Returns:

Verbose option

isExitOnFailure

public final boolean isExitOnFailure()

Returns:

True if terminal exits on any failure

isAppendToOutput

public final boolean isAppendToOutput()

Returns:

True if terminal exits on any failure

isHelp

public final boolean isHelp()

Returns:

setHelp(boolean)

isNonInteractive

public final boolean isNonInteractive()

Returns:

True if CLI runs without user interaction, such as piped input

isSecureRmiRegistry

public final boolean isSecureRmiRegistry()

Returns:

True if the server's RMI registry is protected with SSL/TLS (com.sun.management.jmxremote.registry.ssl=true)

setExitOnFailure

@Option(name="e",
        longName="exitonfailure",
        description="With this flag, terminal exits for any Exception")
public final void setExitOnFailure(boolean exitOnFailure)

Parameters:

exitOnFailure - True if terminal exits on any failure

setHelp

@Option(name="h",
        longName="help",
        description="Show usage of this command line")
public final void setHelp(boolean help)

Parameters:

help - True to turn on help flag

setInput

@Option(name="i",
        longName="input",
        description="Input script file. There can only be one input file. \"stdin\" is the default value which means console input")
public final void setInput(String file)

Parameters:

file - Input script path or stdin as default value for console input

setNonInteractive

@Option(name="n",
        longName="noninteract",
        description="Non interactive mode. Use this mode if input doesn\'t come from human or jmxterm is embedded")
public final void setNonInteractive(boolean nonInteractive)

Parameters:

nonInteractive - True if CLI runs without user interaction, such as piped input

setOutput

@Option(name="o",
        longName="output",
        description="Output file, stdout or stderr. Default value is stdout")
public final void setOutput(String outputFile)

Parameters:

outputFile - It can be a file or STDERR or STDERR

setPassword

@Option(name="p",
        longName="password",
        description="Password for user/password authentication")
public final void setPassword(String password)

Parameters:

password - Password for user/password authentication

setUrl

@Option(name="l",
        longName="url",
        description="Location of MBean service. It can be <host>:<port> or full service URL.")
public final void setUrl(String url)

Parameters:

url - MBean server URL

setUser

@Option(name="u",
        longName="user",
        description="User name for user/password authentication")
public final void setUser(String user)

Parameters:

user - User name for user/password authentication

setVerboseLevel

@Option(name="v",
        longName="verbose",
        description="Verbose level, could be silent|brief|verbose. Default value is brief")
public final void setVerboseLevel(String verboseLevel)

Parameters:

verboseLevel - Verbose level

setAppendToOutput

@Option(name="a",
        longName="appendtooutput",
        description="With this flag, the outputfile is preserved and content is appended to it")
public final void setAppendToOutput(boolean appendToOutput)

Parameters:

appendToOutput - True if outputfile is preserved

setSecureRmiRegistry

@Option(name="s",
        longName="sslrmiregistry",
        description="Whether the server\'s RMI registry is protected with SSL/TLS")
public final void setSecureRmiRegistry(boolean isSecureRmiRegistry)

Parameters:

isSecureRmiRegistry - Whether the server's RMI registry is protected with SSL/TLS (com.sun.management.jmxremote.registry.ssl=true)