A B C D E F G I K L M O P R S T U V W

A

actionPerformed(ActionEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface ActionListener and should not be invoked by the user.

actionPerformed(ActionEvent) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This method is internally used by the API which overrides the method in the Interface ActionListener and should not be invoked by the user.

addCLIClient(CLIClient) - Method in class com.adventnet.cli.CLISession

Registers the CLIClient for receiving the asynchronous Response for an asynchronous request(sent using send()) via callback.

addCLIClient(CLIClient) - Method in interface com.adventnet.cli.rmi.CLISession

Registers the CLIClient for receiving the asynchronous Response for a asyn request.

addConfiguration(ConfigObject) - Method in class com.adventnet.cli.config.ConfigAPI

Adds the configuration to the existing list of configuration.

addConnectionListener(ConnectionListener) - Method in class com.adventnet.cli.CLISession

Registers the connectionListener, if not already registered as a listener.

addConnectionListener(ConnectionListener) - Method in interface com.adventnet.cli.rmi.CLISession

Registers the connectionListener, if not already registered as a listener.

addRunScriptIfcImplClassName(String, String) - Method in class com.adventnet.util.script.ScriptHandler

This method can be used when the user wants to dynamically add a scriptType and its corresponding class, to the already existing list.

appendTask(String, Task) - Method in class com.adventnet.cli.config.ConfigAPI

Appends the task to the end of the tasklist.

assembleCommand(String, String) - Method in class com.adventnet.cli.messageset.CommandSet

Assembles the CLI command from this Command Set based on the commandName and parameters.

assembleCommand(String, String, String) - Method in class com.adventnet.cli.messageset.CommandSet

Assembles the CLI command from this Command Set based on the commandName, the object path and parameters.

B

BeanShellScriptRunnerImpl - class com.adventnet.util.script.BeanShellScriptRunnerImpl.

This is a default implementation of the RunScriptInterface for the scripting language "beanshell".

BeanShellScriptRunnerImpl() - Constructor for class com.adventnet.util.script.BeanShellScriptRunnerImpl

Creates a new BeanShellScriptRunnerImpl instance.

C

callback(CLISession, CLIMessage, int) - Method in class com.adventnet.cli.beans.CLIBrowser

This method will be called when a response is received.

callback(CLISession, CLIMessage, int) - Method in interface com.adventnet.cli.CLIClient

This method is called whenever a response for an asynchronous CLI message is received.

callback(CLISession, CLIMessage, int) - Method in interface com.adventnet.cli.rmi.CLIClient

This method is called whenever a response for an asynchronous CLI message is received.

CHAR - Static variable in class com.adventnet.cli.messageset.CmdParams

Constant for Character Option type.

CLIBrowser - class com.adventnet.cli.beans.CLIBrowser.

This class is a bean that provides the UI for sending CLI Commands and receiving Responses.

CLIBrowser() - Constructor for class com.adventnet.cli.beans.CLIBrowser

Constructor used in application instance.

CLIBrowser(JFrame) - Constructor for class com.adventnet.cli.beans.CLIBrowser

Constructor used in application with the given frame instance.

CLIBrowser(String) - Constructor for class com.adventnet.cli.beans.CLIBrowser

Constructor used to set the file which is to be loaded.

CLIBrowser(String, JFrame) - Constructor for class com.adventnet.cli.beans.CLIBrowser

Constructor used in frame instance.

CLIBrowser(String, String, JFrame) - Constructor for class com.adventnet.cli.beans.CLIBrowser

Constructor used in frame instance.

CLIClient - interface com.adventnet.cli.CLIClient.

This is the interface that should be implemented by applications which want to receive Asynchronous CLI responses.

CLIClient - interface com.adventnet.cli.rmi.CLIClient.

This is the RMI interface that should be implemented by RMI Client applications which want to receive Asynchronous CLI responses.

CLICommandTemplate - class com.adventnet.cli.messageset.CLICommandTemplate.

This class contains the Command Template read from a template definitions file.

CLIDataInstance - class com.adventnet.cli.messageset.CLIDataInstance.

This class contains an Instance of Data for a command in the command set.

CLIERR - Static variable in class com.adventnet.cli.util.CLILogMgr

For displaying the log error messages from the CLI.

CLIFactory - interface com.adventnet.cli.rmi.CLIFactory.

This RMI interface defines a factory interface for creating remote server objects from an RMI client to the RMI server.

CLIFactoryImpl - class com.adventnet.cli.rmi.CLIFactoryImpl.

This implements the RMI interface which defines a factory interface for creating remote server objects from an RMI client to the RMI server.

CLIFactoryImpl() - Constructor for class com.adventnet.cli.rmi.CLIFactoryImpl

Instantiates a new CLIFactoryImpl object.

CLILogMgr - class com.adventnet.cli.util.CLILogMgr.

This class manages the printing of log out and error messages from CLI.

CLILogMgr(String, String) - Constructor for class com.adventnet.cli.util.CLILogMgr

Creates a new CLILogMgr instance and initializes the variables for logging from the logging_parameters.conf file.

CLIMessage - class com.adventnet.cli.CLIMessage.

This class contains the CLI command(message) to be sent.

CLIMessage(byte[]) - Constructor for class com.adventnet.cli.CLIMessage

Constructs a CLI Message with the byte[] data.

CLIMessage(String) - Constructor for class com.adventnet.cli.CLIMessage

Constructs a CLI Message with the String message

CLIMutableTreeNode - class com.adventnet.cli.beans.tree.CLIMutableTreeNode.

This class is used for creating CLI TreeNodes.

CLIMutableTreeNode() - Constructor for class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Constructor to create a CLI Tree Node.

CLIMutableTreeNode(Object) - Constructor for class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Constructor to create a CLI Tree Node of a given name.

CLIMutableTreeNode(String) - Constructor for class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Constructor to create a CLI Tree Node of a given name.

CLIMutableTreeNode(String, boolean) - Constructor for class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Constructor to create a CLI Tree Node with an option to accept children.

CLIProtocolOptions - interface com.adventnet.cli.transport.CLIProtocolOptions.

This interface defines some protocol specific options which have to be implemented by the user depending upon the protocol being used to communicate with the CLI device.

CLIResourceManager - class com.adventnet.cli.CLIResourceManager.

This class is to manage System-wide resources associated with the CLI APIs within the same Java Virtual Machine (JVM).

CLIResourceManager - interface com.adventnet.cli.rmi.CLIResourceManager.

This is the RMI interface implemented by the CLIResourceManagerImpl class.

CLISession - class com.adventnet.cli.CLISession.

This class is used for establishing CLI sessions with various devices.

CLISession - interface com.adventnet.cli.rmi.CLISession.

This is the RMI interface implemented by the CLISessionImpl class.

CLISession(CLIProtocolOptions) - Constructor for class com.adventnet.cli.CLISession

Creates a new CLISession object by taking the cliProtocolOptions as the argument.

CLISession(CLIProtocolOptions, boolean) - Constructor for class com.adventnet.cli.CLISession

Creates a new CLISession object by taking the cliProtocolOptions and enablePooling flag as arguments.

CLITransportProvider - interface com.adventnet.cli.transport.CLITransportProvider.

Interface that represents a transport connection between the CLI application and the device.

CLITree - class com.adventnet.cli.beans.tree.CLITree.

This class is used to display the XML files in tree format.

CLITree() - Constructor for class com.adventnet.cli.beans.tree.CLITree

Constructor to create an Empty Tree.

CLITree(CLIMutableTreeNode) - Constructor for class com.adventnet.cli.beans.tree.CLITree

Constructor for creating a Tree with specified Root Node.

CLIUSER - Static variable in class com.adventnet.cli.util.CLILogMgr

For displaying the log out messages from the CLI.

clone() - Method in class com.adventnet.cli.CLIMessage

Returns an exact copy of this CLIMessage object.

clone() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Performs a clone of this object.

clone() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Returns an exact copy of this object.

clone() - Method in interface com.adventnet.cli.transport.CLIProtocolOptions

Performs a clone of this object.

clone() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Returns an exact copy of this object.

close() - Method in class com.adventnet.cli.CLISession

Closes the CLISession.

close() - Method in class com.adventnet.cli.config.ExecutionInterfaceImpl

This method can be used for closing the session established by the user.

close() - Method in interface com.adventnet.cli.config.ExecutionInterface

This method can be used for closing the session established by the user.

close() - Method in interface com.adventnet.cli.rmi.CLISession

Closes the CLISession and stops the asynch receiver thread.

close() - Method in class com.adventnet.cli.serial.SerialCommSession

Closes the Serial port session.

close() - Method in class com.adventnet.cli.serial.SerialCommProviderImpl

This closes the Serial port connection to device.

close() - Method in interface com.adventnet.cli.transport.CLITransportProvider

Closes the transport interface after the communication is over.

close() - Method in class com.adventnet.cli.transport.TelnetTransportImpl

This closes the telnet connection to the remote device.

close() - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

This closes the SSH connection to the remote device.

close() - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

This closes the SSH connection to the remote device.

close() - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

This closes the SSH connection to the remote device.

closeAllConnections() - Method in class com.adventnet.cli.CLIResourceManager

Closes all the connections associated with the multiplexed (non-dedicated) session in the connection pool.

closeAllConnections() - Method in interface com.adventnet.cli.rmi.CLIResourceManager

closeSession(Object) - Method in class com.adventnet.cli.config.ConfigAPI

Closes the session established by the user and also removes the ExecutionInterface maintained for the session id.

CMD_DATA_NOT_FOUND - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when the Data instance (CLIDataInstance) is not present (null) in the DataSet for a particular command that is used during the assembling of the command.

CMD_INSUFFICIENT_PARAMS - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when the no of parameters provided is insufficient for a particular command being assembled.

CMD_INVALID_DATA - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when the data from the DataInstance is of incorrect type.

CMD_LONGOPTIONARGSNAME_MISMATCH - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when there is a mismatch between the long opts args name in a particular command and its Data instance.

CMD_NAME_NOT_FOUND - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when the command Name is not present (null) in the commandSet for a particular command that is used during the assembling of the command.

CMD_NOT_FOUND - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when the command identified by the command name is not present in the commandSet used during the assembling of the command.

CMD_PARAMNAME_MISMATCH - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when there is a mismatch between the parameter name in a particular command and its Data instance.

CMD_PATH_NOT_FOUND - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when the object List(path) specified is not present in the commandSet used during the assembling of the command.

CMD_SIMPLEOPTIONARGSNAME_MISMATCH - Static variable in class com.adventnet.cli.messageset.InvalidCommandException

This error is thrown when there is a mismatch between the simple opts args name in a particular command and its Data instance.

CmdObject - class com.adventnet.cli.messageset.CmdObject.

This class represents the Objects on which the command is executed.

CmdParams - class com.adventnet.cli.messageset.CmdParams.

This class contains the Command Parameters for a particular command or object within a command.

com.adventnet.cli - package com.adventnet.cli

This CLI API package implements the basic CLI Communications with a CLI device.

com.adventnet.cli.beans - package com.adventnet.cli.beans

This package consists of CLI bean-related classes.

com.adventnet.cli.beans.tree - package com.adventnet.cli.beans.tree

This package contains the beans component for the CLI Tree.

com.adventnet.cli.config - package com.adventnet.cli.config

The Config package contains classes that can be used for configuring all CLI-based devices like routers, switches, etc.

com.adventnet.cli.messageset - package com.adventnet.cli.messageset

This messageset package contains classes for constructing commands based on a Command set and Data Set.

com.adventnet.cli.rmi - package com.adventnet.cli.rmi

This package contains the RMI server-side interface and factory for the CLI API.

com.adventnet.cli.serial - package com.adventnet.cli.serial

This package contains the transport classes for communication with CLI devices over the Serial Port. It contains the Serial Port provider implementation for the CLIProtocolProvider.

com.adventnet.cli.ssh - package com.adventnet.cli.ssh

com.adventnet.cli.terminal - package com.adventnet.cli.terminal

This package contains the classes related to Terminal IO handling.

com.adventnet.cli.transport - package com.adventnet.cli.transport

This package contains the transport classes for communication with the CLI device. It contains the default Telnet provider implementation.

com.adventnet.cli.transport.ssh - package com.adventnet.cli.transport.ssh

com.adventnet.cli.transport.ssh.sshv1 - package com.adventnet.cli.transport.ssh.sshv1

com.adventnet.cli.transport.ssh.sshv2 - package com.adventnet.cli.transport.ssh.sshv2

com.adventnet.cli.util - package com.adventnet.cli.util

This package contains a class which manages directing of CLI log messages to files.

com.adventnet.telnet - package com.adventnet.telnet

This package contains the classes for doing Telnet communication with a Remote Device.

com.adventnet.telnet.telnetwindow - package com.adventnet.telnet.telnetwindow

This package contains the TelnetFrame class which can be used by applications to open a Terminal console with any device supporting Telnet.

com.adventnet.util.parser - package com.adventnet.util.parser

This package contains the Utility classes for parsing any message Stream (example CLI response).

com.adventnet.util.parser.generic - package com.adventnet.util.parser.generic

This package contains the GenericParser class which is an implementation of the ParserInterface present in the com.adventnet.util.parser package.

com.adventnet.util.parser.line - package com.adventnet.util.parser.line

This package contains the LineParser class which is an implementation of the ParserInterface present in the com.adventnet.util.parser package.

com.adventnet.util.script - package com.adventnet.util.script

This package provides interfaces and classes that are used for executing scripts for any application.

COMMAND - Static variable in class com.adventnet.cli.config.Task

A command task.

CommandSet - class com.adventnet.cli.messageset.CommandSet.

This class contains the set of CLI commands parsed from a Command Template file (say XML).

CommandSet(String) - Constructor for class com.adventnet.cli.messageset.CommandSet

Constructor for the CommandSet.

ConfigAPI - class com.adventnet.cli.config.ConfigAPI.

This class can be used for configuring all CLI based devices.

ConfigAPI() - Constructor for class com.adventnet.cli.config.ConfigAPI

Creates a new ConfigAPI instance (default constructor).

ConfigAPI(String) - Constructor for class com.adventnet.cli.config.ConfigAPI

Creates a new ConfigAPI instance.

ConfigException - exception com.adventnet.cli.config.ConfigException.

This class represents an Exception thrown, if any abnormal condition occurs while adding, deleting or running a configuration.

ConfigException() - Constructor for class com.adventnet.cli.config.ConfigException

Creates a new ConfigException instance.

ConfigException(String) - Constructor for class com.adventnet.cli.config.ConfigException

Creates a new ConfigException instance with the specified detail message.

ConfigObject - class com.adventnet.cli.config.ConfigObject.

This class is used to represent a configuration which contains a set of tasks to be executed in a sequence.

ConfigObject() - Constructor for class com.adventnet.cli.config.ConfigObject

Creates a new ConfigObject instance.

connect(SshConnectionProperties, HostKeyVerification) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Connects to client to a SSH server

connect(String) - Method in class com.adventnet.telnet.TelnetSession

This will create the Telnet Socket stream with the remote peer specified in the remoteHost argument.

connect(String) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Opens connection to a SSH server on the standard port 22 using the default SshHostKeyVerification instance to verify the host key.

connect(String, int) - Method in class com.adventnet.telnet.TelnetSession

This will create the Telnet Socket stream with the remote peer specified in the remoteHost argument.

connect(String, int) - Method in interface com.adventnet.cli.transport.ssh.SshTransportProviderInterface

This will create the Ssh Socket stream with the remote peer specified in the remoteHost argument.

connect(String, int) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Connects to the remote host.

connect(String, int) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Creates the socket and opens the connection to remote host at the specified port.

connect(String, int) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Connects the client to a SSH server on any given port using the default SshHostKeyVerification instance to verify the host key.

connect(String, int, HostKeyVerification) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Connects the client to a SSH server using the HostKeyVerification as given by the user.

All connection properties such as cipher and message authentication algorithms are defaulted.

ConnectException - exception com.adventnet.cli.transport.ConnectException.

This class represents an Exception thrown when unable to establish a CLI Connection with the remote device.

ConnectException() - Constructor for class com.adventnet.cli.transport.ConnectException

Constructs a ConnectException with no detail message.

ConnectException(String) - Constructor for class com.adventnet.cli.transport.ConnectException

Constructs a ConnectException with the specified detail message.

ConnectionListener - interface com.adventnet.cli.ConnectionListener.

This is the interface that should be implemented by applications for getting notification of the timeout of transport connection (Example: Telnet, Serial) associated with the multiplexed (non-dedicated) sessions.

connectionTimedOut(CLIProtocolOptions) - Method in interface com.adventnet.cli.ConnectionListener

This method is invoked, when any of the transport connections associated with the multiplexed (non-dedicated) sessions times out.

createCLIResourceManager() - Method in interface com.adventnet.cli.rmi.CLIFactory

Creates a CLIResourceManager object on the server and returns a reference to it.

createCLIResourceManager() - Method in class com.adventnet.cli.rmi.CLIFactoryImpl

Creates a CLIResourceManager object on the server and returns a reference to it.

createCLISession(CLIProtocolOptions) - Method in interface com.adventnet.cli.rmi.CLIFactory

Creates a CLISession object on the server with the CLIProtocolOptions argument and returns a reference to it.

createCLISession(CLIProtocolOptions) - Method in class com.adventnet.cli.rmi.CLIFactoryImpl

Creates a CLISession object on the server with the CLIProtocolOptions argument and returns a reference to it.

createCLISession(CLIProtocolOptions, boolean) - Method in interface com.adventnet.cli.rmi.CLIFactory

Creates a CLISession object on the server and returns a reference to it.

createCLISession(CLIProtocolOptions, boolean) - Method in class com.adventnet.cli.rmi.CLIFactoryImpl

Create a CLISession object on the server and return a reference to it.

createMenu(String, char, ImageIcon) - Method in class com.adventnet.cli.beans.CLIBrowser

To create a Menu.

createMenuItem(String, char, ImageIcon, ActionListener, String) - Method in class com.adventnet.cli.beans.CLIBrowser

To create a MenuItem.

D

DATABITS_5 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

5 bit Data Format

DATABITS_6 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

6 bit Data Format

DATABITS_7 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

7 bit Data Format

DATABITS_8 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

8 bit Data Format

DataException - exception com.adventnet.cli.config.DataException.

This class represents an Exception thrown, if any abnormal condition occurs while obtaining data for a command or a script code.

DataException() - Constructor for class com.adventnet.cli.config.DataException

Creates a new DataException instance.

DataException(String) - Constructor for class com.adventnet.cli.config.DataException

Creates a new DataException instance with the specified detail message.

DataInterface - interface com.adventnet.cli.config.DataInterface.

The data for a configuration can optionally be given with the help of this interface.

DataSet - class com.adventnet.cli.messageset.DataSet.

This class contains the set of Data instances for the CLI CommandSet.

DataSet(String) - Constructor for class com.adventnet.cli.messageset.DataSet

Constructor for the DataSet.

deleteConfiguration(String) - Method in class com.adventnet.cli.config.ConfigAPI

Deletes the configuration with the given name.

deleteTask(String, String) - Method in class com.adventnet.cli.config.ConfigAPI

Deletes the task with the given name belonging the specified configuration.

disconnect() - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Disconnects the SSH connection to the remote host.

disconnect() - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Disconnects the SSH connection

displayHelpNode(boolean) - Method in class com.adventnet.cli.beans.tree.CLITree

Flag used either to display or hide Help Node in NodeTree.

E

executeCommand(CLIMessage) - Method in class com.adventnet.cli.config.ExecutionInterfaceImpl

This method executes the command given to it using the CLI APIs.

executeCommand(CLIMessage) - Method in interface com.adventnet.cli.config.ExecutionInterface

This method executes the command given to it.

executeLine(String) - Method in class com.adventnet.util.script.ScriptHandler

This method executes a line of script written in one of the Scripting languages (example: Python).

executeLine(String) - Method in class com.adventnet.util.script.BeanShellScriptRunnerImpl

This method executes a line of script written in beanshell using the bsh interpreter.

executeLine(String) - Method in interface com.adventnet.util.script.RunScriptInterface

This method executes a line of script written in one of the Scripting language (e.g.

executeLine(String) - Method in class com.adventnet.util.script.PythonScriptRunnerImpl

This method executes a line of script written in python using the python interpreter.

executeScript(String) - Method in class com.adventnet.util.script.BeanShellScriptRunnerImpl

This method executes Script written in beanshell.

executeScript(String) - Method in interface com.adventnet.util.script.RunScriptInterface

This method executes Script written in any of the Scripting language (e.g Python, Perl etc).

executeScript(String) - Method in class com.adventnet.util.script.PythonScriptRunnerImpl

This method executes Script written in python.

executeScript(String, String[]) - Method in class com.adventnet.util.script.BeanShellScriptRunnerImpl

This method executes script written in beanshell.

executeScript(String, String[]) - Method in interface com.adventnet.util.script.RunScriptInterface

This method executes Script written in any of the Scripting language (e.g Python, Perl etc).

executeScript(String, String[]) - Method in class com.adventnet.util.script.PythonScriptRunnerImpl

This method executes script written in python.

executeScript(String, String[], String) - Method in class com.adventnet.cli.config.ExecutionInterfaceImpl

Executes the script file given to the method.

executeScript(String, String[], String) - Method in interface com.adventnet.cli.config.ExecutionInterface

This method executes the file containing the script.

executeScriptFromFile(String) - Method in class com.adventnet.util.script.ScriptHandler

This method executes Script written in any of the Scripting language (example: Python, Perl, etc).

executeScriptFromFile(String, String) - Method in class com.adventnet.util.script.ScriptHandler

This method executes Script written in any of the Scripting languages (example: Python, Perl, etc).

executeScriptFromFile(String, String[]) - Method in class com.adventnet.util.script.ScriptHandler

This method executes Script written in any of the Scripting languages (example: Python, Perl, etc).

executeScriptFromFile(String, String[], String) - Method in class com.adventnet.util.script.ScriptHandler

This method executes Script written in any of the Scripting languages (example: Python, Perl, etc).

ExecutionException - exception com.adventnet.cli.config.ExecutionException.

This class represents an Exception thrown, if any abnormal condition occurs while executing a command or a script code.

ExecutionException() - Constructor for class com.adventnet.cli.config.ExecutionException

Creates a new ExecutionException instance.

ExecutionException(String) - Constructor for class com.adventnet.cli.config.ExecutionException

Creates a new ExecutionException instance with the specified detail message.

ExecutionInterface - interface com.adventnet.cli.config.ExecutionInterface.

This is the interface that needs to be implemented when the user wants to execute a particular configuration.

ExecutionInterfaceImpl - class com.adventnet.cli.config.ExecutionInterfaceImpl.

This is the default implementation of ExecutionInterface using the CLI APIs.

ExecutionInterfaceImpl() - Constructor for class com.adventnet.cli.config.ExecutionInterfaceImpl

Creates a new ExecutionInterfaceImpl instance.

F

FLOAT - Static variable in class com.adventnet.cli.messageset.CmdParams

Constant for Float Option type.

FLOWCONTROL_NONE - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

No flow Control

FLOWCONTROL_RTSCTS_IN - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Hardware RTS/CTS flow Control on Input

FLOWCONTROL_RTSCTS_OUT - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Hardware RTS/CTS flow Control on Output

FLOWCONTROL_XONXOFF_IN - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Software (XON/XOFF) flow Control on Input

FLOWCONTROL_XONXOFF_OUT - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Software (XON/XOFF) flow Control on Output

focusGained(FocusEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface FocusListener and should not be invoked by the user.

focusLost(FocusEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface FocusListener and should not be invoked by the user.

formCommandWithOptions(boolean) - Method in class com.adventnet.cli.messageset.CommandSet

Flag used either to form command with or withour options.

G

GenericParser - class com.adventnet.util.parser.generic.GenericParser.

This class parses rules based on Token numbers and patterns found in the message to be parsed.

GenericParser() - Constructor for class com.adventnet.util.parser.generic.GenericParser

The default constructor for this class.

getAliveConnectionsCount() - Method in class com.adventnet.cli.CLIResourceManager

Gets the total number of connections that have been established

getBaudRate() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the baud rate configured for the data transfer.

getChildCmdObjectList() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the CmdObject child list.

getCLIClientsSize() - Method in class com.adventnet.cli.CLISession

Gets the count of clients registered for callback or for asynchronous responses.

getCLIClientsSize() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the count of clients that have registered for callback.

getCLIPrompt() - Method in class com.adventnet.cli.CLIMessage

Gets the CLIPrompt for the message.

getCLIPrompt() - Method in class com.adventnet.cli.CLISession

Gets the CLI Prompt for this session.

getCLIPrompt() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the CLI Prompt for this session.

getCLIPromptAction() - Method in class com.adventnet.cli.CLIMessage

Gets the list of prompts and its corresponding commands.

getCLIPromptAction() - Method in class com.adventnet.cli.CLISession

Gets the prompt list.

getCLIPromptAction() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the prompt list.

getCLIProtocolOptions() - Method in class com.adventnet.cli.CLIMessage

Gets the CLIProtocolOptions for this message.

getCLIProtocolOptions() - Method in class com.adventnet.cli.CLISession

Gets the CLIProtocolOptions for this session.

getCLIProtocolOptions() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the CLIProtocolOptions for this session.

getCLITree() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the reference to the CLITree object contained in this bean.

getCmdHelp() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Gets the help of this Command.

getCmdObjectByName(String) - Method in class com.adventnet.cli.messageset.CLIDataInstance

This method returns a CmdObject with the object name given in the argument.

getCmdObjectList() - Method in class com.adventnet.cli.messageset.CLIDataInstance

Gets the command object list.

getCmdObjectList() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Gets the command object list.

getCmdOption() - Method in class com.adventnet.cli.messageset.CLIDataInstance

Gets the command option.

getCmdOptionsList() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Gets the CmdOptions object.

getCmdParamList() - Method in class com.adventnet.cli.messageset.CLIDataInstance

Gets the command param list.

getCmdParams() - Method in class com.adventnet.cli.config.TaskData

Gets the parameters of the command.

getCmdParamsList() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Gets the command param list.

getCommand() - Method in class com.adventnet.cli.config.Task

Gets the command set in the task.

getCommand(String, String) - Method in class com.adventnet.cli.messageset.CommandSet

Gets the command for a given command name and data name.

getCommand(String, String, String) - Method in class com.adventnet.cli.messageset.CommandSet

getCommandDelimiter() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Gets the command Delimiter for the template.

getCommandName() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Gets the command name for the template.

getCommandPrompt() - Method in class com.adventnet.cli.config.LoginLevel

Gets the Prompt.

getCommandSet(CLIMutableTreeNode) - Method in class com.adventnet.cli.beans.tree.CLITree

To get the commandSet for the given CLIMutableTreeNode.

getCommandSetEntries() - Method in class com.adventnet.cli.messageset.CommandSet

Returns a Hashtable of all the commands in the CommandSet.

getCommandSuffix() - Method in class com.adventnet.telnet.TelnetSession

Gets the command Suffix.

getConfigCmdData(String, String) - Method in interface com.adventnet.cli.config.DataInterface

This method will be invoked by the runTask() API.

getConfigData(ConfigObject) - Method in interface com.adventnet.cli.config.DataInterface

This method will be invoked by the runConfiguration() API of ConfigAPI, when no data is given to it.

getConfigID() - Method in class com.adventnet.cli.config.ConfigObject

Gets the unique ID of the configuration.

getConfigList() - Method in class com.adventnet.cli.config.ConfigAPI

Gets the configurations defined in the xml file, along with their tasks.

getConfigScriptData(String, String) - Method in interface com.adventnet.cli.config.DataInterface

This method will be invoked by the runTask() API when a script is to be run.

getConfiguration(String) - Method in class com.adventnet.cli.config.ConfigAPI

Gets the configuration with the name passed to it.

getConfigWithData(String, TaskData[], Object) - Method in class com.adventnet.cli.config.ConfigAPI

This API can be used when 'ready to run' cmd / script is required for a given configuration.

getCurrDataOptions() - Method in class com.adventnet.cli.messageset.CommandSet

This method in internally used by the API and should not be invoked by the user.

getCurrDataParams() - Method in class com.adventnet.cli.messageset.CommandSet

This method in internally used by the API and should not be invoked by the user.

getCurrentLoginLevel() - Method in class com.adventnet.cli.config.ConfigAPI

Gets the loginLevel currently used for the session.

getData() - Method in class com.adventnet.cli.CLIMessage

Gets the CLI message.

getData(String) - Method in class com.adventnet.cli.messageset.DataSet

Gets all the Data Instances for the given Command Name.

getDataBits() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the number of data bits used.

getDataByName(String, String) - Method in class com.adventnet.cli.messageset.DataSet

Gets a particular DataInstance for a given command name and data name.

getDataInterface() - Method in class com.adventnet.cli.config.ConfigObject

Gets the instance of DataInterface implementation class.

getDataName() - Method in class com.adventnet.cli.messageset.CLIDataInstance

Gets the data name.

getDataRequired() - Method in class com.adventnet.cli.config.Task

Gets the value of the DataRequired flag.

getDataSet() - Method in class com.adventnet.cli.messageset.CommandSet

Gets the DataSet for this CommandSet.

getDataSet(CommandSet) - Method in class com.adventnet.cli.beans.tree.CLITree

To get the DataSet of the corresponding CommandSet.

getDataSetEntries() - Method in class com.adventnet.cli.messageset.CommandSet

Returns a Hashtable of all the data set associated with this CommandSet.

getDataSetEntries() - Method in class com.adventnet.cli.messageset.DataSet

Gets the DataSets associated with this CommandSet.

getDebugLevel() - Method in class com.adventnet.cli.CLISession

Gets the debug level.

getDebugLevel() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the debug level.

getDelimiter() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the delimiter of the CLIMutableTreeNode.

getDescription() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the description of the CLIMutableTreeNode.

getDescription() - Method in class com.adventnet.cli.config.ConfigObject

Gets the description for the configuration.

getDescription() - Method in class com.adventnet.cli.config.Task

Gets the description for the task.

getDescription() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the description of this Object.

getEnableOutErr() - Static method in class com.adventnet.cli.util.CLILogMgr

Gets the enableOutErr flag, which is used for directing log messages for the default print stream to files, when set.

getEncoding() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Gets the specified character encoding name.

getExecutionCount() - Method in class com.adventnet.cli.config.Task

Gets the executionCount of the task.

getExecutionIfcClassName() - Method in class com.adventnet.cli.config.ConfigAPI

Gets the name of the ExecutionInterface implementation class.

getExecutionIfcInstance() - Method in class com.adventnet.cli.config.ConfigAPI

Gets the ExecutionInterface implementation class instance.

getExecutionInterface() - Method in class com.adventnet.cli.config.ConfigAPI

Gets the ExecutionInterface implementation instance of the current session in the ConfigAPI.

getFileName() - Method in class com.adventnet.cli.messageset.CommandSet

To get the filename of the xml file being parsed.

getFlowControlMode() - Method in class com.adventnet.cli.serial.SerialCommSession

Gets the flow control mode set.

getFlowControlMode() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the flow control mode set.

getFontSize() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Gets the font size of the Telnet Frame.

getFrameIconImage() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Gets the image to be displayed in the minimized icon for this frame.

getFrameTitle() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Gets the title of the frame.

getHelpExample() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the help example of the CLIMutableTreeNode.

getHelpLocation() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the help file location.

getHelpOptions() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the help options of the CLIMutableTreeNode.

getHelpRelatedCommands() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the help related commands of the CLIMutableTreeNode.

getHelpRemarks() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the help remarks of the CLIMutableTreeNode.

getID() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

This is used to generate a unique id based on a particular connection.

getID() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the Key based on the combination of remoteHost, Port and login name.

getID() - Method in interface com.adventnet.cli.transport.CLIProtocolOptions

This is used to generate a unique id based on a particular connection.

getID() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the Key based on the combination of remoteHost, Port and login name.

getInitialMessage() - Method in class com.adventnet.cli.CLISession

Gets the initial Message sent by the device after a successful connection establishment.

getInitialMessage() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the initial Message sent by the device after a successful connection establishment.

getInitialMessage() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the initial message sent by the device after a connection is established.

getInitialMessage() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the initial message sent by the device after a connection is established.

getInitialMessage() - Method in interface com.adventnet.cli.transport.CLIProtocolOptions

Gets the initial message sent by the device after a connection is established.

getInitialMessage() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the initial message sent by the device after a connection is established.

getInstance() - Static method in class com.adventnet.cli.CLIResourceManager

Gets an instance of the CLIResourceManager.

getInterruptCmd() - Method in class com.adventnet.cli.CLISession

Gets the interrupt command.

getInterruptCmd() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the interrupt command.

getKeepAliveTimeout() - Method in class com.adventnet.cli.CLIResourceManager

Gets the keepAlive timeout in seconds.

getKeepAliveTimeout() - Method in class com.adventnet.cli.CLISession

Gets the keepAlive timeout in seconds.

getKeepAliveTimeout() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the keepAlive time-out in seconds.

getKeepAliveTimeout() - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Gets the keepAlive time-out in seconds.

getLevelExitCmd() - Method in class com.adventnet.cli.config.LoginLevel

Gets the command for exiting the current mode and returning to the parent mode, if any.

getLoginCommand() - Method in class com.adventnet.cli.config.LoginLevel

Gets the command to be sent for entering the loginLevel.

getLoginLevel() - Method in class com.adventnet.cli.config.LoginLevel

Gets the name of the loginLevel of the device.

getLoginLevel() - Method in class com.adventnet.cli.config.ConfigObject

Gets the loginLevel of the configuration.

getLoginLevel() - Method in class com.adventnet.cli.config.Task

Gets the login level of the task.

getLoginLevel(String) - Method in class com.adventnet.cli.config.ConfigAPI

Gets the LoginLevel object with the given name.

getLoginMessage() - Method in class com.adventnet.telnet.TelnetSession

Gets the initial login message after connecting to the device.

getLoginName() - Method in class com.adventnet.cli.config.LoginLevel

Gets the login name (or username) to logon to a level.

getLoginName() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the login Name.

getLoginName() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the login Name.

getLoginName(String) - Method in interface com.adventnet.cli.config.LoginInterface

Returns the login name for the level given.

getLoginPassword() - Method in class com.adventnet.cli.config.LoginLevel

Gets the password to be given for the login level.

getLoginPassword(String) - Method in interface com.adventnet.cli.config.LoginInterface

Returns the password for the login level.

getLoginPrompt() - Method in class com.adventnet.cli.config.LoginLevel

Gets the login prompt.

getLoginPrompt() - Method in class com.adventnet.telnet.TelnetSession

Gets the login prompt.

getLoginPrompt() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the login prompt.

getLoginTimeout() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the login Time-out of the Telnet connection.

getLoginTimeout() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the login timeout of the ssh connection.

getMandatory() - Method in class com.adventnet.cli.config.Task

Gets the mandatory flag.

getMatchList() - Method in class com.adventnet.util.parser.generic.MessageParser

Gets the Parameters extracted from the Response as a Vector of Hashtables.

getMaxConnections() - Method in class com.adventnet.cli.CLIResourceManager

Gets the maximum number of CLI Connections that can exist for any session opened.

getMaxConnections() - Method in class com.adventnet.cli.CLISession

Gets the maximum no of transport Connections (example: telnet, serial) that can exist per ID (where id, is a combination of hostname, port, loginname) for this session.

getMaxConnections() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the maximum no of CLI Connections that can exist for this session.

getMaxConnections() - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Gets the maximum no of CLI Connections that can exist for any session opened.

getMenuBar() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the MenuBar.

getMenuBar() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Gets the MenuBar for this frame.

getMenuFont() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the Menu Font.

getMessageSuffix() - Method in class com.adventnet.cli.CLIMessage

Gets the message suffix for the message.

getMinimumSize() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the minimum size.

getMsgID() - Method in class com.adventnet.cli.CLIMessage

Gets the messageID for this message.

getName() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the name of the CLIMutableTreeNode.

getNoOfXMLFiles() - Method in class com.adventnet.cli.beans.tree.CLITree

To get the number of XML files that have been loaded.

getObjectDelimiter() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the delimiter of this Object.

getObjectName() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the Object Name.

getObjectValue() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the Object Value.

getOptionsList() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the CmdOptions object.

getOptsChar() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the option character of the CLIMutableTreeNode.

getOptsDep() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the option dependency of the CLIMutableTreeNode.

getOptsPrefix() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the option prefix of the CLIMutableTreeNode.

getParamDescription() - Method in class com.adventnet.cli.messageset.CmdParams

Gets the description of this parameter.

getParameterList() - Method in class com.adventnet.cli.messageset.CmdObject

Gets the parameter list for this object.

getParameterValue(CmdObject, String) - Method in class com.adventnet.cli.messageset.CLIDataInstance

This method gets the parameter value for a particular parameter Name for the CmdObject passed in the argument.

getParamName() - Method in class com.adventnet.cli.messageset.CmdParams

Gets the parameter name.

getParamsOfCommand(String) - Method in class com.adventnet.cli.config.ConfigAPI

Gets the parameters present in the command (both optional and compulsory ones).

getParamValue() - Method in class com.adventnet.cli.messageset.CmdParams

Gets the parameter value.

getParamValueType() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Gets the parameter value type.

getParamValueType() - Method in class com.adventnet.cli.messageset.CmdParams

Gets the parameter value type.

getParentLevel() - Method in class com.adventnet.cli.config.LoginLevel

Gets the parent of the current level or mode.

getParity() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the parity.

getPartialData() - Method in class com.adventnet.telnet.TelnetSession

Gets the partialData read.

getPartialResponse() - Method in class com.adventnet.cli.CLIMessage

Gets the partial response flag.

getPasswdPrompt() - Method in class com.adventnet.telnet.TelnetSession

Gets the password prompt.

getPasswdPrompt() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the password prompt.

getPassword() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the login Password.

getPassword() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the login Password.

getPasswordPrompt() - Method in class com.adventnet.cli.config.LoginLevel

Gets the password prompt for the level.

getPortId() - Method in class com.adventnet.cli.serial.SerialCommSession

Gets the portId set.

getPortId() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the PortId value

getPreferredSize() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the preferred size.

getPrompt() - Method in class com.adventnet.telnet.TelnetSession

Gets the prompt that would be issued by the device after completion of a command.

getPrompt() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the Prompt.

getPrompt() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the Prompt.

getPromptList() - Method in class com.adventnet.telnet.TelnetSession

To get the prompt list.

getReadBufferLength() - Method in class com.adventnet.telnet.TelnetSession

Gets the length of read buffer that is used to read the data from the Telnet socket stream.

getReadTimeout() - Method in class com.adventnet.cli.serial.SerialCommSession

Gets the Read Timeout.

getRemoteEOL() - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

When the transport protocol negotiates the protocol version, it uses the EOL provided with the protocol identification string as the guessed EOL setting for the remote computer.

The value returned will be any of the following values:

TransportProtocol.EOL_CRLF
TransportProtocol.EOL_LF

getRemoteHost() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the Remote Host name or IP address.

getRemoteHost() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the Remote Host name or IP address.

getRemotePort() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the Remote Port.

getRemotePort() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the Remote Port.

getRequestQSize() - Method in class com.adventnet.cli.CLISession

Gets the size of the asynchronous request queue.

getRequestTimeout() - Method in class com.adventnet.cli.CLIMessage

Gets the request timeout in milliseconds for this request message.

getRequestTimeout() - Method in class com.adventnet.cli.CLISession

Gets the timeout in milliseconds for this request message.

getRequestTimeout() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the time-out in milliseconds for this request message.

getResourceManager() - Method in class com.adventnet.cli.CLISession

Gets the CLIResourceManager which manages the System Resources.

getResourceManager() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the CLIResourceManager which manages the System Resources.

getResponseTextAreaBGColor() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the Background color of the Response TextArea.

getResponseTextAreaFGColor() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the Foreground color of the Response TextArea.

getResponseTextAreaFont() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the Response TextArea Font.

getResult() - Method in class com.adventnet.util.parser.line.ParsedResult

Gets the Parameter name, value pairs in a Properties object.

getResultOfConfig(String, String[]) - Method in class com.adventnet.cli.config.ConfigAPI

Executes the command and returns the result of the command as a string.

getResultOfTask(String, String, String) - Method in class com.adventnet.cli.config.ConfigAPI

Returns the result after the execution of the command.

getRootNode() - Method in class com.adventnet.cli.beans.tree.CLITree

To get the Root Node of the CLITree.

getRulesFileName() - Method in class com.adventnet.util.parser.generic.MessageParser

Gets the Rule File name.

getRunScriptIfcImpl() - Method in class com.adventnet.util.script.ScriptHandler

Gets the instance of RunScriptInterface implementation class.

getScriptArgs() - Method in class com.adventnet.cli.config.TaskData

Gets the argument for the script.

getScriptName() - Method in class com.adventnet.cli.config.Task

Gets the name of the file containing the script.

getScriptType() - Method in class com.adventnet.cli.config.Task

Gets the name of the scripting language used in the script (like python, beanshell etc.)

getScriptType() - Method in class com.adventnet.util.script.ScriptHandler

Gets the script language of the scriptHandler.

getSelectedNode() - Method in class com.adventnet.cli.beans.tree.CLITree

Gets the selected node of tree in CLIMutableTreeNode form.

getSocketTimeout() - Method in class com.adventnet.telnet.TelnetSession

Gets the time-out for the TelnetSocket.

getSocketTimeout() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Gets the socket time-out.

getSocketTimeout() - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Gets the timeout value for the SSH Socket.

getSshVersion(String, int) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Gets the SSH version of the remote SSH server.

getStopBits() - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Gets the no of Stop bits.

getSubLevels() - Method in class com.adventnet.cli.config.LoginLevel

Gets the sublevels of the current level or mode.

getSyntax() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To get the syntax of the CLIMutableTreeNode.

getSystemWideMaxConnections() - Method in class com.adventnet.cli.CLIResourceManager

Gets the maximum number of connections System Wide that can exist at any given instant.

getSystemWideMaxConnections() - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Gets the maximum no of connections System Wide that can exist at any given instant.

getTableResult() - Method in class com.adventnet.util.parser.line.ParsedResult

Returns the parameter table.

getTaskCmd(String, String, TaskData, Object) - Method in class com.adventnet.cli.config.ConfigAPI

Gets the command for the specified task name.

getTaskList() - Method in class com.adventnet.cli.config.ConfigObject

Gets the list of tasks in the configuration.

getTaskName() - Method in class com.adventnet.cli.config.TaskData

Gets the name of the task.

getTaskName() - Method in class com.adventnet.cli.config.Task

Gets the name of the task.

getTaskOfConfig(String, String) - Method in class com.adventnet.cli.config.ConfigAPI

Gets the task belonging to the given configuration of the ConfigAPI.

getTaskType() - Method in class com.adventnet.cli.config.Task

Gets the type of task.

getTerminalType() - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Gets the current terminal type.

getTerminalType() - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Gets the current terminal type.

getTerminalType() - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Gets the current terminal type.

getToolBar() - Method in class com.adventnet.cli.beans.CLIBrowser

To get the ToolBar.

getTransformationHandlerClassName() - Method in class com.adventnet.cli.terminal.TerminalIOHandler

Gets the class name for the TransformationHandler implementation.

getTransformationTableNames() - Method in interface com.adventnet.cli.terminal.TransformationHandler

This method returns the table names that are present in the Transformation table list.

getTransformationTableNames() - Method in class com.adventnet.cli.terminal.TransformationHandlerImpl

This method returns the table names that are present in the Transformation table list.

getTransformationTableNames() - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method returns the table names that are present in the Transformation table list.

getTranslationHandlerClassName() - Method in class com.adventnet.cli.terminal.TerminalIOHandler

Gets the class name for the TranslationHandler implementation.

getTranslationTableNames() - Method in class com.adventnet.cli.terminal.TranslationHandlerImpl

This method returns the table names that are present in the Translation table list.

getTranslationTableNames() - Method in interface com.adventnet.cli.terminal.TranslationHandler

This method returns the table names that are present in the Translation table list.

getTranslationTableNames() - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method returns the table names that are present in the Translation table list.

getTransportProviderClassName() - Method in class com.adventnet.cli.CLISession

Gets the fully qualified class name of Transport Provider.

getTransportProviderClassName() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the Transport Provider Class name.

getVersion() - Method in class com.adventnet.util.parser.generic.MessageParser

Gets the Message Parser version in the XML.

getWindowSize() - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Return the dimension of the window.

getXMLFile() - Method in class com.adventnet.cli.beans.tree.CLITree

To get all loaded XML file names as a String.

I

init() - Method in class com.adventnet.util.parser.generic.GenericParser

This method is called by the Parser API for initialization.

init() - Method in class com.adventnet.util.parser.line.LineParser

This method is called by the Parser API for initialization.

init() - Method in interface com.adventnet.util.parser.ParserInterface

This method is called by the Parser API for initialization (such as loading of configuration files, etc.).

init(JApplet) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This is used to initialize the applet.

init(Properties) - Method in class com.adventnet.util.script.BeanShellScriptRunnerImpl

A list of properties for the initialization is passed to this method.

init(Properties) - Method in interface com.adventnet.util.script.RunScriptInterface

This method is used to do any initialization (like loading additional modules in the Script interpretor) in the implementation of this interface.

init(Properties) - Method in class com.adventnet.util.script.PythonScriptRunnerImpl

A list of properties for the initialization is passed to this method.

init(String, String) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method loads the transformation & translation handlers and reads the translation/transformation tables from files.

insertTask(String, Task, String) - Method in class com.adventnet.cli.config.ConfigAPI

Adds the task to the existing list of tasks for the specified configuration.

INTEGER - Static variable in class com.adventnet.cli.messageset.CmdParams

Constant for Integer Option type.

InvalidCommandException - exception com.adventnet.cli.messageset.InvalidCommandException.

This class represents an Exception which is thrown whenever an error occurs while parsing the command.

InvalidCommandException() - Constructor for class com.adventnet.cli.messageset.InvalidCommandException

Constructs an InvalidCommandException with no detail message.

InvalidCommandException(String) - Constructor for class com.adventnet.cli.messageset.InvalidCommandException

Constructs an InvalidCommandException with the specified detail message.

inverseTranslate(byte) - Method in class com.adventnet.cli.terminal.TranslationHandlerImpl

This method is called to perform the opposite of translation.

inverseTranslate(byte) - Method in interface com.adventnet.cli.terminal.TranslationHandler

This method is called to perform the opposite of translation.

inverseTranslate(byte) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method is called to perform the opposite of translation.

isConnected() - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Determine if the client is connected.

isDataAvailable() - Method in class com.adventnet.telnet.TelnetSession

isMenuBarVisible() - Method in class com.adventnet.cli.beans.CLIBrowser

To check whether the MenuBar is visible or not.

isOptional() - Method in class com.adventnet.cli.messageset.CmdParams

Indicates whether sending the parameter is optional or mandatory.

isPasswordRequired() - Method in class com.adventnet.cli.config.LoginLevel

Returns true if password prompt exist for the mode.

isPerformPing() - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Gets the perform ping flag.

isSendParam() - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Gets the sendParam boolean value.

isSendParam() - Method in class com.adventnet.cli.messageset.CmdParams

Indicates whether the parameter name should be sent in the command.

isSetCommandEcho() - Method in class com.adventnet.cli.CLIMessage

Gets the command echo flag.

isSetCommandEcho() - Method in class com.adventnet.telnet.TelnetSession

Gets the command echo flag.

isSetDebug() - Static method in class com.adventnet.cli.CLISession

Gets the debug flag.

isSetDebug() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the debug flag.

isSetDebug() - Method in class com.adventnet.telnet.TelnetSession

Gets the debug flag.

isSetDisplayHelpNode() - Method in class com.adventnet.cli.beans.tree.CLITree

Method to check whether Help Node should be displayed or not.

isSetFormCommandWithOptions() - Method in class com.adventnet.cli.messageset.CommandSet

Method to check whether command will be formed with or without options.

isSetIgnoreSpecialCharacters() - Method in class com.adventnet.cli.CLISession

Returns whether the ignoring of special characters is enabled or not.

isSetIgnoreSpecialCharacters() - Method in interface com.adventnet.cli.rmi.CLISession

Returns whether the ignoring of special characters is enabled or not.

isSetPooling() - Method in class com.adventnet.cli.CLIResourceManager

Gets the pooling Flag common to CLI sessions.

isSetPooling() - Method in class com.adventnet.cli.CLISession

Gets the pooling Flag of this Session.

isSetPooling() - Method in interface com.adventnet.cli.rmi.CLISession

Gets the pooling Flag of this Session.

isSetPooling() - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Gets the pooling Flag common to CLI sessions.

isSetPromptEcho() - Method in class com.adventnet.cli.CLIMessage

Gets the prompt echo flag.

isSetPromptEcho() - Method in class com.adventnet.telnet.TelnetSession

Gets the prompt echo flag.

isToolBarVisible() - Method in class com.adventnet.cli.beans.CLIBrowser

To check whether the ToolBar is visible or not.

isUserNameRequired() - Method in class com.adventnet.cli.config.LoginLevel

Returns true is login name is required for the mode or login prompt exists for the mode.

K

keyPressed(KeyEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface KeyListener and should not be invoked by the user.

keyPressed(KeyEvent) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This method is internally used by the API which overrides the method in the Interface KeyListener and should not be invoked by the user.

keyReleased(KeyEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface KeyListener and should not be invoked by the user.

keyReleased(KeyEvent) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This method is internally used by the API which overrides the method in the Interface KeyListener and should not be invoked by the user.

keyTyped(KeyEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface KeyListener and should not be invoked by the user.

keyTyped(KeyEvent) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This method is internally used by the API which overrides the method in the Interface KeyListener and should not be invoked by the user.

L

LineParser - class com.adventnet.util.parser.line.LineParser.

This class parses rules based on Token numbers and patterns found in the message to be parsed.

LineParser() - Constructor for class com.adventnet.util.parser.line.LineParser

The default constructor for the LineParser.

loadCommandSet(String) - Method in class com.adventnet.cli.beans.tree.CLITree

To load the Command Set file as a child node to root node of the tree.

loadConfiguration(String) - Method in class com.adventnet.cli.config.ConfigAPI

This method can be used for dynamically loading a xml file.

loadParserConfig(String) - Method in class com.adventnet.util.parser.ParserAPI

Loads the Rules XML file.

loadScriptProperties(String, Properties) - Method in class com.adventnet.util.script.ScriptHandler

Initializes the scriptType with the given properties.

loadXMLFile(String, String) - Method in class com.adventnet.cli.beans.tree.CLITree

To load the XML file as a child node to the root node of the tree.

login(CLIProtocolOptions) - Method in class com.adventnet.cli.config.ExecutionInterfaceImpl

This is the method used for initially logging into a remoteHost with the CLIProtocolOptions.

login(CLIProtocolOptions) - Method in interface com.adventnet.cli.config.ExecutionInterface

This is the method used for initially logging into a remoteHost with the CLIProtocolOptions.

login(String, String) - Method in class com.adventnet.telnet.TelnetSession

This will log in with device with a particular login name and password.

login(String, String) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Logs into the remote host.

login(String, String) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Logs into the remote host.

login(String, String, String) - Method in interface com.adventnet.cli.transport.ssh.SshTransportProviderInterface

This will log into the device with a particular login name and password.

login(String, String, String) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Logs into the remote host with username and password.

login(String, String, String) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

login(String, String, String) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

LoginException - exception com.adventnet.cli.transport.LoginException.

This class represents an Exception which is thrown whenever login parameters (password, username ) are incorrect.

LoginException() - Constructor for class com.adventnet.cli.transport.LoginException

Constructs a LoginException with no detail message.

LoginException(String) - Constructor for class com.adventnet.cli.transport.LoginException

Constructs a LoginException with the specified detail message.

LoginInterface - interface com.adventnet.cli.config.LoginInterface.

This interface can be implemented by the user when the user wants to get the login name and password for a login level or mode.

LoginLevel - class com.adventnet.cli.config.LoginLevel.

This class represents the mode in which the command or script task is to be executed.

M

main(String[]) - Static method in class com.adventnet.cli.rmi.CLIFactoryImpl

The main method instantiates an CLIFactoryImpl object and registers it with the RMI Registry.

MaxConnectionException - exception com.adventnet.cli.MaxConnectionException.

This class represents an Exception which is thrown whenever the no of CLI Connections exceeds the maximum configured value on the CLISession.

MaxConnectionException() - Constructor for class com.adventnet.cli.MaxConnectionException

Constructs a MaxConnectionsException with no detail message.

MaxConnectionException(String) - Constructor for class com.adventnet.cli.MaxConnectionException

Constructs a MaxConnectionsException with the specified detail message.

MessageParser - class com.adventnet.util.parser.generic.MessageParser.

This class parses a message stream and splits it into String tokens based on Delimiter definitions in an XML File.

MessageParser() - Constructor for class com.adventnet.util.parser.generic.MessageParser

Constructor for the Parser.

MessageParser(String) - Constructor for class com.adventnet.util.parser.generic.MessageParser

Constructor for the Parser.

mouseClicked(MouseEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface MouseListener and should not be invoked by the user.

mouseEntered(MouseEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface MouseListener and should not be invoked by the user.

mouseExited(MouseEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface MouseListener and should not be invoked by the user.

mousePressed(MouseEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface MouseListener and should not be invoked by the user.

mouseReleased(MouseEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface MouseListener and should not be invoked by the user.

O

onChannelData(SshMsgChannelData) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

The response is asynchronously obtained here, which is intimated to the session.

onChannelExtData(SshMsgChannelExtendedData) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

The response for extended data is obtained here.

open() - Method in class com.adventnet.cli.CLISession

Opens the CLI session.

open() - Method in interface com.adventnet.cli.rmi.CLISession

Opens the CLI connection with the remote device based on the CLIProtocolOptions set.

open() - Method in class com.adventnet.cli.serial.SerialCommSession

Opens a Serial Port connection through the port identifier already set using setPortId.

open(CLIProtocolOptions) - Method in class com.adventnet.cli.serial.SerialCommProviderImpl

Opens a connection through the serial port with the device.

open(CLIProtocolOptions) - Method in interface com.adventnet.cli.transport.CLITransportProvider

Opens the transport interface over which the data is sent/received.

open(CLIProtocolOptions) - Method in class com.adventnet.cli.transport.TelnetTransportImpl

Opens a telnet connection to the remote device.

open(CLIProtocolOptions) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Opens a SSH connection to the remote device.

open(CLIProtocolOptions) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Opens a SSH connection to the remote device.

open(CLIProtocolOptions) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Opens a SSH connection to the remote device.

open(String) - Method in class com.adventnet.cli.serial.SerialCommSession

Opens a Serial Port connection through the port identifier specified.

openSession(CLIProtocolOptions) - Method in class com.adventnet.cli.config.ConfigAPI

Opens a CLI Session with the remote host set in the CLIProtocolOptions.

P

PARITY_EVEN - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Even Parity

PARITY_MARK - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Mark Parity

PARITY_NONE - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

No Parity

PARITY_ODD - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Odd Parity

PARITY_SPACE - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

Space Parity

parse(String, String, String) - Method in class com.adventnet.util.parser.ParserAPI

This method does the parsing of the response message and returns the parsed output as any User Object.

ParsedResult - class com.adventnet.util.parser.line.ParsedResult.

This class contains the Result after parsing the message.

ParseException - exception com.adventnet.util.parser.ParseException.

This class represents an Exception which is thrown whenever an error is encountered while Parsing the Rules File (for example, an XML file).

ParseException() - Constructor for class com.adventnet.util.parser.ParseException

Constructs a ParseException with no detail message.

ParseException(String) - Constructor for class com.adventnet.util.parser.ParseException

Constructs a ParseException with the specified detail message.

parseIntoTokens(String) - Method in class com.adventnet.util.parser.generic.MessageParser

Splits the message into tokens based on the Delimiter.

parseMessage(String, String) - Method in class com.adventnet.util.parser.generic.GenericParser

This method is called by the ParserAPI when a Response is to be parsed.

parseMessage(String, String) - Method in class com.adventnet.util.parser.line.LineParser

This method is called by the ParserAPI when a Response is to be parsed.

parseMessage(String, String) - Method in interface com.adventnet.util.parser.ParserInterface

This method is called by the ParserAPI when a Response is to be parsed.

ParserAPI - class com.adventnet.util.parser.ParserAPI.

This class can be used to parse any Response (for example, a response obtained for a CLI Command).

ParserAPI() - Constructor for class com.adventnet.util.parser.ParserAPI

Constructs a ParserAPI instance.

ParserAPI(String) - Constructor for class com.adventnet.util.parser.ParserAPI

Constructs a ParserAPI instance.

ParserInterface - interface com.adventnet.util.parser.ParserInterface.

This interface should be implemented by the user to parse his own Parsing rule structure.

parseRule(String) - Method in class com.adventnet.util.parser.generic.MessageParser

Parses the rule given as a String.

parseRules(String[], String[]) - Method in class com.adventnet.util.parser.generic.GenericParser

This method is called by the ParserAPI when Parsing Rules need to be parsed.

parseRules(String[], String[]) - Method in class com.adventnet.util.parser.line.LineParser

This method is called by the ParserAPI when a Rule needs to be parsed.

parseRules(String[], String[]) - Method in interface com.adventnet.util.parser.ParserInterface

This method is called by the ParserAPI when a Rule needs to be parsed.

PythonScriptRunnerImpl - class com.adventnet.util.script.PythonScriptRunnerImpl.

This is a default implementation of the RunScriptInterface for the scripting language "python".

PythonScriptRunnerImpl() - Constructor for class com.adventnet.util.script.PythonScriptRunnerImpl

Creates a new PythonScriptRunnerImpl instance.

R

read() - Method in class com.adventnet.cli.serial.SerialCommSession

Reads the data over the opened Serial Port connection.

read() - Method in class com.adventnet.cli.serial.SerialCommProviderImpl

Receives the CLI message from the opened Serial Port connection.

read() - Method in interface com.adventnet.cli.transport.CLITransportProvider

Receives CLI Response from the peer over the transport interface.

read() - Method in class com.adventnet.cli.transport.TelnetTransportImpl

Receives the CLI message from the opened telnet connection.

read() - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Receives the CLI message from the opened telnet connection.

read() - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Receives the CLI message from the opened telnet connection.

read() - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Receives the CLI message from the opened telnet connection.

read(byte[]) - Method in interface com.adventnet.cli.transport.ssh.SshTransportProviderInterface

Read data from the socket as byte stream.

read(byte[]) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Reads data from the socket ( as byte stream).

read(byte[]) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Read data from the backend and decrypt it.

read(byte[]) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Read decrypted data from the backend.

readTransformationTables(String) - Method in interface com.adventnet.cli.terminal.TransformationHandler

This method reads the transformation tables (e.g in a XML file or a simple Text file).

readTransformationTables(String) - Method in class com.adventnet.cli.terminal.TransformationHandlerImpl

This method reads the transformation tables (e.g in a XML file or a simple Text file).

readTranslationTables(String) - Method in class com.adventnet.cli.terminal.TranslationHandlerImpl

This method reads the translation tables (e.g in a XML file or a simple Text file).

readTranslationTables(String) - Method in interface com.adventnet.cli.terminal.TranslationHandler

This method reads the translation tables (e.g in a XML file or a simple Text file).

refresh() - Method in class com.adventnet.cli.beans.tree.CLITree

To update the tree display after adding a node or deleting a node.

removeCLIClient(CLIClient) - Method in class com.adventnet.cli.CLISession

Unregisters or removes the CLIClient from the list of clients that have already registered for callback to receive asynchronous responses.

removeCLIClient(CLIClient) - Method in interface com.adventnet.cli.rmi.CLISession

Unregisters or removes the CLIClient from the list of clients that have already registered for callback to receive asynchronous responses.

removeConnectionListener(ConnectionListener) - Method in class com.adventnet.cli.CLISession

Unregisters the listener, if it is registered as a ConnectionListener.

removeConnectionListener(ConnectionListener) - Method in interface com.adventnet.cli.rmi.CLISession

Unregisters the listener, if it is registered as a ConnectionListener.

run() - Method in class com.adventnet.cli.CLISession

run() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This method is internally used by the API which overrides the method in the Interface Runnable and should not be invoked by the user.

runConfiguration(String) - Method in class com.adventnet.cli.config.ConfigAPI

Executes the configuration given to it.

runConfiguration(String, TaskData[]) - Method in class com.adventnet.cli.config.ConfigAPI

Executes the configuration given to it.

runConfiguration(String, TaskData[], Object) - Method in class com.adventnet.cli.config.ConfigAPI

Executes the configuration for the session, whose ID is taken from the third argument of the API.

RunScriptInterface - interface com.adventnet.util.script.RunScriptInterface.

This interface can be used to implement script handling of any Scripting language.

runTask(String, String, TaskData) - Method in class com.adventnet.cli.config.ConfigAPI

Executes the task in a configuration.

runTask(String, String, TaskData, Object) - Method in class com.adventnet.cli.config.ConfigAPI

Executes the task in a configuration.

S

saveChangesToXmlFile() - Method in class com.adventnet.cli.config.ConfigAPI

Saves the changes made to the task or configuration to the xml file.

SCRIPT - Static variable in class com.adventnet.cli.config.Task

A script task.

ScriptHandler - class com.adventnet.util.script.ScriptHandler.

This class can be used to invoke the scripts for any application.

ScriptHandler() - Constructor for class com.adventnet.util.script.ScriptHandler

Creates a new ScriptHandler instance.

ScriptHandler(Properties[]) - Constructor for class com.adventnet.util.script.ScriptHandler

Creates a new ScriptHandler instance.

ScriptHandlerException - exception com.adventnet.util.script.ScriptHandlerException.

This class represents an Exception thrown, if any abnormal condition occurs while running script code, using the interpreter of the scripting language.

ScriptHandlerException() - Constructor for class com.adventnet.util.script.ScriptHandlerException

Creates a new ScriptHandlerException instance.

ScriptHandlerException(String) - Constructor for class com.adventnet.util.script.ScriptHandlerException

Creates a new ScriptHandlerException instance with the specified detail message.

send(CLIMessage) - Method in class com.adventnet.cli.CLISession

Sends the CLIMessage asynchronously.

send(CLIMessage) - Method in interface com.adventnet.cli.rmi.CLISession

Sends the CLIMessage asynchronously.

send(String) - Method in class com.adventnet.telnet.TelnetSession

Sends a command to the remote host.

SerialCommOptionsImpl - class com.adventnet.cli.serial.SerialCommOptionsImpl.

This class provides the Serial Port options implementation of the CLIProtocolOptions Interface.

SerialCommOptionsImpl() - Constructor for class com.adventnet.cli.serial.SerialCommOptionsImpl

This default constructor can be used for setting Serial port parameters for opening a CLISession.

SerialCommProviderImpl - class com.adventnet.cli.serial.SerialCommProviderImpl.

The Serial Port transport implementation for the CLITransportProvider for communicating with the CLI device through Serial Port (or RS232 interface).

SerialCommProviderImpl() - Constructor for class com.adventnet.cli.serial.SerialCommProviderImpl

Creates an Instance of Serial Communications provider.

SerialCommSession - class com.adventnet.cli.serial.SerialCommSession.

This class can be used to establish CLI session with the desired device over Serial port.

SerialCommSession() - Constructor for class com.adventnet.cli.serial.SerialCommSession

Default constructor

SerialCommSession(String) - Constructor for class com.adventnet.cli.serial.SerialCommSession

This creates a SerialCommSession with the portId set.

serialEvent(SerialPortEvent) - Method in class com.adventnet.cli.serial.SerialCommSession

This method is called if any Serial Port Event occurs.

setBaudRate(int) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the baud rate for the data transfer.

setChildCmdObjectList(CmdObject[]) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the CmdObject child list.

setCLIPrompt(String) - Method in class com.adventnet.cli.CLIMessage

Sets the CLIPrompt for the message.

setCLIPrompt(String) - Method in class com.adventnet.cli.CLISession

Sets the CLI Prompt for this session.

setCLIPrompt(String) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the CLI Prompt for this session.

setCLIPromptAction(Properties) - Method in class com.adventnet.cli.CLIMessage

Sets the prompt list.

setCLIPromptAction(Properties) - Method in class com.adventnet.cli.CLISession

Sets the prompt list.

setCLIPromptAction(Properties) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the prompt list.

setCLIProtocolOptions(CLIProtocolOptions) - Method in class com.adventnet.cli.CLIMessage

Sets the CLIProtocolOptions for the message.

setCLIProtocolOptions(CLIProtocolOptions) - Method in class com.adventnet.cli.CLISession

Sets the CLIProtocolOptions for this session.

setCLIProtocolOptions(CLIProtocolOptions) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the CLIProtocolOptions for this session.

setCmdObjectList(CmdObject[]) - Method in class com.adventnet.cli.messageset.CLIDataInstance

Sets the command object list.

setCmdOption(CmdOptions) - Method in class com.adventnet.cli.messageset.CLIDataInstance

Sets the command option.

setCmdParamList(CmdParams[]) - Method in class com.adventnet.cli.messageset.CLIDataInstance

Sets the command param list.

setCmdParams(Properties) - Method in class com.adventnet.cli.config.TaskData

Sets the parameters needed for the execution of the command in the Properties object.

setCommand(String) - Method in class com.adventnet.cli.config.Task

Sets the command of the task.

setCommandEcho(boolean) - Method in class com.adventnet.cli.CLIMessage

Sets the command echo flag to enable/disable the echoing of commands.

setCommandEcho(boolean) - Method in class com.adventnet.telnet.TelnetSession

Sets the command echo flag to enable/disable the echoing of commands.

setCommandPrompt(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the Prompt.

setCommandSet(CLIMutableTreeNode, CommandSet) - Method in class com.adventnet.cli.beans.tree.CLITree

To set the CommandSet for the given CLIMutableTreeNode.

setCommandSuffix(String) - Method in class com.adventnet.telnet.TelnetSession

Sets the command Suffix that will be appended to the command.

setConfigID(String) - Method in class com.adventnet.cli.config.ConfigObject

Sets the unique ID of the configuration.

setCurrentLoginLevel(String) - Method in class com.adventnet.cli.config.ConfigAPI

Sets the current login level as the given name.

setData(byte[]) - Method in class com.adventnet.cli.CLIMessage

Sets the message in byte[] that has to be sent.

setData(String) - Method in class com.adventnet.cli.CLIMessage

Sets the message in String that is to be sent.

setDataBits(int) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the no of data bits for each byte.

setDataInterface(DataInterface) - Method in class com.adventnet.cli.config.ConfigObject

Sets the DataInterface implementation class instance.

setDataInterface(String, DataInterface) - Method in class com.adventnet.cli.config.ConfigAPI

Sets the DataInterface of the given configuration.

setDataName(String) - Method in class com.adventnet.cli.messageset.CLIDataInstance

Sets the Data name.

setDataRequired(boolean) - Method in class com.adventnet.cli.config.Task

Sets the dataRequired flag.

setDataSet(CommandSet, DataSet) - Method in class com.adventnet.cli.beans.tree.CLITree

To set the dataSet corresponding to the CommandSet.

setDataSet(DataSet) - Method in class com.adventnet.cli.messageset.CommandSet

This method sets the DataSet for this CommandSet.

setDebug(boolean) - Method in class com.adventnet.cli.CLISession

Sets the debug flag.

setDebug(boolean) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the debug flag.

setDebug(boolean) - Method in class com.adventnet.telnet.TelnetSession

Sets the debug flag to true.

setDebugLevel(int) - Method in class com.adventnet.cli.CLISession

Sets the debug level.

setDebugLevel(int) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the debug level.

setDebugLevelForLogging(int) - Method in class com.adventnet.cli.util.CLILogMgr

Sets the LogLevel for the messages to be logged into the files.

setDelimiter(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the delimiter of the CLIMutableTreeNode.

setDescription(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the description of the CLIMutableTreeNode.

setDescription(String) - Method in class com.adventnet.cli.config.ConfigObject

Sets the description for the configuration.

setDescription(String) - Method in class com.adventnet.cli.config.Task

Sets the description for the task.

setDescription(String) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the description for this Object.

setEnableOutErr(boolean) - Static method in class com.adventnet.cli.util.CLILogMgr

Enables the logging of default print stream messages to files.

setEncoding(String) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the specified character Encoding.

setExecutionCount(int) - Method in class com.adventnet.cli.config.Task

Sets the executionCount of the task.

setExecutionIfcClassName(String) - Method in class com.adventnet.cli.config.ConfigAPI

Sets the ExecutionInterface implementation classname.

setExecutionInterface(ExecutionInterface) - Method in class com.adventnet.cli.config.ConfigAPI

Sets the Execution Interface implementation instance for the current session.

setFlowControlMode(int) - Method in class com.adventnet.cli.serial.SerialCommSession

Sets the flow control mode.

setFlowControlMode(int) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the flow control mode.

setFontSize(int) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the font size in the telnet frame.

setFrameIconImage(Image) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the image to displayed in the minimized icon for this frame.

setFrameTitle(String) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the title for this frame to the specified string.

setHelpExample(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the help example of the CLIMutableTreeNode.

setHelpLocation(String) - Method in class com.adventnet.cli.beans.CLIBrowser

To set the help file location.

setHelpOptions(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the help options of the CLIMutableTreeNode.

setHelpRelatedCommands(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the help related commands of the CLIMutableTreeNode.

setHelpRemarks(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the help remarks of the CLIMutableTreeNode.

setHostName(String) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the Remote Host name or IP address in dotted format.

setIgnoreSpecialCharacters(boolean) - Method in class com.adventnet.cli.CLISession

Enables stripping of special characters in the response message.

setIgnoreSpecialCharacters(boolean) - Method in interface com.adventnet.cli.rmi.CLISession

Enables stripping of special characters in the response message.

setInitialMessage(String) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the initial message sent by the device after a connection is established.

setInitialMessage(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the initial message sent by the device after a connection is established.

setInitialMessage(String) - Method in interface com.adventnet.cli.transport.CLIProtocolOptions

Sets the initial message sent by the device after a connection is established.

setInitialMessage(String) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the initial message sent by the device after a connection is established.

setInterruptCmd(String) - Method in class com.adventnet.cli.CLISession

Sets the interrupt command.

setInterruptCmd(String) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the interrupt command.

setKeepAliveTimeout(int) - Method in class com.adventnet.cli.CLIResourceManager

Sets the keepAlive timeout in seconds.

setKeepAliveTimeout(int) - Method in class com.adventnet.cli.CLISession

Sets the keepAlive timeout in seconds.

setKeepAliveTimeout(int) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the keepAlive time-out in seconds.

setKeepAliveTimeout(int) - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Sets the Keep Alive time-out in seconds.

setLevelExitCmd(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the command for exiting the current mode.

setLocalEcho(boolean) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Enables the local echo.

setLoginCommand(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the command for the user to logon into the level or mode.

setLoginLevel(LoginLevel) - Method in class com.adventnet.cli.config.ExecutionInterfaceImpl

Sets the loginLevel to be used for logging into a remote device.

setLoginLevel(LoginLevel) - Method in interface com.adventnet.cli.config.ExecutionInterface

Sets the loginLevel to be used for logging into a remote device.

setLoginLevel(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the loginLevel of the device.

setLoginLevel(String) - Method in class com.adventnet.cli.config.ConfigObject

Sets the loginLevel name for a configuration.

setLoginLevel(String) - Method in class com.adventnet.cli.config.Task

Sets the login level of the task.

setLoginName(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the login name (or username) for the level.

setLoginName(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the login Name.

setLoginName(String) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the login Name.

setLoginPassword(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the password to be given for the login level.

setLoginPrompt(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the login prompt.

setLoginPrompt(String) - Method in class com.adventnet.telnet.TelnetSession

Sets the login prompt.

setLoginPrompt(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the login prompt.

setLoginTimeout(int) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the login time-out.

setLoginTimeout(int) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the login timeout.

setMandatory(boolean) - Method in class com.adventnet.cli.config.Task

Sets the mandatory flag.

setMaxConnections(int) - Method in class com.adventnet.cli.CLIResourceManager

Sets the maximum number of CLI Connections that can exist per device for any session opened.

setMaxConnections(int) - Method in class com.adventnet.cli.CLISession

Sets the maximum no of transport connections (example: telnet, serial) that can exist per ID (which is a combination of hostname, port, and loginName) for this session.

setMaxConnections(int) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the maximum no of CLI Connections that can exist for this session.

setMaxConnections(int) - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Sets the maximum no of CLI Connections that can exist per device for any session opened.

setMenuBarVisible(boolean) - Method in class com.adventnet.cli.beans.CLIBrowser

To set the MenuBar visibility.

setMenuFont(Font) - Method in class com.adventnet.cli.beans.CLIBrowser

Sets the Menu Font.

setMessageSuffix(String) - Method in class com.adventnet.cli.CLIMessage

Sets the message suffix for the message.

setMessageTimeout(int) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Sets the timeout for the login or any command sent.

setMsgID(int) - Method in class com.adventnet.cli.CLIMessage

Sets the messageID for this message.

setName(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the name of the CLIMutableTreeNode.

setObjectDelimiter(String) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the delimiter for this object.

setObjectName(String) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the Object Name.

setObjectValue(String) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the Object Value.

setOptionalFlag(boolean) - Method in class com.adventnet.cli.messageset.CmdParams

Sets the optional flag.

setOptionsList(CmdOptions) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the CmdOptions objects associated with the object.

setOptsChar(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the option character of the CLIMutableTreeNode.

setOptsDep(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the option dependency of the CLIMutableTreeNode.

setOptsPrefix(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the option prefix of the CLIMutableTreeNode.

setParamDescription(String) - Method in class com.adventnet.cli.messageset.CmdParams

Sets the description of this parameter.

setParameterList(CmdParams[]) - Method in class com.adventnet.cli.messageset.CmdObject

Sets the parameter list.

setParamName(String) - Method in class com.adventnet.cli.messageset.CmdParams

Sets the parameter name.

setParamValue(String) - Method in class com.adventnet.cli.messageset.CmdParams

Sets the parameter value.

setParamValueType(byte) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Sets the parameter value type.

setParamValueType(byte) - Method in class com.adventnet.cli.messageset.CmdParams

Sets the parameter value type.

setParentLevel(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the parent of the current level.

setParity(int) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the parity type.

setPartialResponse(boolean) - Method in class com.adventnet.cli.CLIMessage

Sets the partial response flag.

setPasswdPrompt(String) - Method in class com.adventnet.telnet.TelnetSession

Sets the password prompt.

setPasswdPrompt(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the password prompt.

setPassword(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the login Password.

setPassword(String) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the login Password.

setPasswordPrompt(String) - Method in class com.adventnet.cli.config.LoginLevel

Sets the password prompt.

setPerformPing(boolean) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the perform ping flag.

setPooling(boolean) - Method in class com.adventnet.cli.CLIResourceManager

Enables/Disables the pooling/sharing of the CLITransport Providers among CLI sessions.

setPooling(boolean) - Method in class com.adventnet.cli.CLISession

Enables/Disables the pooling of CLITransport Sessions.

setPooling(boolean) - Method in interface com.adventnet.cli.rmi.CLISession

Enables/Disables the pooling of CLITransport Sessions.

setPooling(boolean) - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Enables/Disables the pooling of CLITransport Sessions.

setPortId(String) - Method in class com.adventnet.cli.serial.SerialCommSession

Sets the portId through which the session is to be established.

setPortId(String) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the PortId which identifies a particular serial port through which the communication has to be established.

setPortNo(int) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the Remote Port number in which the Telnet Server is running.

setPrompt(String) - Method in class com.adventnet.telnet.TelnetSession

Sets the prompt.

setPrompt(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the Prompt.

setPrompt(String) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the Prompt.

setPromptEcho(boolean) - Method in class com.adventnet.cli.CLIMessage

Sets the prompt echo flag to enable/disable the echoing of prompts.

setPromptEcho(boolean) - Method in class com.adventnet.telnet.TelnetSession

Sets the prompt echo flag to enable/disable the echoing of prompts.

setPromptList(String[]) - Method in class com.adventnet.telnet.TelnetSession

Sets the prompt list.

setReadBufferLength(int) - Method in class com.adventnet.telnet.TelnetSession

Sets the length of read buffer that is used to read the data from the Telnet socket stream.

setReadTimeout(int) - Method in class com.adventnet.cli.serial.SerialCommSession

Sets the Read Timeout.

setRemoteHost(String) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the Remote Host name or IP address in dotted format.

setRemoteHost(String) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the Remote Host name or IP address in dotted format.

setRemotePort(int) - Method in class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Sets the Remote Port.

setRemotePort(int) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the Remote Port.

setRequestQSize(int) - Method in class com.adventnet.cli.CLISession

Sets the size of the asynchronous request queue.

setRequestTimeout(int) - Method in class com.adventnet.cli.CLIMessage

Sets the timeout value in milliseconds for this request message.

setRequestTimeout(int) - Method in class com.adventnet.cli.CLISession

Sets the timeout for this request message.

setRequestTimeout(int) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the time-out for this request message.

setResponseTextAreaBGColor(Color) - Method in class com.adventnet.cli.beans.CLIBrowser

Sets the Response TextArea Background color.

setResponseTextAreaFGColor(Color) - Method in class com.adventnet.cli.beans.CLIBrowser

Sets the Response TextArea Foreground color.

setResponseTextAreaFont(Font) - Method in class com.adventnet.cli.beans.CLIBrowser

Sets the Response TextArea Font.

setResult(Properties) - Method in class com.adventnet.util.parser.line.ParsedResult

Sets the Scalar values (parameter,value) pairs.

setRulesFileName(String) - Method in class com.adventnet.util.parser.generic.MessageParser

Sets the Rule File name.

setRunScriptIfcImpl(RunScriptInterface) - Method in class com.adventnet.util.script.ScriptHandler

Sets the RunScriptInterface implementation class.

setRunScriptIfcImpl(String) - Method in class com.adventnet.util.script.ScriptHandler

Sets the RunScriptInterface implementation class.

setScriptArgs(String[]) - Method in class com.adventnet.cli.config.TaskData

Sets the arguments to be passed to the script, required for its execution.

setScriptName(String) - Method in class com.adventnet.cli.config.Task

Sets the filename containing the script.

setScriptType(String) - Method in class com.adventnet.cli.config.Task

Sets the scripting language of the script (eg: python, beanshell etc.)

setScriptType(String) - Method in class com.adventnet.util.script.ScriptHandler

Sets the script language of the scriptHandler.

setSendParam(boolean) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

Sets the sendParam value.

setSendParam(boolean) - Method in class com.adventnet.cli.messageset.CmdParams

Sets the sendParam value.

setSerialCommParameters(int, int, int, int) - Method in class com.adventnet.cli.serial.SerialCommSession

Sets the various Communication parameters.

setSerialCommParameters(int, int, int, int) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the various Communication parameters.

setSocketTimeout(int) - Method in class com.adventnet.telnet.TelnetSession

Sets the time-out for the TelnetSocket.

setSocketTimeout(int) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Sets the socket time-out.

setSocketTimeout(int) - Method in interface com.adventnet.cli.transport.ssh.SshTransportProviderInterface

Sets the socket timeout.

setSocketTimeout(int) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

sets the socket timeout value.

setSocketTimeout(int) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Sets the time-out for the SSH Socket.

setSocketTimeout(int) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

setStopBits(int) - Method in class com.adventnet.cli.serial.SerialCommOptionsImpl

Sets the no of Stop bits.

setSubLevels(String[]) - Method in class com.adventnet.cli.config.LoginLevel

Sets the sublevels of the current level or mode.

setSyntax(String) - Method in class com.adventnet.cli.beans.tree.CLIMutableTreeNode

To set the syntax of the CLIMutableTreeNode.

setSystemWideMaxConnections(int) - Method in class com.adventnet.cli.CLIResourceManager

Sets the maximum number of connections System Wide that can exist at any given instant of time.

setSystemWideMaxConnections(int) - Method in interface com.adventnet.cli.rmi.CLIResourceManager

Sets the maximum no of connections System Wide that can exist at any given instant.

setTableResult(Hashtable) - Method in class com.adventnet.util.parser.line.ParsedResult

Sets the parameter table which contains the column values.

setTaskList(ArrayList) - Method in class com.adventnet.cli.config.ConfigObject

Sets the list of tasks in the configuration.The tasks can be command or scripts to be run.

setTaskName(String) - Method in class com.adventnet.cli.config.TaskData

Sets the name of the task.

setTaskName(String) - Method in class com.adventnet.cli.config.Task

Sets the name of the task.

setTaskType(int) - Method in class com.adventnet.cli.config.Task

Sets the type of the task.

setTerminalType(String) - Method in class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Sets the terminal type of the remote machine.

setTerminalType(String) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Sets the terminal type of the remote machine.

setTerminalType(String) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Sets the terminal type of the remote machine.

setToolBarVisible(boolean) - Method in class com.adventnet.cli.beans.CLIBrowser

To set the ToolBar visibility.

setTransformationHandlerClassName(String) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

Sets the class name of the TransformationHandler implementation.

setTranslationHandlerClassName(String) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

Sets the class name of the TranslationHandler implementation.

setTransportProviderClassName(String) - Method in class com.adventnet.cli.CLISession

Sets the Transport Provider Class name (the fully qualified class name should be given).

setTransportProviderClassName(String) - Method in interface com.adventnet.cli.rmi.CLISession

Sets the Transport Provider Class name.

setVisible(boolean) - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

Shows or hides this component depending on the value of parameter bl.

SshException - exception com.adventnet.cli.ssh.SshException.

This class represents an Exception thrown when an unexpected error occures when working with SSH.

SshException() - Constructor for class com.adventnet.cli.ssh.SshException

Constructs a SshException with no detail message.

SshException(String) - Constructor for class com.adventnet.cli.ssh.SshException

Constructs a SshException with the specified detail message.

SshJtaProviderImpl - class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl.

This class can be used to establish secure telnet connection with a device using SSH1 protocol.

SshJtaProviderImpl() - Constructor for class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

SshProtocolOptionsImpl - class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl.

This class provides the SSH implementation of the CLIProtocolOptions interface.

SshProtocolOptionsImpl() - Constructor for class com.adventnet.cli.transport.ssh.SshProtocolOptionsImpl

Constructs ProtocolOptions for secure Telnet Connection.

SshToolsProviderImpl - class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl.

This class can be used to establish secure telnet connection with a device using SSH2 protocol.

SshToolsProviderImpl() - Constructor for class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Constructor for the SshToolsProviderImpl object.

SshTransportProviderImpl - class com.adventnet.cli.transport.ssh.SshTransportProviderImpl.

The SSH implementation of the CLITransportProvider for communicating with the remote host using ssh.

SshTransportProviderImpl() - Constructor for class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Creates an instance of ssh provider.

SshTransportProviderInterface - interface com.adventnet.cli.transport.ssh.SshTransportProviderInterface.

This interface was added to augment the CLITransportProvider with methods like connect, login, read, write(byte streams) for connecting and sending byte streams to the remote host.

start() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This should be called when the start method of the applet is called by the browser or applet viewer to inform this applet that it should start its execution.

stop() - Method in class com.adventnet.telnet.telnetwindow.TelnetFrame

This should be called when the stop method of the applet is called by the browser or applet viewer to inform this applet that it should stop its execution.

STOPBITS_1 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

1 Stop Bit

STOPBITS_1_5 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

1/2 Stop Bit

STOPBITS_2 - Static variable in class com.adventnet.cli.serial.SerialCommOptionsImpl

2 Stop Bit

STREAM_CLOSED - Static variable in interface com.adventnet.cli.transport.CLITransportProvider

This constant indicates that the remote peer has abruptly closed the Stream from which the read/write is done.

STRING - Static variable in class com.adventnet.cli.messageset.CmdParams

Constant for String Option type.

syncSend(CLIMessage) - Method in class com.adventnet.cli.CLISession

Sends the CLIMessage synchronously.

syncSend(CLIMessage) - Method in interface com.adventnet.cli.rmi.CLISession

Sends the CLIMessage synchronously.

T

Task - class com.adventnet.cli.config.Task.

This class represents a command or a script task to be executed.

Task() - Constructor for class com.adventnet.cli.config.Task

Creates a new Task instance.

TaskData - class com.adventnet.cli.config.TaskData.

The class is used for representing the data for a task.

TaskData() - Constructor for class com.adventnet.cli.config.TaskData

Creates a new TaskData instance.

TelnetFrame - class com.adventnet.telnet.telnetwindow.TelnetFrame.

This class can be used to start an application that can be used like an ordinary Telnet Client to communicate with remote devices.

TelnetFrame() - Constructor for class com.adventnet.telnet.telnetwindow.TelnetFrame

Constructs a new Frame that is initially invisible.

TelnetFrame(Applet) - Constructor for class com.adventnet.telnet.telnetwindow.TelnetFrame

Constructs a new Frame that is initially invisible by passing an Applet as the argument.

TelnetProtocolOptionsImpl - class com.adventnet.cli.transport.TelnetProtocolOptionsImpl.

This class provides the Telnet implementation of the CLIProtocolOptions interface.

TelnetProtocolOptionsImpl() - Constructor for class com.adventnet.cli.transport.TelnetProtocolOptionsImpl

Constructs ProtocolOptions for Telnet Connections.

TelnetSession - class com.adventnet.telnet.TelnetSession.

This class can be used to establish telnet connections with the desired device.

TelnetSession() - Constructor for class com.adventnet.telnet.TelnetSession

This constructor can be invoked to create a new Telnet Session.

TelnetTransportImpl - class com.adventnet.cli.transport.TelnetTransportImpl.

The telnet implementation of the CLITransportProvider for sending commands through telnet.

TelnetTransportImpl() - Constructor for class com.adventnet.cli.transport.TelnetTransportImpl

Creates an instance of this Telnet provider.

TerminalException - exception com.adventnet.cli.terminal.TerminalException.

This Exception is thrown whenever an error occurs during the loading of the transformation/translation tables or during the transformation/translation operation.

TerminalException() - Constructor for class com.adventnet.cli.terminal.TerminalException

The default constructor

TerminalException(String) - Constructor for class com.adventnet.cli.terminal.TerminalException

The constructor which takes the exception error message

TerminalIOHandler - class com.adventnet.cli.terminal.TerminalIOHandler.

This class can be used to handle Terminal Data.

TerminalIOHandler() - Constructor for class com.adventnet.cli.terminal.TerminalIOHandler

This constructor creates an instance of the TerminalIOHandler.

toString() - Method in class com.adventnet.cli.config.ConfigObject

Returns the ConfigID of the configuration, which is used to identify the configuration.

toString() - Method in class com.adventnet.cli.config.Task

Returns the taskName, which is used as the identifier for the task.

toString() - Method in class com.adventnet.cli.messageset.CmdObject

Method to get the String representation of this object.

toString() - Method in class com.adventnet.cli.messageset.CLICommandTemplate

Method to get the String representation of this object.

toString() - Method in class com.adventnet.cli.messageset.CmdParams

Method to get the String representation of this object.

transform(byte[]) - Method in interface com.adventnet.cli.terminal.TransformationHandler

This method is called to perform the actual transformation.

transform(byte[]) - Method in class com.adventnet.cli.terminal.TransformationHandlerImpl

This method is called to perform the actual transformation.

transform(byte[]) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method is called to perform the actual transformation.

TransformationHandler - interface com.adventnet.cli.terminal.TransformationHandler.

This interface is used for performing Transformation of terminal data.

TransformationHandlerImpl - class com.adventnet.cli.terminal.TransformationHandlerImpl.

This class is the default implementation of the TransformationHandler interface.

TransformationHandlerImpl() - Constructor for class com.adventnet.cli.terminal.TransformationHandlerImpl

Default constructor.

translate(byte) - Method in class com.adventnet.cli.terminal.TranslationHandlerImpl

This method is called to perform the actual translation.

translate(byte) - Method in interface com.adventnet.cli.terminal.TranslationHandler

This method is called to perform the actual translation.

translate(byte) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method is called to perform the actual translation.

TranslationHandler - interface com.adventnet.cli.terminal.TranslationHandler.

This interface is used for performing Translation of terminal data.

TranslationHandlerImpl - class com.adventnet.cli.terminal.TranslationHandlerImpl.

This class is the default implementation for the TranslationHandler interface.

TranslationHandlerImpl() - Constructor for class com.adventnet.cli.terminal.TranslationHandlerImpl

Default Constructor.

U

unloadCommandSet(String) - Method in class com.adventnet.cli.beans.tree.CLITree

To unload the specified xml file from tree.

unloadXMLFile(String) - Method in class com.adventnet.cli.beans.tree.CLITree

To unload the specified XML file from tree.

useTransformationTable(String) - Method in interface com.adventnet.cli.terminal.TransformationHandler

This method sets the Transformation Table to use among the different tables read.

useTransformationTable(String) - Method in class com.adventnet.cli.terminal.TransformationHandlerImpl

This method sets the Transformation Table to use among the different tables read.

useTransformationTable(String) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method sets the Transformation Table to use among the different tables read.

useTranslationTable(String) - Method in class com.adventnet.cli.terminal.TranslationHandlerImpl

This method sets the Translation Table to use among the different tables read.

useTranslationTable(String) - Method in interface com.adventnet.cli.terminal.TranslationHandler

This method sets the Translation Table to use among the different tables read.

useTranslationTable(String) - Method in class com.adventnet.cli.terminal.TerminalIOHandler

This method sets the Translation Table to use among the different tables read.

V

valueChanged(TreeSelectionEvent) - Method in class com.adventnet.cli.beans.CLIBrowser

This method is internally used by the API which overrides the method in the Interface TreeSelectionListener and should not be invoked by the user.

W

waitfor(String) - Method in class com.adventnet.telnet.TelnetSession

Waits for a string to come from the remote host and returns all those characters which are received until that happens (including the string being waited for).

waitfor(String) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Waits for a string to be returned by the remote host and returns all those characters which are received until the match is obtained.

waitfor(String) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Waits for a string to be returned by the remote host and returns all those characters which are received until the match is obtained (including the string being waited for).

waitfor(String[]) - Method in class com.adventnet.telnet.TelnetSession

Waits for strings to come from the remote host and returns all those characters which are received until that happens (including the string being waited for).

waitfor(String[]) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Waits for a string to be returned by the remote host and returns all those characters which are received until the match is obtained.

write(byte[]) - Method in class com.adventnet.cli.serial.SerialCommSession

Writes the data over the opened Serial Port connection.

write(byte[]) - Method in interface com.adventnet.cli.transport.ssh.SshTransportProviderInterface

Writes byte stream to the socket.

write(byte[]) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Sends command or byte stream to the remote host.

write(byte[]) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Sends data in the form of byte streams to the device.

write(byte[]) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Sends the data to the device after encrypting it.

write(CLIMessage) - Method in class com.adventnet.cli.serial.SerialCommProviderImpl

Sends the command in the CLIMessage using the opened Serial Port connection.

write(CLIMessage) - Method in interface com.adventnet.cli.transport.CLITransportProvider

Sends CLI Message to the peer over the transport interface.

write(CLIMessage) - Method in class com.adventnet.cli.transport.TelnetTransportImpl

Sends the command in the CLIMessage using the opened telnet connection.

write(CLIMessage) - Method in class com.adventnet.cli.transport.ssh.SshTransportProviderImpl

Sends the command in the CLIMessage.

write(CLIMessage) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Sends the command in the CLIMessage.

write(CLIMessage) - Method in class com.adventnet.cli.transport.ssh.sshv2.SshToolsProviderImpl

Sends the command in the CLIMessage.

write(String) - Method in class com.adventnet.cli.transport.ssh.sshv1.SshJtaProviderImpl

Sends the data to the device after encrypting it.

writeToFile(String) - Method in class com.adventnet.cli.messageset.CommandSet

Writes the CommandSet as an XML file.

writeToFile(String) - Method in class com.adventnet.cli.messageset.DataSet

Writes the contents of this DatSet into a file in XML format.

A B C D E F G I K L M O P R S T U V W