timmy.toolbox.cmdline

Class JConnect

java.lang.Object

timmy.toolbox.cmdline.JConnect

All Implemented Interfaces:

EventListener, NotificationListener

public class JConnect
extends Object
implements NotificationListener

JConnect: A very simple Command Line JMX Client using jline3 for the command line autocompletion. *

Author:

Anthony THOMAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JConnect.ConsoleCompletor The jline3 Completer implementation for JConnect. This does the completion of the commands when users press tab.

Constructor Summary

Constructors

Constructor and Description
JConnect(String[] args) JConnect's constructor load the properties file. This may exit the program if the configuration cannot be loaded.

Method Summary

Modifier and Type	Method and Description
Object	convert(String value, String type)
String	displaySignature(MBeanOperationInfo operation) Get the signature of a JMX exposed method to display it into console.
int	execute(String[] args) The entry point of JConnect. It opens the JMX connection and then execute the command given by args or start the interactive command line interface.
MBeanInfo	getBean(String name) Get MBeanInfo of a bean.
Map<String,ObjectName>	getBeans() Get all the available beans.
static String	getEnv(String name)
static String	getEnv(String name, String def)
void	handleNotification(Notification notification, Object handback)
static void	main(String[] args)
static org.apache.commons.lang3.tuple.Pair<String[],String[]>	splitOptionsAndCommand(String[] args)
void	stop() stop JConnect with the status code 0
void	stop(int code) stop JConnect with the specified exit code

Methods inherited from class java.lang.Object

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

Constructor Detail

JConnect

public JConnect(String[] args)

JConnect's constructor load the properties file.
This may exit the program if the configuration cannot be loaded.

Parameters:

args - the options passed in the command line arguments

Method Detail

handleNotification

public void handleNotification(Notification notification,
                               Object handback)

Specified by:

handleNotification in interface NotificationListener

getBeans

public Map<String,ObjectName> getBeans()
                                throws MalformedObjectNameException,
                                       IOException

Get all the available beans.

Returns:

a Map(Name, ObjectName) of the all the available beans. Never null but may be empty.

Throws:

MalformedObjectNameException - in case of a JMX issue

IOException - in case of a JMX issue

getBean

public MBeanInfo getBean(String name)
                  throws InstanceNotFoundException,
                         IntrospectionException,
                         ReflectionException,
                         IOException,
                         MalformedObjectNameException

Get MBeanInfo of a bean.

Parameters:

name - the name of the been we are looking for

Returns:

null if the bean is not found.

Throws:

InstanceNotFoundException - in case of a JMX issue

IntrospectionException - in case of a JMX issue

ReflectionException - in case of a JMX issue

IOException - in case of a JMX issue

MalformedObjectNameException - in case of a JMX issue

displaySignature

public String displaySignature(MBeanOperationInfo operation)

Get the signature of a JMX exposed method to display it into console.

Parameters:

operation - the method to display

Returns:

the string representation of the method

convert

public Object convert(String value,
                      String type)

stop

public void stop()

stop JConnect with the status code 0

stop

public void stop(int code)

stop JConnect with the specified exit code

Parameters:

code - the exit code

execute

public int execute(String[] args)

The entry point of JConnect.
It opens the JMX connection and then execute the command given by args or start the interactive command line interface.

Parameters:

args - the arguments of an inline command to be executed. may be empty.

Returns:

the exit code of JConnect if not stopped by the method stop(int code)

getEnv

public static String getEnv(String name,
                            String def)

getEnv

public static String getEnv(String name)

splitOptionsAndCommand

public static org.apache.commons.lang3.tuple.Pair<String[],String[]> splitOptionsAndCommand(String[] args)

main

public static void main(String[] args)