Websphere MQ Everyplace

examples.administration.console
Class AdminQueueBrowser

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--examples.awt.AwtFrame
                                |
                                +--examples.administration.console.AdminQueueBrowser
All Implemented Interfaces:
javax.accessibility.Accessible, AwtEvent, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, MQeMessageListenerInterface, java.beans.PropertyChangeListener, java.io.Serializable
Direct Known Subclasses:
AdminLogBrowser

public class AdminQueueBrowser
extends AwtFrame
implements MQeMessageListenerInterface, java.beans.PropertyChangeListener

To provide a simple queue browser. Provides several views of the queue, including a list of messages plus a dump of the message contents.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  java.awt.Panel actionPan
           
protected  boolean active
           
protected  AdminModel adminModel
           
protected  int dispMode
           
protected  java.awt.Choice dispModeChoice
           
protected static java.lang.String[] dMode
          Variables used to handle different display modes.
protected  java.util.Vector fieldMsgs
           
protected  java.lang.String filter
           
protected  java.awt.Choice filterChoice
           
protected  MQeFields filterField
           
protected  java.awt.TextField filterTF
           
protected static java.lang.String[] filterValues
          Variables used in filtering messages.
protected  java.awt.TextField messageTF
           
protected  java.awt.TextArea msgArea
           
protected  java.awt.Label msgCountTF
           
protected  java.awt.List msgList
          GUI widgets
protected  java.awt.Panel msgPan
           
protected  java.lang.String qMgrName
          Other Variables used to hold user input.
protected  java.awt.TextField qMgrTF
           
protected  java.lang.String qName
           
protected  java.awt.TextField qTF
           
protected  java.awt.BorderLayout southLOM
           
protected  java.awt.Panel southPan
           
static short[] version
           
 
Fields inherited from class examples.awt.AwtFrame
borderLayout1, BorderWhere, Center, East, format, Menu, North, panel, South, West
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AdminQueueBrowser()
          AdminLogModel default constructor.
AdminQueueBrowser(AdminModel admin, java.lang.String qMgr, java.lang.String q)
          AdminLogModel constructor.
AdminQueueBrowser(java.lang.String title)
          AdminLogModel constructor.
 
Method Summary
 void action(java.lang.Object e, int where, int index, java.lang.String choice, boolean state)
          Process an MQe awt event.
 void activate(AdminModel admin)
          Initialisation code.
 void addMessage(MQeFields msg)
          Add a new message to list of messages.
 void browse(MQeFields match)
          The browse operations gets admin messages from a queue that match a filter.
 void clearMsgs()
          Clear messages from display buffers.
 void close()
          Close the window.
protected  void closeFrame()
          Handel window closing event.
 void displayMessage(MQeFields msg)
          Open a window to display contents of the message.
 void emptyQueue()
          Delete all messages from the queue being browsed.
 int getDisplayMode()
          Returns the display mode.
 void getInput()
          Get user input from GUI widgets.
 int getMsgsDisplayed()
          Returns the number of messages that are in the display buffer.
 MQeQueueManager getQM()
          Get a reference to the queue manager.
 java.lang.String getQMgrName()
          Gets the queue manager name.
 java.lang.String getQueueName()
          Gets the queue name.
 void message(java.lang.String msg)
          Display a message.
 void messageArrived(MQeMessageEvent e)
          Process a message arrived event.
 java.lang.String parseMessage(MQeFields msg)
          Parse the message ready for display.
 java.lang.String parseMessageForArea(MQeFields msg)
          Parse a message for display in an area that can handle multiple lines of text.
 java.lang.String parseMessageForList(MQeFields pmsg)
          Parse a message for display in a single line.
 void propertyChange(java.beans.PropertyChangeEvent evt)
          Method to handle events for the PropertyChangeListener interface.
 void refresh()
          Refreshes the display and then browses the queue.
 void setDisplayMode(int index)
          Set the display mode to index value.
 void setFilter(java.lang.String filter, int index)
          Setup the filter fields object.
 void setQMgrName(java.lang.String qMgrName)
          Set the name of the queue manager which owns the queue to be browsed.
 void setQueueName(java.lang.String qMgrName)
          Set the name of the queue to be browsed.
 void startMonitor()
          Start the queue monitor.
 void stopMonitor()
          Stop the queue monitor.
 
Methods inherited from class examples.awt.AwtFrame
format, getActionIndex, getActionString, getCheckState, GetChoice, getObject, getPanel, getText, index, processWindowEvent, setPanel, setText, visible, visible
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

version

public static short[] version

active

protected boolean active

adminModel

protected AdminModel adminModel

fieldMsgs

protected java.util.Vector fieldMsgs

msgList

protected java.awt.List msgList
GUI widgets


msgArea

protected java.awt.TextArea msgArea

filterChoice

protected java.awt.Choice filterChoice

dispModeChoice

protected java.awt.Choice dispModeChoice

qMgrTF

protected java.awt.TextField qMgrTF

qTF

protected java.awt.TextField qTF

filterTF

protected java.awt.TextField filterTF

messageTF

protected java.awt.TextField messageTF

msgCountTF

protected java.awt.Label msgCountTF

southLOM

protected java.awt.BorderLayout southLOM

southPan

protected java.awt.Panel southPan

actionPan

protected java.awt.Panel actionPan

msgPan

protected java.awt.Panel msgPan

filterValues

protected static java.lang.String[] filterValues
Variables used in filtering messages. filterValues = Possible fields to filter on filterField = Filter fields object


filterField

protected MQeFields filterField

dMode

protected static java.lang.String[] dMode
Variables used to handle different display modes. dmode: Possible dislplay modes dispMode: Current display mode


dispMode

protected int dispMode

qMgrName

protected java.lang.String qMgrName
Other Variables used to hold user input.


qName

protected java.lang.String qName

filter

protected java.lang.String filter
Constructor Detail

AdminQueueBrowser

public AdminQueueBrowser()
AdminLogModel default constructor.


AdminQueueBrowser

public AdminQueueBrowser(AdminModel admin,
                         java.lang.String qMgr,
                         java.lang.String q)
AdminLogModel constructor.

Parameters:
admin - an AdminModel to provide base admin functionality
qMgr - Name of queue manager on which queue resides
q - Name of queue to browse

AdminQueueBrowser

public AdminQueueBrowser(java.lang.String title)
AdminLogModel constructor.

Parameters:
title - window title
Method Detail

action

public void action(java.lang.Object e,
                   int where,
                   int index,
                   java.lang.String choice,
                   boolean state)
Process an MQe awt event.

Specified by:
action in interface AwtEvent
Overrides:
action in class AwtFrame
Parameters:
e - java.lang.Object
where - An integer indicating the location.
index - An integer containing the type of resource to be managed.
choice - java.lang.String
state - A boolean
Returns:
void

activate

public void activate(AdminModel admin)
Initialisation code.

Parameters:
admin - AdminModel object
Returns:
void

addMessage

public void addMessage(MQeFields msg)
Add a new message to list of messages.

Parameters:
msg - Message to be added
Returns:
void

browse

public void browse(MQeFields match)
The browse operations gets admin messages from a queue that match a filter. Messages matching the filter are then displayed.

Parameters:
match - MQeFields object
Returns:
void

clearMsgs

public void clearMsgs()
Clear messages from display buffers.

Returns:
void

close

public void close()
Close the window.

Returns:
void

closeFrame

protected void closeFrame()
Handel window closing event.

Overrides:
closeFrame in class AwtFrame
Returns:
void

displayMessage

public void displayMessage(MQeFields msg)
                    throws java.lang.Exception
Open a window to display contents of the message.

Parameters:
msg - Message to be displayed
Returns:
void
Throws:
java.lang.Exception

emptyQueue

public void emptyQueue()
Delete all messages from the queue being browsed.

Returns:
void

getDisplayMode

public int getDisplayMode()
Returns the display mode.

Returns:
An integer with one of the following values.
  0: List
  1: Text area
  2: Both ( 2 panels, 1 with a list and 1 with text area )
 

getInput

public void getInput()
Get user input from GUI widgets.

Returns:
void

getMsgsDisplayed

public int getMsgsDisplayed()
Returns the number of messages that are in the display buffer.

Returns:
An integer value

getQM

public MQeQueueManager getQM()
Get a reference to the queue manager.

Returns:
MQeQueueManager object

getQMgrName

public java.lang.String getQMgrName()
Gets the queue manager name.

Returns:
java.lang.String

getQueueName

public java.lang.String getQueueName()
Gets the queue name.

Returns:
java.lang.String

message

public void message(java.lang.String msg)
Display a message.

Parameters:
msg - java.lang.String containing the message
Returns:
void

messageArrived

public void messageArrived(MQeMessageEvent e)
Process a message arrived event.

Specified by:
messageArrived in interface MQeMessageListenerInterface
Parameters:
e - MQeMessageEvent object
Returns:
void

parseMessage

public java.lang.String parseMessage(MQeFields msg)
Parse the message ready for display.

Parameters:
msg - Message object to be parsed
Returns:
Parsed message

parseMessageForArea

public java.lang.String parseMessageForArea(MQeFields msg)
Parse a message for display in an area that can handle multiple lines of text.

Parameters:
msg - Message object to be parsed.
Returns:
Parsed message

parseMessageForList

public java.lang.String parseMessageForList(MQeFields pmsg)
Parse a message for display in a single line.

Parameters:
pmsg - Message object to be parsed
Returns:
Parsed message

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)
Method to handle events for the PropertyChangeListener interface.

Specified by:
propertyChange in interface java.beans.PropertyChangeListener
Parameters:
evt - java.beans.PropertyChangeEvent
Returns:
void

refresh

public void refresh()
Refreshes the display and then browses the queue.

Returns:
void

setDisplayMode

public void setDisplayMode(int index)
Set the display mode to index value.

Parameters:
index - This integer can take one the following values:
   0  display messages in a list. A subset of message fields displayed.
   1  dispaly messages in a textarea. All fields in a message are displayed.
   2  display 2 panels:  a list of messages in one and a full display of the
                         selected message in the other.
 
Returns:
void

setFilter

public void setFilter(java.lang.String filter,
                      int index)
               throws java.lang.Exception
Setup the filter fields object.

Parameters:
filter - java.lang.String
index - An integer
Returns:
void
Throws:
java.lang.Exception

setQMgrName

public void setQMgrName(java.lang.String qMgrName)
Set the name of the queue manager which owns the queue to be browsed.

Parameters:
qMgrName - String holding the QMgr Name
Returns:
void

setQueueName

public void setQueueName(java.lang.String qMgrName)
Set the name of the queue to be browsed.

Parameters:
qMgrName - String holding the Q Name
Returns:
void

startMonitor

public void startMonitor()
Start the queue monitor.

Returns:
void

stopMonitor

public void stopMonitor()
Stop the queue monitor.

Returns:
void

Websphere MQ Everyplace