Websphere MQ Everyplace

examples.administration.console
Class AdminCommsListener

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--examples.awt.AwtFrame
                                |
                                +--examples.administration.console.AdminFrame
                                      |
                                      +--examples.administration.console.AdminCommsListener
All Implemented Interfaces:
javax.accessibility.Accessible, AwtEvent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class AdminCommsListener
extends AdminFrame

Specialisation of AdminFrame allowing for administration of a communications listeners.

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
static short[] version
           
 
Fields inherited from class examples.administration.console.AdminFrame
action, actionB, actionFields, adminModel, applyB, cancelB, displayedFields, displayFields, displayFieldsGroups, displayFieldsSeq, fieldCount, msg, nLSFields, origMsg
 
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
AdminCommsListener()
          Default constructor.
AdminCommsListener(MQeAdminMsg msg, int action, AdminModel adminModel)
          Main constructor.
AdminCommsListener(java.lang.String title)
          AdminQueueManager constructor.
 
Method Summary
 void addAlias()
          Add any aliases related to this resource.
 java.awt.Panel getActionsPanel(AwtEvent eventHandler)
          Returns an actions panel.
 MQeFields getCharacteristics()
          Get the set of characteristics for the managed object.
 java.lang.String getMessageHelp()
          Returns a string that provides information about the current frame.
 java.lang.String getResourceTitle()
          Return the name of resource being managed.
 void resourceAction(java.lang.Object e, int where, int index, java.lang.String choice, boolean state)
          Process a comms listener action request.
 MQeAdminMsg setupAction(MQeFields parms)
          Setup the admin message with the action to be performed and the parameters required by the action.
protected  void setupActions()
          Configure the set of actions.
protected  void setupFields()
          Setup the valid set of characteristics.
protected  void setupNLS()
          Setup NLS names.
 
Methods inherited from class examples.administration.console.AdminFrame
action, activate, addAction, addActionToDisplay, addCharacteristic, addDisplayedField, addFieldToDisplay, addNLSName, close, closeFrame, display, getChanges, getErrorFromFields, getField, getFieldDisplayType, getFieldsForAction, getNLSName, getSubFields, getValueFromFields, isFieldChanged, message, renderCharacteristic, renderError, renderLabel, setAdminModel, setField, validateInput
 
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
Constructor Detail

AdminCommsListener

public AdminCommsListener()
Default constructor.


AdminCommsListener

public AdminCommsListener(MQeAdminMsg msg,
                          int action,
                          AdminModel adminModel)
                   throws java.lang.Exception
Main constructor.

Parameters:
msg - An administration message to contain the parameters for the action. If it already contains any parameters then these are taken as defaults.
action - The action to be performed
adminModel - The administration model which will send the message.
Throws:
java.lang.Exception

AdminCommsListener

public AdminCommsListener(java.lang.String title)
                   throws java.lang.Exception
AdminQueueManager constructor.

Parameters:
title - java.lang.String
Throws:
java.lang.Exception
Method Detail

addAlias

public void addAlias()
              throws java.lang.Exception
Add any aliases related to this resource.

Overrides:
addAlias in class AdminFrame
Returns:
void
Throws:
java.lang.Exception

getActionsPanel

public java.awt.Panel getActionsPanel(AwtEvent eventHandler)
Returns an actions panel.

Overrides:
getActionsPanel in class AdminFrame
Parameters:
eventHandler - An AwtEvent
Returns:
A Panel

getCharacteristics

public MQeFields getCharacteristics()
                             throws java.lang.Exception
Get the set of characteristics for the managed object.

Overrides:
getCharacteristics in class AdminFrame
Returns:
MQeFields Object
Throws:
java.lang.Exception

getResourceTitle

public java.lang.String getResourceTitle()
Return the name of resource being managed.

Overrides:
getResourceTitle in class AdminFrame
Returns:
java.lang.String

resourceAction

public void resourceAction(java.lang.Object e,
                           int where,
                           int index,
                           java.lang.String choice,
                           boolean state)
                    throws java.lang.Exception
Process a comms listener action request.

Overrides:
resourceAction in class AdminFrame
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
Throws:
java.lang.Exception

setupAction

public MQeAdminMsg setupAction(MQeFields parms)
                        throws java.lang.Exception
Setup the admin message with the action to be performed and the parameters required by the action.

Overrides:
setupAction in class AdminFrame
Parameters:
parms - MQeFields Object
Returns:
MQeAdminMsg Object
Throws:
java.lang.Exception

setupActions

protected void setupActions()
Configure the set of actions.

Overrides:
setupActions in class AdminFrame
Returns:
void

setupFields

protected void setupFields()
Setup the valid set of characteristics. The sequence is important as this is the sequence that the fields will displayed.

Overrides:
setupFields in class AdminFrame
Returns:
void

setupNLS

protected void setupNLS()
Setup NLS names.

Overrides:
setupNLS in class AdminFrame
Returns:
void

getMessageHelp

public java.lang.String getMessageHelp()
Returns a string that provides information about the current frame. This is displayed in the south panel of the main admin gui when a frame is selected.

Overrides:
getMessageHelp in class AdminFrame
Returns:
String documenting the current frame.

Websphere MQ Everyplace