AdventNet CLI 2.0 API Specification

Serialized Form


Package com.adventnet.cli

Class com.adventnet.cli.CLIMessage implements Serializable

Serialized Fields

cliData

java.lang.String cliData

cliPrompt

java.lang.String cliPrompt

cliPromptAction

java.util.Properties cliPromptAction

cliProtocolOptions

CLIProtocolOptions cliProtocolOptions

cmdEcho

boolean cmdEcho

msgID

int msgID

msgSuffix

java.lang.String msgSuffix

partialResponse

boolean partialResponse

promptEcho

boolean promptEcho

requestTimeout

int requestTimeout

state

int state

Class com.adventnet.cli.MaxConnectionException implements Serializable


Package com.adventnet.cli.beans

Class com.adventnet.cli.beans.CLIBrowser implements Serializable

Serialized Fields

aboutMenuItem

javax.swing.JMenuItem aboutMenuItem

appendButton

javax.swing.JButton appendButton

appendState

boolean appendState

backgroundMenuItem

javax.swing.JMenuItem backgroundMenuItem

backgroundRr

javax.swing.JMenuItem backgroundRr

barPanel

javax.swing.JPanel barPanel

bClear

javax.swing.JButton bClear

bConfig

javax.swing.JButton bConfig

bConnect

javax.swing.JButton bConnect

bDebug

javax.swing.JButton bDebug

bDisconnect

javax.swing.JButton bDisconnect

bExecuteScript

javax.swing.JButton bExecuteScript

bFind

javax.swing.JButton bFind

bHelp

javax.swing.JButton bHelp

bLoad

javax.swing.JButton bLoad

borderPaintedFlag

boolean borderPaintedFlag

bSave

javax.swing.JButton bSave

bSend

javax.swing.JButton bSend

bUnload

javax.swing.JButton bUnload

c

java.awt.GridBagConstraints c

clearLog

javax.swing.JMenuItem clearLog

clearMenuItem

javax.swing.JMenuItem clearMenuItem

clearRr

javax.swing.JMenuItem clearRr

climsg

CLIMessage climsg
This class contains the CLI command(message) to be sent. Other parameters like the CLIProtocolOptions can be set so that the message is sent to the appropriate device. API users have to instantiate this class with the message to be sent and pass it to send() or syncSend() in CLISession class to send the message.

cliSession

CLISession cliSession
This class creates a connection to the device according to the protocolOptions passed. After this, commands could be sent using the syncSend() or send() method with the CLIMessage. For Asynchronous messages the application has to implement the CLIClient interface and register with the CLISession using addCLIClient() to receive the responses by overriding the callback Method.

cmdSet

CommandSet cmdSet
Interface funtions

configMenuItem

javax.swing.JMenuItem configMenuItem

configureDg

com.adventnet.cli.beans.CLIBrowser.ConfigureDialog configureDg
Inner class for setting the API's

connectDg

com.adventnet.cli.beans.CLIBrowser.ConnectDialog connectDg
Inner class ConnectDialog used to get configuration parameters from user needed for establishing connection. Also contains some system resource parameters to set.

connectFlag

boolean connectFlag

connectMenuItem

javax.swing.JMenuItem connectMenuItem

copyLog

javax.swing.JMenuItem copyLog

copyRr

javax.swing.JMenuItem copyRr

dataPanel

javax.swing.JPanel dataPanel

dataSet

DataSet dataSet

debugger

com.adventnet.cli.beans.CLIBrowser.Debugger debugger
Inner class for showing the debug messages.

debugMenu

javax.swing.JMenuItem debugMenu

defDataFileVector

java.util.Vector defDataFileVector

defDataSetFileName

java.lang.String defDataSetFileName

disconnectMenuItem

javax.swing.JMenuItem disconnectMenuItem

displayMenu

javax.swing.JMenu displayMenu

dlmLO

javax.swing.DefaultListModel dlmLO

dlmLOA

javax.swing.DefaultListModel dlmLOA

dlmSO

javax.swing.DefaultListModel dlmSO

dlmSOA

javax.swing.DefaultListModel dlmSOA

editMenu

javax.swing.JMenu editMenu

executeScriptDialog

com.adventnet.cli.beans.CLIBrowser.ExecuteScriptDialog executeScriptDialog
Inner class for executing the script file specified.

exeScriptMenuItem

javax.swing.JMenuItem exeScriptMenuItem

fileMenu

javax.swing.JMenu fileMenu

fileName

java.lang.String fileName

findDialog

com.adventnet.cli.beans.CLIBrowser.FindDialog findDialog
Inner class for finding node from the tree.

findMenuItem

javax.swing.JMenuItem findMenuItem

findNodeMI

javax.swing.JMenuItem findNodeMI

fontColor

java.awt.Color fontColor

fontMenuItem

javax.swing.JMenuItem fontMenuItem

fontRr

javax.swing.JMenuItem fontRr

foregroundMenuItem

javax.swing.JMenuItem foregroundMenuItem

foregroundRr

javax.swing.JMenuItem foregroundRr

frame

javax.swing.JFrame frame

gb

java.awt.GridBagLayout gb

getMatchFound

boolean getMatchFound

helpFile

java.lang.String helpFile

helpindexMenuItem

javax.swing.JMenuItem helpindexMenuItem

helpMenu

javax.swing.JMenu helpMenu

ip

javax.swing.JTextField ip

ipCB

javax.swing.JComboBox ipCB

isFound

boolean isFound

isMenuBarVisible

boolean isMenuBarVisible

isToolBarVisible

boolean isToolBarVisible

labFont

java.awt.Font labFont

ledPanel

com.adventnet.beans.LedPanel ledPanel

lip

javax.swing.JLabel lip

listDg

com.adventnet.cli.beans.CLIBrowser.ListDialog listDg
Inner class for showing the list of DataInstances.

listLO

javax.swing.JList listLO

listLOA

javax.swing.JList listLOA

listSO

javax.swing.JList listSO

listSOA

javax.swing.JList listSOA

lLongOpt

javax.swing.JLabel lLongOpt

lLongOptArg

javax.swing.JLabel lLongOptArg

loadMenuItem

javax.swing.JMenuItem loadMenuItem

loadMesgSetConfigDialog

com.adventnet.cli.beans.CLIBrowser.LoadMesgSetConfigDialog loadMesgSetConfigDialog
Inner classes for loading the Command set and Data set files....

loadMesgSetFilesDialog

com.adventnet.cli.beans.CLIBrowser.LoadMesgSetFilesDialog loadMesgSetFilesDialog

logoLabel

javax.swing.JLabel logoLabel

longOptArgButton

javax.swing.JButton longOptArgButton

longOptArgComboBox

javax.swing.JComboBox longOptArgComboBox

longOptButton

javax.swing.JButton longOptButton

longOptComboBox

javax.swing.JComboBox longOptComboBox

lSeparator

javax.swing.JLabel lSeparator

lSimpleOpt

javax.swing.JLabel lSimpleOpt

lSimpleOptArg

javax.swing.JLabel lSimpleOptArg

lType

javax.swing.JLabel lType

lValue

javax.swing.JLabel lValue

menuBar

javax.swing.JMenuBar menuBar

oprMenu

javax.swing.JMenu oprMenu

optionBlockCBMI

javax.swing.JCheckBoxMenuItem optionBlockCBMI

optionCancelButton

javax.swing.JButton optionCancelButton

optionOKButton

javax.swing.JButton optionOKButton

panelDes

javax.swing.JPanel panelDes

panelMes

javax.swing.JPanel panelMes

panelOB

javax.swing.JPanel panelOB

panelPB

javax.swing.JPanel panelPB

pasteLog

javax.swing.JMenuItem pasteLog

pasteRr

javax.swing.JMenuItem pasteRr

popupLog

javax.swing.JPopupMenu popupLog

popupRr

javax.swing.JPopupMenu popupRr

popupTree

javax.swing.JPopupMenu popupTree

progDialog

javax.swing.JDialog progDialog

progLabel

java.awt.Label progLabel

progPanel

javax.swing.JPanel progPanel

promptDialog

com.adventnet.cli.beans.CLIBrowser.PromptActionTableDialog promptDialog

responseTabMenu

javax.swing.JMenu responseTabMenu

rightPanel

javax.swing.JPanel rightPanel

saveAsMenuItem

javax.swing.JMenuItem saveAsMenuItem

saveLog

javax.swing.JMenuItem saveLog

saveMenuItem

javax.swing.JMenuItem saveMenuItem

saveRr

javax.swing.JMenuItem saveRr

scoi

SerialCommOptionsImpl scoi
Contains ProtocolOptions for Serial Connections. Contains the Port/FlowControl and other parameters

searchCount

int searchCount

sendMenuItem

javax.swing.JMenuItem sendMenuItem

sendSpecialCharMenuItem

javax.swing.JMenuItem sendSpecialCharMenuItem

separator

javax.swing.JTextField separator

setMatchFound

boolean setMatchFound

settingsRr

javax.swing.JMenu settingsRr

simpleOptArgButton

javax.swing.JButton simpleOptArgButton

simpleOptArgComboBox

javax.swing.JComboBox simpleOptArgComboBox

simpleOptButton

javax.swing.JButton simpleOptButton

simpleOptComboBox

javax.swing.JComboBox simpleOptComboBox

spDes

javax.swing.JScrollPane spDes

specialCharCBMI

javax.swing.JCheckBoxMenuItem specialCharCBMI

spListLO

javax.swing.JScrollPane spListLO

spListLOA

javax.swing.JScrollPane spListLOA

spListSO

javax.swing.JScrollPane spListSO

spListSOA

javax.swing.JScrollPane spListSOA

splitPaneHorz

javax.swing.JSplitPane splitPaneHorz

splitPaneVert

javax.swing.JSplitPane splitPaneVert

spLog

javax.swing.JScrollPane spLog

spMain

javax.swing.JScrollPane spMain

spRr

javax.swing.JScrollPane spRr

spTree

javax.swing.JScrollPane spTree

statusBar

javax.swing.JLabel statusBar

statusPanel

javax.swing.JPanel statusPanel

taDes

javax.swing.JTextArea taDes

textAreaLog

javax.swing.JTextArea textAreaLog

textAreaRr

javax.swing.JTextArea textAreaRr

toolBar

javax.swing.JToolBar toolBar

toolBarCBMI

javax.swing.JCheckBoxMenuItem toolBarCBMI

toolBarPanel

javax.swing.JPanel toolBarPanel

tp

javax.swing.JTabbedPane tp

tpoi

TelnetProtocolOptionsImpl tpoi
Contains ProtocolOptions for Telnet Connections. Contains the RemoteHost/RemotePort and other parameters

tpPanel

javax.swing.JPanel tpPanel

transformDialog

com.adventnet.cli.beans.CLIBrowser.TransformDialog transformDialog
Inner class for enabling/disabling the transformation of the response received.

transformMenuItem

javax.swing.JCheckBoxMenuItem transformMenuItem

tree

CLITree tree

treePanel

javax.swing.JPanel treePanel

typeComboBox

javax.swing.JComboBox typeComboBox

unloadMenuItem

javax.swing.JMenuItem unloadMenuItem

value

javax.swing.JTextField value

viewMenu

javax.swing.JMenu viewMenu


Package com.adventnet.cli.beans.tree

Class com.adventnet.cli.beans.tree.CLIMutableTreeNode implements Serializable

Serialized Fields

commandSet

CommandSet commandSet

delimiter

java.lang.String delimiter

description

java.lang.String description

example

java.lang.String example

name

java.lang.String name

optChar

java.lang.String optChar

optDep

java.lang.String optDep

options

java.lang.String options

optPrefix

java.lang.String optPrefix

paramValueType

byte paramValueType

relatedCommands

java.lang.String relatedCommands

remarks

java.lang.String remarks

sendParam

boolean sendParam

syntax

java.lang.String syntax

Class com.adventnet.cli.beans.tree.CLITree implements Serializable

Serialized Fields

cmdSet

CommandSet cmdSet

cmdSetFilesHash

java.util.Hashtable cmdSetFilesHash

dataSet

DataSet dataSet

dataSetFilesHash

java.util.Hashtable dataSetFilesHash

rootNode

CLIMutableTreeNode rootNode

showHelpNode

boolean showHelpNode

treeModel

javax.swing.tree.DefaultTreeModel treeModel

xmlFileVect

java.util.Vector xmlFileVect


Package com.adventnet.cli.config

Class com.adventnet.cli.config.ConfigException implements Serializable

Class com.adventnet.cli.config.DataException implements Serializable

Class com.adventnet.cli.config.ExecutionException implements Serializable


Package com.adventnet.cli.messageset

Class com.adventnet.cli.messageset.CLICommandTemplate implements Serializable

Serialized Fields

cmdHelp

com.adventnet.cli.messageset.CmdHelp cmdHelp

cmdName

java.lang.String cmdName

cmdObjectList

CmdObject[] cmdObjectList

cmdOptions

com.adventnet.cli.messageset.CmdOptions cmdOptions

cmdParamsList

CmdParams[] cmdParamsList

delimiter

java.lang.String delimiter

Class com.adventnet.cli.messageset.CLIDataInstance implements Serializable

Serialized Fields

cmdObjectList

CmdObject[] cmdObjectList

cmdOption

com.adventnet.cli.messageset.CmdOptions cmdOption

cmdParamList

CmdParams[] cmdParamList

dataName

java.lang.String dataName

Class com.adventnet.cli.messageset.CmdObject implements Serializable

Serialized Fields

childObjectList

CmdObject[] childObjectList

delimiter

java.lang.String delimiter

description

java.lang.String description

objectName

java.lang.String objectName

objectValue

java.lang.String objectValue

optionsList

com.adventnet.cli.messageset.CmdOptions optionsList

parameterList

CmdParams[] parameterList

sendParam

boolean sendParam

Class com.adventnet.cli.messageset.CmdParams implements Serializable

Serialized Fields

description

java.lang.String description

optionFlag

boolean optionFlag

paramName

java.lang.String paramName

paramValue

java.lang.String paramValue

paramValueType

byte paramValueType

sendParam

boolean sendParam

Class com.adventnet.cli.messageset.CommandSet implements Serializable

Serialized Fields

commandTable

java.util.Hashtable commandTable

currDataOpts

com.adventnet.cli.messageset.CmdOptions currDataOpts

currDataParams

CmdParams[] currDataParams

dataSet

DataSet dataSet

fileName

java.lang.String fileName

formCommandWithOptions

boolean formCommandWithOptions

objDataOptsSet

boolean objDataOptsSet

objDataParamSet

boolean objDataParamSet
Gets the command for a given command name and data name and the specified object name path. The Command name selects a particular command in the CommandSet. The data name selects an Instance of data for the Command from the DataSet and the object names specifies the path of the command to be formed.

rootNode

com.adventnet.cli.messageset.Element rootNode

Class com.adventnet.cli.messageset.DataSet implements Serializable

Serialized Fields

commandName

java.lang.String commandName

dataTable

java.util.Hashtable dataTable

fos

java.io.FileOutputStream fos

rootNode

com.adventnet.cli.messageset.Element rootNode

tabCount

int tabCount

Class com.adventnet.cli.messageset.InvalidCommandException implements Serializable


Package com.adventnet.cli.rmi

Class com.adventnet.cli.rmi.CLIFactoryImpl implements Serializable

Serialized Fields

cliResourceManager

com.adventnet.cli.rmi.CLIResourceManagerImpl cliResourceManager


Package com.adventnet.cli.ssh

Class com.adventnet.cli.ssh.SshException implements Serializable


Package com.adventnet.cli.terminal

Class com.adventnet.cli.terminal.TerminalException implements Serializable


Package com.adventnet.cli.transport

Class com.adventnet.cli.transport.ConnectException implements Serializable

Class com.adventnet.cli.transport.LoginException implements Serializable

Class com.adventnet.cli.transport.TelnetProtocolOptionsImpl implements Serializable

Serialized Fields

loginMessage

java.lang.String loginMessage

loginName

java.lang.String loginName

loginPrompt

java.lang.String loginPrompt

loginTimeout

int loginTimeout

passwdPrompt

java.lang.String passwdPrompt

password

java.lang.String password

performPing

boolean performPing

prompt

java.lang.String prompt

remoteHost

java.lang.String remoteHost

remotePort

int remotePort


Package com.adventnet.cli.transport.ssh

Class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl implements Serializable

Serialized Fields

loginMessage

java.lang.String loginMessage

loginName

java.lang.String loginName

loginTimeout

int loginTimeout

password

java.lang.String password

prompt

java.lang.String prompt

remoteHost

java.lang.String remoteHost

remotePort

int remotePort

terminalType

java.lang.String terminalType


Package com.adventnet.telnet.telnetwindow

Class com.adventnet.telnet.telnetwindow.TelnetFrame implements Serializable

Serialized Fields

applet

java.applet.Applet applet

BackgroundItem

java.awt.MenuItem BackgroundItem

client

com.adventnet.telnet.telnetwindow.TelnetClient client

closeOnDisconnect

boolean closeOnDisconnect

connected

boolean connected

ConnectMenuItem

java.awt.MenuItem ConnectMenuItem

DecreaseBuffer

java.awt.MenuItem DecreaseBuffer

DisconnectMenuItem

java.awt.MenuItem DisconnectMenuItem

encoding

java.lang.String encoding

Encoding

java.awt.MenuItem Encoding

ExitMenuItem

java.awt.MenuItem ExitMenuItem

FileMenu

java.awt.Menu FileMenu

fontSize

int fontSize

ForegroundItem

java.awt.MenuItem ForegroundItem

frameTitle

java.lang.String frameTitle

host

java.lang.String host

iconImage

java.awt.Image iconImage

IncreaseBuffer

java.awt.MenuItem IncreaseBuffer

initialized

boolean initialized

isMenuBarVisible

boolean isMenuBarVisible

loginPrompt

java.lang.String loginPrompt

menuBar

java.awt.MenuBar menuBar

password

java.lang.String password

passwordPrompt

java.lang.String passwordPrompt

portNo

int portNo

reader

java.lang.Thread reader

running

boolean running

sbar

java.awt.Scrollbar sbar

serverName

java.lang.String serverName

SettingsMenu

java.awt.Menu SettingsMenu

socketTimeout

int socketTimeout

terminal

com.adventnet.telnet.telnetwindow.Vt terminal

Top

java.awt.Panel Top

username

java.lang.String username


Package com.adventnet.util.parser

Class com.adventnet.util.parser.ParseException implements Serializable


Package com.adventnet.util.script

Class com.adventnet.util.script.ScriptHandlerException implements Serializable


AdventNet CLI 2.0 API Specification