Class ClientGui

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.apache.logging.log4j.jmx.gui.ClientGui

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, NotificationListener

public class ClientGui
extends JPanel
implements NotificationListener

Swing GUI that connects to a Java process via JMX and allows the user to view and modify the Log4j 2 configuration, as well as monitor status logs.

See Also:

• http://docs.oracle.com/javase/6/docs/technotes/guides/management/ jconsole.html
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private final Client	client
private final Map<ObjectName, Component>	contextObjNameToTabbedPaneMap
private static final int	INITIAL_STRING_WRITER_SIZE
private static final long	serialVersionUID
private final Map<ObjectName, JTextArea>	statusLogTextAreaMap
private JTabbedPane	tabbedPaneContexts

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
ClientGui(Client client)

Method Summary

Modifier and Type	Method	Description
private void	addWidgetForLoggerContext(LoggerContextAdminMBean ctx)
private JTextArea	createTextArea()
private void	createWidgets()
private void	handle(String msg, Exception ex)
void	handleNotification(Notification notif, Object paramObject)
private void	handleNotificationInAwtEventThread(Notification notif, Object paramObject)
private static void	installLookAndFeel()
static void	main(String[] args)	Connects to the specified location and shows this panel in a window.
private void	onMBeanRegistered(ObjectName mbeanName)	Called every time a Log4J2 MBean was registered in the MBean server.
private void	onMBeanUnregistered(ObjectName mbeanName)	Called every time a Log4J2 MBean was unregistered from the MBean server.
private void	populateWidgets()
private void	registerListeners(StatusLoggerAdminMBean status)
private void	removeWidgetForLoggerContext(ObjectName loggerContextObjName)
private JScrollPane	scroll(JTextArea text)
private static void	usage()

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

INITIAL_STRING_WRITER_SIZE

private static final int INITIAL_STRING_WRITER_SIZE

See Also:

• Constant Field Values

client

private final Client client

contextObjNameToTabbedPaneMap

private final Map<ObjectName, Component> contextObjNameToTabbedPaneMap

statusLogTextAreaMap

private final Map<ObjectName, JTextArea> statusLogTextAreaMap

tabbedPaneContexts

private JTabbedPane tabbedPaneContexts

Constructor Details

ClientGui

public ClientGui(Client client)
          throws IOException,
JMException

Throws:

IOException

JMException

Method Details

createWidgets

private void createWidgets()

populateWidgets

private void populateWidgets()
                      throws IOException,
JMException

Throws:

IOException

JMException

addWidgetForLoggerContext

private void addWidgetForLoggerContext(LoggerContextAdminMBean ctx)
                                throws MalformedObjectNameException,
IOException,
InstanceNotFoundException

Throws:

MalformedObjectNameException

IOException

InstanceNotFoundException

removeWidgetForLoggerContext

private void removeWidgetForLoggerContext(ObjectName loggerContextObjName)
                                   throws JMException,
IOException

Throws:

JMException

IOException

createTextArea

private JTextArea createTextArea()

scroll

private JScrollPane scroll(JTextArea text)

registerListeners

private void registerListeners(StatusLoggerAdminMBean status)
                        throws InstanceNotFoundException,
MalformedObjectNameException,
IOException

Throws:

InstanceNotFoundException

MalformedObjectNameException

IOException

handleNotification

public void handleNotification(Notification notif,
 Object paramObject)

Specified by:

handleNotification in interface NotificationListener

handleNotificationInAwtEventThread

private void handleNotificationInAwtEventThread(Notification notif,
 Object paramObject)

onMBeanRegistered

private void onMBeanRegistered(ObjectName mbeanName)

Called every time a Log4J2 MBean was registered in the MBean server.

Parameters:

mbeanName - ObjectName of the registered Log4J2 MBean

onMBeanUnregistered

private void onMBeanUnregistered(ObjectName mbeanName)

Called every time a Log4J2 MBean was unregistered from the MBean server.

Parameters:

mbeanName - ObjectName of the unregistered Log4J2 MBean

handle

private void handle(String msg,
 Exception ex)

main

public static void main(String[] args)
                 throws Exception

Connects to the specified location and shows this panel in a window.

Useful links: http://www.componative.com/content/controller/developer/insights /jconsole3/

Parameters:

args - must have at least one parameter, which specifies the location to connect to. Must be of the form host:port or service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi or service:jmx:rmi://<host>:<port>/jndi/rmi://<host>:<port>/jmxrmi

Throws:

Exception - if anything goes wrong

usage

private static void usage()

installLookAndFeel

private static void installLookAndFeel()