org.cyclopsgroup.jmxterm

Class Session

java.lang.Object

org.cyclopsgroup.jmxterm.Session

All Implemented Interfaces:

VerboseCommandOutputConfig

public abstract class Session
extends Object
implements VerboseCommandOutputConfig

JMX communication context. This class exists for the whole lifecycle of a command execution. It is NOT thread safe. The caller(CommandCenter) makes sure all calls are synchronized.

Author:

Jiaqi Guo

Field Summary

Fields

Modifier and Type	Field and Description
CommandOutput	output Public output field.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Session(CommandOutput output, CommandInput input, JavaProcessManager processManager)

Method Summary

Modifier and Type	Method and Description
void	close() Close JMX terminal console.
abstract void	connect(JMXServiceURL url, Map<String,Object> env) Connect to MBean server
abstract void	disconnect() Close JMX connector
String	getBean()
abstract Connection	getConnection()
String	getDomain()
CommandInput	getInput()
JavaProcessManager	getProcessManager()
VerboseLevel	getVerboseLevel()
boolean	isClosed()
abstract boolean	isConnected()
void	setBean(String bean) Set current selected bean
void	setDomain(String domain) Set current selected domain
void	setVerboseLevel(VerboseLevel verboseLevel)
void	unsetDomain() Set domain and bean to be NULL

Methods inherited from class java.lang.Object

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

Field Detail

output

public final CommandOutput output

Public output field. TODO Reevaluate if this field should be public or exposed by a getter method

Constructor Detail

Session

protected Session(CommandOutput output,
                  CommandInput input,
                  JavaProcessManager processManager)

Parameters:

output - Output destination

input - Command line input

processManager - Process manager

Method Detail

close

public void close()

Close JMX terminal console. Supposedly, process terminates after this call

connect

public abstract void connect(JMXServiceURL url,
                             Map<String,Object> env)
                      throws IOException

Connect to MBean server

Parameters:

url - URL to connect

env - Environment variables

Throws:

IOException - allows IO exceptions.

disconnect

public abstract void disconnect()
                         throws IOException

Close JMX connector

Throws:

IOException - Thrown when connection can't be closed

getBean

public final String getBean()

Returns:

Current selected bean

getConnection

public abstract Connection getConnection()

Returns:

Current open JMX server connection

getDomain

public final String getDomain()

Returns:

Current domain

getInput

public final CommandInput getInput()

Returns:

General input of command lines, which could be interactive environment, a file or piped input

getProcessManager

public JavaProcessManager getProcessManager()

Returns:

Java process manager to load processes

getVerboseLevel

public final VerboseLevel getVerboseLevel()

Specified by:

getVerboseLevel in interface VerboseCommandOutputConfig

Returns:

Dynamic value of verbose level

isClosed

public final boolean isClosed()

Returns:

True if close() has been called

isConnected

public abstract boolean isConnected()

Returns:

True if there's a open connection to JMX server

setBean

public final void setBean(String bean)

Set current selected bean

Parameters:

bean - Bean to select

setDomain

public final void setDomain(String domain)

Set current selected domain

Parameters:

domain - Domain to select

setVerboseLevel

public final void setVerboseLevel(VerboseLevel verboseLevel)

Parameters:

verboseLevel - Level of verbose

unsetDomain

public void unsetDomain()

Set domain and bean to be NULL