All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.network.snmp.ui.UserInterface

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.ibm.network.snmp.ui.UserInterface

public class UserInterface
extends Panel
implements Serializable, ActionListener, WindowListener, ResponseListener, StatusListener, TrapListener
A class which implements the User Interface taking in all the required parameters for sending SNMP Message and displaying the Results.


Constructor Index

 o UserInterface()
Constructor for User Interface

Method Index

 o actionPerformed(ActionEvent)
The ActionListener Interface method.
 o addAgent(String, String)
Add a agent to the List of Agents.
 o addMessageListener(MessageListener)
Add a Listener for Message Event.
 o addObjectIdentifier(String, String, String)
Add an Object Identifier to the list of Object Identifiers.
 o clearLog()
Clear the Response Log Area.
 o getAgentAddress()
Returns the IP Address of the Agent to which the Message is being sent.
 o getAgentsFile()
The file Name where Agent Names are stored.
 o getAllTypes()
All the Object Types supported.
 o getButtonsBackground()
The Background Color of Buttons in the User Interface
 o getButtonsFont()
The Font of Buttons in the User Interface
 o getButtonsForeground()
The Foreground Color of Buttons in the User Interface
 o getChoicesBackground()
The Background Color of Choices in the User Interface
 o getChoicesFont()
The Font of Choices in the User Interface
 o getChoicesForeground()
The Foreground Color of Choices in the User Interface
 o getCommunityName()
The Community Name in Message Object
 o getListsBackground()
The Background Color of Lists in the User Interface
 o getListsFont()
The Font of Lists in the User Interface
 o getListsForeground()
The Foreground Color of Lists in the User Interface
 o getLongValue()
Object Value in case its not a String.
 o getMessageObject()
The reference to the Message Object.
 o getObjectIdentifier()
The Object Identifier in the Message Object
 o getObjectsFile()
Returns the Objects File Name.
 o getObjectType()
Object Type in Byte.
 o getRequestID()
Returns Requested ID
 o getRequestType()
Returns Request Type as Byte.
 o getStringValue()
The Object Value returned as String
 o getTextFieldBackground()
The Background Color of Text Fields in the User Interface
 o getTextFieldFont()
The Font of Text Fields in the User Interface
 o getTextFieldForeground()
The Foreground Color of Text Fields in the User Interface
 o getUIBackground()
The Background Color of of the User Interface
 o getUIFont()
The Font of of the User Interface
 o getUIForeground()
The Foreground Color of of the User Interface
 o handleResponse(ResponseObject)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.
 o handleResponse(String, String, String, long, String)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.
 o handleStatus(String)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.
 o handleTrap(String, String, String, String, String, String, String)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.
 o handleTrap(TrapObject)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.
 o processResponseEvent(ResponseEvent)
This method takes in a Response Event and processes it
 o processStatusEvent(StatusEvent)
This method takes in a Status Event and processes it
 o processTrapEvent(TrapEvent)
This method takes in a Trap Event and processes it
 o removeAgent(String, String)
Removes an Agent from the Agents List
 o removeMessageListener(MessageListener)
Unregister the Message Event Listener.
 o removeObjectIdentifier(String)
Removes an Object Identifier from the ObjectIdentifier List
 o selectAgent(String, String)
Select Agent with this IP Address.
 o selectObject(String)
Select Object with this Object Identifer.
 o setAgentsFile(String)
Set file name to load Agent Names.
 o setButtonsBackground(Color)
Set Buttons Background Color to specified Value
 o setButtonsFont(Font)
Set Buttons Font to specified Value
 o setButtonsForeground(Color)
Set Buttons Foreground Color to specified Value
 o setChoicesBackground(Color)
Set Choices Background Color to specified Value
 o setChoicesFont(Font)
Set Choices Font to specified Value
 o setChoicesForeground(Color)
Set Choices Foreground Color to specified Value
 o setCommunityName(String)
Set Community Name to specified value.
 o setListsBackground(Color)
Set Lists Background Color to specified Value
 o setListsFont(Font)
Set Lists Font to specified Value
 o setListsForeground(Color)
Set Lists Foreground Color to specified Value
 o setLog(String)
Set the Text in Log Area to specified Text.
 o setObjectsFile(String)
Set file name to load Object Names.
 o setTextFieldBackground(Color)
Set TextField Background Color to specified Value
 o setTextFieldFont(Font)
Set TextField Font to specified Value
 o setTextFieldForeground(Color)
Set TextField Foreground Color to specified Value
 o setUIBackground(Color)
Set UserInterface Background Color to specified Value
 o setUIFont(Font)
Set UserInterface Font to specified Value
 o setUIForeground(Color)
Set UserInterface Foreground Color to specified Value
 o windowActivated(WindowEvent)
Method to handle events for the WindowListener interface.
 o windowClosed(WindowEvent)
Method to handle events for the WindowListener interface.
 o windowClosing(WindowEvent)
Method to handle events for the WindowListener interface.
 o windowDeactivated(WindowEvent)
Method to handle events for the WindowListener interface.
 o windowDeiconified(WindowEvent)
Method to handle events for the WindowListener interface.
 o windowIconified(WindowEvent)
Method to handle events for the WindowListener interface.
 o windowOpened(WindowEvent)
Method to handle events for the WindowListener interface.

Constructors

 o UserInterface
 public UserInterface()
Constructor for User Interface

Methods

 o actionPerformed
 public void actionPerformed(ActionEvent e)
The ActionListener Interface method.

Parameters:
e - java.awt.event.ActionEvent
 o addAgent
 public void addAgent(String agentIP,
                      String agentName) throws SNMPUIBeanException
Add a agent to the List of Agents.

Parameters:
agentIP - java.lang.String
agentName - java.lang.String
Throws: SNMPUIBeanException
if a wrong entry is given
 o addMessageListener
 public void addMessageListener(MessageListener rl)
Add a Listener for Message Event.

Parameters:
rl - com.ibm.network.snmp.ui.MessageListener
See Also:
MessageEvent
 o addObjectIdentifier
 public void addObjectIdentifier(String oid,
                                 String objectName,
                                 String objType) throws SNMPUIBeanException
Add an Object Identifier to the list of Object Identifiers.

Parameters:
oid - java.lang.String
objectName - java.lang.String
objType - java.lang.String
Throws: SNMPUIBeanException
in case an Invalid Object Identifier is given
 o clearLog
 public void clearLog()
Clear the Response Log Area.

 o getAgentAddress
 public String getAgentAddress()
Returns the IP Address of the Agent to which the Message is being sent.

Returns:
The Agent IP Address
 o getAgentsFile
 public String getAgentsFile()
The file Name where Agent Names are stored.

Returns:
AgentsFileName or " " in case of loading from Resource
 o getAllTypes
 public String[] getAllTypes()
All the Object Types supported.

Returns:
All Object Types
 o getButtonsBackground
 public Color getButtonsBackground()
The Background Color of Buttons in the User Interface

Returns:
Buttons Background
 o getButtonsFont
 public Font getButtonsFont()
The Font of Buttons in the User Interface

Returns:
Buttons Font
 o getButtonsForeground
 public Color getButtonsForeground()
The Foreground Color of Buttons in the User Interface

Returns:
Buttons Foreground
 o getChoicesBackground
 public Color getChoicesBackground()
The Background Color of Choices in the User Interface

Returns:
Choices Background
 o getChoicesFont
 public Font getChoicesFont()
The Font of Choices in the User Interface

Returns:
Choices Font
 o getChoicesForeground
 public Color getChoicesForeground()
The Foreground Color of Choices in the User Interface

Returns:
Choices Foreground
 o getCommunityName
 public String getCommunityName()
The Community Name in Message Object

Returns:
The Community Name
 o getListsBackground
 public Color getListsBackground()
The Background Color of Lists in the User Interface

Returns:
Lists Background
 o getListsFont
 public Font getListsFont()
The Font of Lists in the User Interface

Returns:
Lists Font
 o getListsForeground
 public Color getListsForeground()
The Foreground Color of Lists in the User Interface

Returns:
Lists Foreground
 o getLongValue
 public long getLongValue()
Object Value in case its not a String.

Returns:
Value as long
 o getMessageObject
 public MessageObject getMessageObject()
The reference to the Message Object.

Returns:
MessageObject
 o getObjectIdentifier
 public String getObjectIdentifier()
The Object Identifier in the Message Object

Returns:
Object Identifier
 o getObjectsFile
 public String getObjectsFile()
Returns the Objects File Name.

Returns:
ObjectsFileName or " " in case of loading from Resource
 o getObjectType
 public byte getObjectType()
Object Type in Byte.

Returns:
Object Type in Byte
 o getRequestID
 public byte getRequestID()
Returns Requested ID

Returns:
Request ID
 o getRequestType
 public byte getRequestType()
Returns Request Type as Byte.

Returns:
Request Type as Byte
 o getStringValue
 public String getStringValue()
The Object Value returned as String

Returns:
String Value
 o getTextFieldBackground
 public Color getTextFieldBackground()
The Background Color of Text Fields in the User Interface

Returns:
Text Field Background
 o getTextFieldFont
 public Font getTextFieldFont()
The Font of Text Fields in the User Interface

Returns:
Text Field Font
 o getTextFieldForeground
 public Color getTextFieldForeground()
The Foreground Color of Text Fields in the User Interface

Returns:
Text Field Foreground
 o getUIBackground
 public Color getUIBackground()
The Background Color of of the User Interface

Returns:
UserInterfaceBackground
 o getUIFont
 public Font getUIFont()
The Font of of the User Interface

Returns:
UserInterfaceFont
 o getUIForeground
 public Color getUIForeground()
The Foreground Color of of the User Interface

Returns:
UserInterfaceForeground
 o handleResponse
 public void handleResponse(ResponseObject responseObject)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.

Parameters:
responseObject - com.ibm.network.snmp.protocol.ResponseObject
 o handleResponse
 public void handleResponse(String objectIdentifier,
                            String objectValue,
                            String agentAdd,
                            long reqID,
                            String communityName)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.

Parameters:
objectIdentifer - java.lang.String
objectValue - java.lang.String
agentAdd - java.lang.String
reqID - long
communityName - java.lang.String
 o handleStatus
 public void handleStatus(String status)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.

Parameters:
status - java.lang.String The Status Message
 o handleTrap
 public void handleTrap(TrapObject trapObject)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.

Parameters:
trapObject - com.ibm.network.snmp.protocol.TrapObject
 o handleTrap
 public void handleTrap(String enterpriseOID,
                        String sendingAgent,
                        String genericTrap,
                        String specificTrap,
                        String timeStamp,
                        String infoOID,
                        String infoValue)
This method is used for Visual Linking of UserInterfaceBean to ProtocolBean.

Parameters:
enterpriseOID - java.lang.String
sendingAgent - java.lang.String
genericTrap - java.lang.String
specificTrap - java.lang.String
timeStamp - java.lang.String
infoOID - java.lang.String
infoValue - java.lang.String
 o processResponseEvent
 public void processResponseEvent(ResponseEvent evt)
This method takes in a Response Event and processes it

Parameters:
e - com.ibm.network.snmp.protocol.ResponseEvent
 o processStatusEvent
 public void processStatusEvent(StatusEvent evt)
This method takes in a Status Event and processes it

Parameters:
evt - com.ibm.network.snmp.protocol.StatusEvent
 o processTrapEvent
 public void processTrapEvent(TrapEvent evt)
This method takes in a Trap Event and processes it

Parameters:
evt - com.ibm.network.snmp.protocol.TrapEvent
 o removeAgent
 public void removeAgent(String agentIP,
                         String name) throws SNMPUIBeanException
Removes an Agent from the Agents List

Parameters:
agentIP - java.lang.String
name - java.lang.String
Throws: SNMPUIBeanException
In case no such Agent exists
 o removeMessageListener
 public void removeMessageListener(MessageListener rl)
Unregister the Message Event Listener.

Parameters:
rl - com.ibm.network.snmp.ui.MessageListener
 o removeObjectIdentifier
 public void removeObjectIdentifier(String oid) throws SNMPUIBeanException
Removes an Object Identifier from the ObjectIdentifier List

Throws: SNMPUIBeanException
if no such OID exists
 o selectAgent
 public void selectAgent(String agentIP,
                         String name) throws SNMPUIBeanException
Select Agent with this IP Address.

Parameters:
agentIP - java.lang.String
name - java.lang.String
Throws: SNMPUIBeanException
if no such Agent exists
 o selectObject
 public void selectObject(String objectIdentifier) throws SNMPUIBeanException
Select Object with this Object Identifer.

Parameters:
objectIdentifier - java.lang.String
Throws: SNMPUIBeanException
if no such Object exists
 o setAgentsFile
 public void setAgentsFile(String file) throws SNMPUIBeanException
Set file name to load Agent Names.

Parameters:
file - java.lang.String
Throws: SNMPUIBeanException
in case an Invalid File name is given
 o setButtonsBackground
 public void setButtonsBackground(Color c)
Set Buttons Background Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setButtonsFont
 public void setButtonsFont(Font f)
Set Buttons Font to specified Value

Parameters:
f - java.awt.Font
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setButtonsForeground
 public void setButtonsForeground(Color c)
Set Buttons Foreground Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setChoicesBackground
 public void setChoicesBackground(Color c)
Set Choices Background Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setChoicesFont
 public void setChoicesFont(Font f)
Set Choices Font to specified Value

Parameters:
f - java.awt.Font
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setChoicesForeground
 public void setChoicesForeground(Color c)
Set Choices Foreground Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setCommunityName
 public void setCommunityName(String communityName)
Set Community Name to specified value.

Parameters:
communityName - java.lang.String
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setListsBackground
 public void setListsBackground(Color c)
Set Lists Background Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setListsFont
 public void setListsFont(Font f)
Set Lists Font to specified Value

Parameters:
f - java.awt.Font
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setListsForeground
 public void setListsForeground(Color c)
Set Lists Foreground Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setLog
 public void setLog(String logText)
Set the Text in Log Area to specified Text.

Parameters:
logText - java.lang.String
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setObjectsFile
 public void setObjectsFile(String file) throws SNMPUIBeanException
Set file name to load Object Names.

Parameters:
file - java.lang.String
Throws: SNMPUIBeanException
in case a Invalid File is passed
 o setTextFieldBackground
 public void setTextFieldBackground(Color c)
Set TextField Background Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setTextFieldFont
 public void setTextFieldFont(Font f)
Set TextField Font to specified Value

Parameters:
f - java.awt.Font
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setTextFieldForeground
 public void setTextFieldForeground(Color c)
Set TextField Foreground Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setUIBackground
 public void setUIBackground(Color c)
Set UserInterface Background Color to specified Value

Parameters:
c - java.awt.Color
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setUIFont
 public void setUIFont(Font f)
Set UserInterface Font to specified Value

Parameters:
f - java.awt.Font
Throws: IllegalArgumentException
in case an Illegal Argument is passed
 o setUIForeground
 public void setUIForeground(Color c)
Set UserInterface Foreground Color to specified Value

Parameters:
c - java.awt.Color exception IllegalArgumentException in case an Illegal Argument is passed
 o windowActivated
 public void windowActivated(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent
 o windowClosed
 public void windowClosed(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent
 o windowClosing
 public void windowClosing(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent
 o windowDeactivated
 public void windowDeactivated(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent
 o windowDeiconified
 public void windowDeiconified(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent
 o windowIconified
 public void windowIconified(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent
 o windowOpened
 public void windowOpened(WindowEvent e)
Method to handle events for the WindowListener interface.

Parameters:
e - java.awt.event.WindowEvent

All Packages  Class Hierarchy  This Package  Previous  Next  Index