WebNMS 5 API Specification: Index

Overview

Package

Class

Tree

Deprecated

Index

Help

WebNMS 5 API Specification

PREV NEXT

FRAMES NO FRAMES

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

A

addMSCallbackListener(MSCallbackListener) - Method in interface com.adventnet.management.ProtocolProvider: This method is used by the ManagemntServer implementing MSCallbackListener to register for being notified each time the ProtocolProvider gets a response.
addMSConnectionListener(MSConnectionListener) - Method in interface com.adventnet.management.ProtocolProvider: This method is used by the ManagemntServer implementing MSConnectionListener to register for being notified each time the connection between the device and ManagementServer goes DOWN .
addMSNotifyListener(MSNotifyListener) - Method in interface com.adventnet.management.ProtocolProvider: This method is used by the ManagemntServer implementing MSNotifyListener to register for being notified each time the ProtocolProvider gets an Event PDU.
addSubProperty(String, String, String, ArrayList) - Method in class com.adventnet.management.tl1.TL1Property: This method is internally used by the API, and it should not be invoked by the user.
addSubProperty(String, String, String, ArrayList) - Method in class com.adventnet.management.snmp.SnmpProperty: This method can be used to to combine several request Property(s) into a single request Property.
addSubProperty(String, String, String, ArrayList) - Method in class com.adventnet.management.Property: This method must be implemented by extented Property class to combine several request Property(s) into a single request Property.
ASCII_MODE - Static variable in class com.adventnet.management.ftp.FTPProperty: Identifier that defines the mode of file transfer is ASCII.
ASYNC_COMM - Static variable in interface com.adventnet.management.ProtocolProvider: This is the constant used to specify asynchronous communication mode between ProtocolProvider and Device agent .

B

BINARY_MODE - Static variable in class com.adventnet.management.ftp.FTPProperty: Identifier that defines the mode of file transfer is Binary.

C

callback(ManagementServerResultEvent) - Method in interface com.adventnet.management.MSCallbackListener: This method will be used by the ManagementServer to get the responses recieved by the Provider .
checkResponse(int) - Method in interface com.adventnet.management.ManagementServices: To check if response has been received for the given request id.
checkResponses() - Method in interface com.adventnet.management.ProtocolProvider: This will return the array of request ids of the responses received by the Protocol Provider from the device agent.
checkResponses() - Method in interface com.adventnet.management.ManagementServices: To return request id of all the responses received.
ClientProperty - class com.adventnet.management.client.ClientProperty.: This is a generic implementation of Property .
ClientProperty() - Constructor for class com.adventnet.management.client.ClientProperty: This is constructor of this class used in applications.
CLIProperty - class com.adventnet.management.cli.CLIProperty.: This is the implementation of com.adventnet.management.Property for CLI protocol.
CLIProperty() - Constructor for class com.adventnet.management.cli.CLIProperty: Creates an instance of CLIProperty setting the Protocol type field to 'CLI'.
close() - Method in interface com.adventnet.management.ProtocolProvider: Close all the resources used by the ProtocolProvider .
com.adventnet.management - package com.adventnet.management: WebNMS Management Server providesAPIs for building protocol independent management applications.
com.adventnet.management.cli - package com.adventnet.management.cli: This package contains the CLI protocol provider specific classes used for making CLI sessions through the Management Server.
com.adventnet.management.client - package com.adventnet.management.client: This package contain utility classes for the client applications.
com.adventnet.management.client.xml - package com.adventnet.management.client.xml: This package contain utility classes for the client applications.
com.adventnet.management.corba - package com.adventnet.management.corba: This package implements Corba Provider and property functionality to use Management Server.
com.adventnet.management.ftp - package com.adventnet.management.ftp
com.adventnet.management.snmp - package com.adventnet.management.snmp: This package implements SNMP provier and property functionality to use Management Server.
com.adventnet.management.tftp - package com.adventnet.management.tftp: This package contains classes that are used for transferring of files through the TFTP protocol.
com.adventnet.management.tl1 - package com.adventnet.management.tl1: This package implements TL1 provier and property functionality to use Management Server.
combineSend(Property[]) - Method in interface com.adventnet.management.ProtocolProvider: This method should convert the list of generic request Property(s) into a single PDU for the corresponding protocol and send it to the device agent via the Protocol API .
copy(Event) - Method in class com.adventnet.management.tl1.TL1Event: This method will copy the given event properties values in current object
copy(Event) - Method in class com.adventnet.management.snmp.SnmpEvent: This method is not implemented by the SnmpEvent.
copy(Event) - Method in class com.adventnet.management.Event: This will copy the values in the Event object given as argument into current object.
copy(Property) - Method in class com.adventnet.management.cli.CLIProperty: Copy the property value to this instance.
copy(Property) - Method in class com.adventnet.management.tl1.TL1Property: This method will copy the values from the given property to this current instance.
copy(Property) - Method in class com.adventnet.management.snmp.SnmpProperty: Copy the property value to this instance.
copy(Property) - Method in class com.adventnet.management.corba.CorbaProperty
copy(Property) - Method in class com.adventnet.management.Property: This will copy the attributes of the given Property instance into curent instance.
copy(Property) - Method in class com.adventnet.management.client.ClientProperty: Currently this method is just a dummy implementation .
copy(Property) - Method in class com.adventnet.management.ftp.FTPProperty
copy(Property) - Method in class com.adventnet.management.tftp.TftpProperty: Copy the property value to this instance.
CorbaProperty - class com.adventnet.management.corba.CorbaProperty.: This is the implementation of com.adventnet.management.Property for CORBA.
CorbaProperty() - Constructor for class com.adventnet.management.corba.CorbaProperty: Denotes the default constructor.
CRITICAL_ALARM - Static variable in class com.adventnet.management.tl1.TL1Event: Constant for crtical alarm.

D

DeviceConnectionListener - interface com.adventnet.management.DeviceConnectionListener.: This is the interface to be implemented by the user application to recieve a notification when an established device connection goes down .

E

establishSession(Property) - Method in interface com.adventnet.management.ProtocolProvider: Establish session for communication with device based on the parameters in the request Property .
establishSession(Property) - Method in interface com.adventnet.management.ManagementServices: Used to establish a session with the device agent.
Event - class com.adventnet.management.Event.: This class defines the generic Event object used in the ManagementServer framework.
Event() - Constructor for class com.adventnet.management.Event
ExceptionListener - interface com.adventnet.management.ExceptionListener.: This is the interface to be implemented to by the client user application to recieve unhandled Exceptions in the Management Server.
The application submitting any Property request with the ManagementServices or MangementClient should set the object implementing this interface using,
Property.setComponent(Object)

F

Filter - class com.adventnet.management.Filter.: This is an abstract class that should be implemented for writing protocol specific filters that can be used for filtering the result object.
Filter() - Constructor for class com.adventnet.management.Filter
filterEvent(Object) - Method in interface com.adventnet.management.MSEventFilter: This class should be implemented by the ProtocolProvider for converting the protocol specific event PDU recieved by the ProtocolProvider from the Device agent into the generic event object, Event.
filterProperties(Object, Vector) - Method in interface com.adventnet.management.ProtocolProvider: This method will be called by the ManagementServer to filter only the event request Property(s) which match the event PDU recieved by the ProtocolProvider.
firstRowCntVal - Variable in class com.adventnet.management.client.xml.MCTableResult: The field represent the first row in the device table that is provided in this updation.
FTPProperty - class com.adventnet.management.ftp.FTPProperty.: This FTPProperty class encapsulates information needed for file tranfer operation using FTP protocol.
FTPProperty() - Constructor for class com.adventnet.management.ftp.FTPProperty: Constructs the empty FTPProperty object.

G

genReqID() - Method in interface com.adventnet.management.ProtocolProvider: This will generate a unique request id for the request to be sent through this provider.
GET_COMMAND - Static variable in class com.adventnet.management.ftp.FTPProperty: Identifier that defines the command is get.
getAccessId() - Method in class com.adventnet.management.tl1.TL1Property: To get the Access Id which is set.
getAttemptComplete() - Method in class com.adventnet.management.snmp.SnmpProperty: Returns "true" if the Splitting of PDU is enabled.
getAuthPassword() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the auth password as string in v3 requests.
getAuthProtocol() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the auth protocol as a string in v3 requests.
getBinaryMode() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the mode of file transfer.
getBinaryModeList() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the list of modes(s) corresponding to each & every command returned in the getCommandList API.
getCategory() - Method in class com.adventnet.management.Event: Get the category of the event, like Threshold event etc.
getCombinedPropKey() - Method in class com.adventnet.management.cli.CLIProperty: This method is not being used in CLI protocol.
getCombinedPropKey() - Method in class com.adventnet.management.tl1.TL1Property: This method is internally used by the API, and it should not be invoked by the user.
getCombinedPropKey() - Method in class com.adventnet.management.snmp.SnmpProperty: This method is internally used by the ManagementServer and should not be used.
getCombinedPropKey() - Method in class com.adventnet.management.corba.CorbaProperty
getCombinedPropKey() - Method in class com.adventnet.management.Property: Used by management server to support multiple ProtocolProperty(s) to be combined and send as single protocol PDU.
getCombinedPropKey() - Method in class com.adventnet.management.client.ClientProperty: Currently this method is just a dummy implementation .
getCombinedPropKey() - Method in class com.adventnet.management.ftp.FTPProperty
getCombinedPropKey() - Method in class com.adventnet.management.tftp.TftpProperty: Not applicable for TFTP.
getCommand() - Method in class com.adventnet.management.cli.CLIProperty: Getter for Command.
getCommand() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the TFTP command to be executed.
getCommandCode() - Method in class com.adventnet.management.tl1.TL1Property: Get the command code in the Input message.
getCommandList() - Method in class com.adventnet.management.cli.CLIProperty: Gets the list of commands to be executed on the Device.
getCommandList() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the array of commands.
getCommandList() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the list of commands that are to be executed on the device.
getCommunicationMode() - Method in interface com.adventnet.management.ProtocolProvider: Gets the the request response transaction mode between ProtocolProvider and device agent (asynchronous or synchronous) .
getCommunity() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the community as string.
getComponent() - Method in class com.adventnet.management.Property: The ManagementServices uses this method to get the Object reference of applications to submit the respective responses and events.
getConnectionHandler() - Method in class com.adventnet.management.tl1.TL1Property: To get the ConnectionHandler implementation Filename.
getConnectionListener() - Method in class com.adventnet.management.tl1.TL1Property: To get the ConnectionListener implementation Filename.
getContextID() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the contextid.
getContextName() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the context name that was set using setContextName
getDBPassword() - Method in class com.adventnet.management.snmp.SnmpProperty: To get Database Param Password.
getDBUserName() - Method in class com.adventnet.management.snmp.SnmpProperty: To get Database Param UserName.
getDestinationFileList() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the list of destination file names specified for the file transfer operation.
getDestinationFileList() - Method in class com.adventnet.management.tftp.TftpProperty: Returns a list of file names to which file contents need to be saved.
getDestinationFileName() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the file name to which file contents need to be saved.
getDomain() - Method in class com.adventnet.management.Event: Get the domain name of the Agent which generates this event.
getDriverName() - Method in class com.adventnet.management.snmp.SnmpProperty: To get Database Param DriverName.
getDummyProperty() - Method in class com.adventnet.management.snmp.SnmpProperty: Returns dummyproperty.
getEnterprise() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the Enterprise oid that was set using the method setEnterprise.
getEntity() - Method in class com.adventnet.management.Event: Get the Entity (also known as Failure Object) of the Event.
getErrObject() - Method in class com.adventnet.management.ManagementServerResultEvent: This will return the error object
getErrorString(byte) - Method in interface com.adventnet.management.ProtocolProvider: This method should convert protocol specific error status to a readable string message.
getErrStat() - Method in class com.adventnet.management.ManagementServerResultEvent: This will return the error status as a byte.
getErrString() - Method in class com.adventnet.management.ManagementServerResultEvent: To get the error message as an instance of string.
getEventKey() - Method in class com.adventnet.management.cli.CLIProperty: This method will return the sessionId as the key for the event generated.
getEventKey() - Method in class com.adventnet.management.tl1.TL1Property: This method is internally used by the API, and it should not be invoked by the user.
getEventKey() - Method in class com.adventnet.management.snmp.SnmpProperty: This method is internally used by the ManagementServer and should not be used.
getEventKey() - Method in class com.adventnet.management.corba.CorbaProperty
getEventKey() - Method in class com.adventnet.management.Property: Used by the management server to support caching of event registrations.
getEventKey() - Method in class com.adventnet.management.client.ClientProperty: Currently this method is just a dummy implementation .
getEventKey() - Method in class com.adventnet.management.ftp.FTPProperty
getEventKey() - Method in class com.adventnet.management.tftp.TftpProperty: Not applicable for TFTP.
getFilterClass() - Method in class com.adventnet.management.Property: This is used by user client applications to get the name of the Class used for filtering the responses recieved from the ProtocolProvider before being given to the application.
getFilteredObject(Property, Object, String) - Method in class com.adventnet.management.Filter: Abstract method that will be called while applying filter.
getFilterParameters() - Method in class com.adventnet.management.Property: This method is used to get the parameters to be passed as argument to the getFilteredObject method of the Filter class.
getGeneralBlock() - Method in class com.adventnet.management.tl1.TL1Property: To get the general block which is set.
getGenericType() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the Trap Generic type that was set using the method setGenericType.
getGroupName() - Method in class com.adventnet.management.Property: Get the groupname by which the default properties will be loaded from config file.
getIndex() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the Table index.
getInstance(Applet, int) - Static method in class com.adventnet.management.ManagementServicesAPI: Get the instance of ManagementServices implementation for applet.
getInstance(String[], int) - Static method in class com.adventnet.management.ManagementServicesAPI: Get the instance of ManagementServices implementation for application.
getInterfaceName() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of interfaceName.
getInterPacketDelay() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the delay time between requests in milliseconds set using the setInterPacketDelay.
getInvokeObject() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of invokeObject.
getLabel() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of label.
getLocalPort() - Method in class com.adventnet.management.snmp.SnmpProperty: Get the local port as string.
getLoginName() - Method in class com.adventnet.management.cli.CLIProperty: Getter for LoginName.
getLoginPrompt() - Method in class com.adventnet.management.cli.CLIProperty: Getter for Login Prompt.
getManagementServicesMode() - Static method in class com.adventnet.management.ManagementServicesAPI: This method is used to Get the ManagementServices Mode.
getMaxRepetitions() - Method in class com.adventnet.management.snmp.SnmpProperty: Get the max-repetitions for get bulk operation as string.
getMessagePayloadBlock() - Method in class com.adventnet.management.tl1.TL1Property: To get the Message Payload block which is set.
getMethodName() - Method in class com.adventnet.management.Property: This is used to get the name of the method which gets the result for request response transactions .
getMethodParameterClassNames() - Method in class com.adventnet.management.Property: Returns the class names of the parameters of the method which gets the result for request response transactions .
getMethodParameterValues() - Method in class com.adventnet.management.Property: Return the values of the parameters to be passed to the method which gets the result for request response transactions .
getMethodResultParameterIndex() - Method in class com.adventnet.management.Property: This is used to get the index of the method parameters for the method which gets the result for request response transactions .
getMibsToBeLoaded() - Method in class com.adventnet.management.snmp.SnmpProperty: Get the mib file names to be loaded.
getMibToBeUnLoaded() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the mib file name to be unloaded.
getModeList() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the array of mode for the file transfer operation.
getNameReference() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of nameReference.
getNetwork() - Method in class com.adventnet.management.Event: Get the Network in which the event is generated.
getNode() - Method in class com.adventnet.management.Event: Get the Node field of the Event generated.
getNonRepeaters() - Method in class com.adventnet.management.snmp.SnmpProperty: Get the non-repeaters for get bulk operation as string.
getNumericResult() - Method in class com.adventnet.management.ManagementServerResultEvent: This will return the result in numeric type.
getObject() - Method in class com.adventnet.management.Event: Get the object associated with the Event.
getObjectID() - Method in class com.adventnet.management.snmp.SnmpProperty: Get the object id.
getObjectIDList() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the object id list.
getOperationType() - Method in class com.adventnet.management.Property: Return the type of the command which will specify whether the request is to read or write.
getORBClassName() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of ORBClassName.
getORBInitialHost() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of ORBInitialHost.
getORBInitialPort() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of ORBInitialPort.
getORBService() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of ORBService.
getPartialSet() - Method in class com.adventnet.management.snmp.SnmpProperty: Returns true if partial SET is enabled.
getPassword() - Method in class com.adventnet.management.cli.CLIProperty: Getter for Password.
getPassword() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the password of the user account.
getPasswordPrompt() - Method in class com.adventnet.management.cli.CLIProperty: Getter for Password Prompt.
getPollInterval() - Method in class com.adventnet.management.Property: This is used to get the polling interval(in milliseconds) used for poll registration.
getPrivPassword() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the privpassword as string in v3 requests.
getPromptAction() - Method in class com.adventnet.management.cli.CLIProperty: Gets the prompt and its corresponding action.
getPromptList() - Method in class com.adventnet.management.cli.CLIProperty: Gets the Prompt list.
getProperties() - Method in class com.adventnet.management.cli.CLIProperty: This method will return a Hashtable which will have the property values with the corresponding keys.
getProperties() - Method in class com.adventnet.management.tl1.TL1Property: This method will return a Hashtable which will have the property values with the corresponding keys.
getProperties() - Method in class com.adventnet.management.tl1.TL1Event: This method returns the properties of the TL1Event Object.
getProperties() - Method in class com.adventnet.management.snmp.SnmpProperty: This method will return a Hashtable which will have the property values with the corresponding keys.
getProperties() - Method in class com.adventnet.management.snmp.SnmpEvent: This method returns the various properties of this event.
getProperties() - Method in class com.adventnet.management.corba.CorbaProperty: This method will return a Hashtable which will have the property values with the corresponding keys.
getProperties() - Method in class com.adventnet.management.Property: This method will be used to get the values of the parameters in the Property .
getProperties() - Method in class com.adventnet.management.Event: This method returns the values of all the fields in this event object as a key,value pair in a java.util.Properties object.
getProperties() - Method in class com.adventnet.management.client.ClientProperty: This is the implementaion of Property.getProperties()
getProperties() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the ftp properties as a Hashtable object.
getProperties() - Method in class com.adventnet.management.tftp.TftpProperty: Return a Hashtable having the property values with the corresponding keys.
getPropertiesList() - Method in class com.adventnet.management.tl1.TL1Property: To get the properties list set using setPropertiesList(..)
getProperty() - Method in class com.adventnet.management.Event: Get the Property registered for this Notification.
getPropertyType() - Method in class com.adventnet.management.Property: Get the type name of the Property.
getProtocolPDU() - Method in class com.adventnet.management.Property: This method is implemented by the extented Property class to return a protocol PDU for request Property .
getRemoteHost() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the Remote host that was set using the method setRemoteHost.
getRemoteHostList() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the remotehost list set on this SnmpProperty instance.
getRequestID() - Method in class com.adventnet.management.Property: This method is used to get the requestId of a Property which is unique for each transaction between the ManagementServer and the ProtocolProvider.
getRequestID() - Method in class com.adventnet.management.ManagementServerResultEvent: This will return the reqid id of the ManagementServerResultEvent.
getResponseMessageIdentifiers() - Method in class com.adventnet.management.tl1.TL1Property: This method is internally used by the API, and it should not be invoked by the user.
getResult() - Method in class com.adventnet.management.ManagementServerResultEvent: This will return the result value as Object that may be Integer or Long or String Object.
getResultType() - Method in class com.adventnet.management.Property: This method is used by applications to get the Class type of result which is returned to the user client aplications in Request Response transactions.
getRetries() - Method in class com.adventnet.management.Property: This is used to get the number of retries specified for this Property.
getSendPDUByGroup() - Method in class com.adventnet.management.snmp.SnmpProperty: This method is not implemented by the SnmpProperty and should not be used.
getSessionId() - Method in class com.adventnet.management.cli.CLIProperty: Gets the sessionId that has been set by the user.
getSessionId() - Method in class com.adventnet.management.Property: Get the Session Id of the request Property.
getSessionKey() - Method in class com.adventnet.management.cli.CLIProperty: Returns the session key associated with a particular cli property.
getSessionKey() - Method in class com.adventnet.management.tl1.TL1Property: This method is internally used by the API, and it should not be invoked by the user.
getSessionKey() - Method in class com.adventnet.management.snmp.SnmpProperty: This method is internally used by the ManagementServer and should not be used.
getSessionKey() - Method in class com.adventnet.management.corba.CorbaProperty
getSessionKey() - Method in class com.adventnet.management.Property: Used by the management server to support device connection pooling.
getSessionKey() - Method in class com.adventnet.management.client.ClientProperty: Currently this method is just a dummy implementation .
getSessionKey() - Method in class com.adventnet.management.ftp.FTPProperty
getSessionKey() - Method in class com.adventnet.management.tftp.TftpProperty: Not applicable for TFTP.
getSeverity() - Method in class com.adventnet.management.Event: Get the Severity of the Event object.
getShareSessions() - Method in interface com.adventnet.management.ProtocolProvider: This method gets the mode whether the sessions towards the same devices are shared among Management clients for connection oriented protocols.
getShellPrompt() - Method in class com.adventnet.management.cli.CLIProperty: Getter for Shell Prompt.
getSourceFileList() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the source file names list specified for the file transfer operation.
getSourceFileList() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the list of source file name(s) corresponding to each & every command returned in the getCommandList API.
getSourceFileName() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the source file name that has been assigned with the corresponding set method.
getSpecificType() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the Specific type that was set using the method setSpecificType.
getStringResult() - Method in class com.adventnet.management.ManagementServerResultEvent: This will return the result in string type.
getSuccessCode() - Method in class com.adventnet.management.ManagementServerResultEvent: This method will get the success code of a particular response.
getTableOID() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the object id of the Table.
getTargetHost() - Method in class com.adventnet.management.cli.CLIProperty: Gets the target host.
getTargetHost() - Method in class com.adventnet.management.tl1.TL1Property: To get the target host name which is set.
getTargetHost() - Method in class com.adventnet.management.snmp.SnmpProperty: Get the target host.
getTargetHost() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the ftp target host name.
getTargetHost() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the name of the host where the file is to be transferred.
getTargetId() - Method in class com.adventnet.management.tl1.TL1Property: To get the Target Id which is set.
getTargetPort() - Method in class com.adventnet.management.cli.CLIProperty: Getter for the Target port.
getTargetPort() - Method in class com.adventnet.management.tl1.TL1Property: To get the target port number which is set.
getTargetPort() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the target port as string.
getTargetPort() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the port of the ftp device.
getTargetPort() - Method in class com.adventnet.management.tftp.TftpProperty: Returns the target port.
getText() - Method in class com.adventnet.management.Event: Get the descriptive text message of the event.
getTime() - Method in class com.adventnet.management.Event: Get the time of occurrence (creation), in milliseconds, of this Event object.
getTimeout() - Method in class com.adventnet.management.Property: This method is used to get the timeout value (in milliseconds) of this Property.
getURL() - Method in class com.adventnet.management.snmp.SnmpProperty: To get Database Param URL.
getURL() - Method in class com.adventnet.management.client.ClientProperty: This is used to get the URL location of the XML file from which request Property(s) are to be constructed by the ManagementServer.
getUserName() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the principal on whose behalf SNMPv3 requests are made.
getUserName() - Method in class com.adventnet.management.ftp.FTPProperty: Returns the name of the user account specified in the ftp device.
getUserProperties() - Method in class com.adventnet.management.Property: The method returns all the user properties set in this Property object as a key,value pair in a java.lang.Properties object.
getUserProperties() - Method in class com.adventnet.management.Event: The method returns all the user properties set in this event object as a key,value pair in a java.lang.Properties object.
getUserProperty(String) - Method in class com.adventnet.management.Property: The method returns the value of user property present matching the name passed as argument.
getUserProperty(String) - Method in class com.adventnet.management.Event: The method returns the value of user property present matching the name passed as argument.
getV3ConfigTable() - Method in class com.adventnet.management.snmp.SnmpProperty: Sets the configured tableName specified in the case of V3Database.
getV3DatabaseFlag() - Method in class com.adventnet.management.snmp.SnmpProperty: To check whether V3 database flag is set or not
getVarBindCount() - Method in class com.adventnet.management.snmp.SnmpProperty: Returns the number of varbinds used with the splitted pdu.
getVersion() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the version of SNMP agent in string format.
getWriteCommunity() - Method in class com.adventnet.management.snmp.SnmpProperty: Gets the write community as string.
getWriteType() - Method in class com.adventnet.management.Property: Return the Class type of the value for the OP_WRITE operation.
getWriteTypes() - Method in class com.adventnet.management.Property: Return the class types of the set of values to be set for the OP_WRITE operation.
getWriteValue() - Method in class com.adventnet.management.Property: This is used to get the value specified for a OP_WRITE operation in a Property request .
getWriteValues() - Method in class com.adventnet.management.Property: This is used to get the values specified for a OP_WRITE operation in a Property request .
getXMLDoc() - Method in class com.adventnet.management.corba.CorbaProperty: Get the value of XMLDoc.




I

initJdbcParams(String, String, String, String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
If database support is required, this method should be
 invoked to initialize the Jdbc Parameters.
isEndOfTable - 
Variable in class com.adventnet.management.client.xml.MCTableResult
This field indicates whether the end of table reached or not.
isPerformPing() - 
Method in class com.adventnet.management.cli.CLIProperty
Gets the perform ping flag.
isRunning() - 
Method in interface com.adventnet.management.ManagementServices
Determines If the ManagementServices is running or stopped .



L

lastRowCntVal - 
Variable in class com.adventnet.management.client.xml.MCTableResult
The field represent the last row in the device table that is provided
 in this updation.



M

MAJOR_ALARM - 
Static variable in class com.adventnet.management.tl1.TL1Event
Constant for major alarm.
ManagementServerResultEvent - class com.adventnet.management.ManagementServerResultEvent.
This class is a generic result containing get set methods for 
 success code, error code and result of the request operation.
ManagementServerResultEvent() - 
Constructor for class com.adventnet.management.ManagementServerResultEvent
Default constructor
ManagementServerResultEvent(int, Object) - 
Constructor for class com.adventnet.management.ManagementServerResultEvent
This will return the request id of the response received.
ManagementServices - interface com.adventnet.management.ManagementServices.
This is an interface which supports generic protocol-neutral Management 
 transactions for user client applications.
ManagementServicesAPI - class com.adventnet.management.ManagementServicesAPI.
This is an API which returns a  generic protocol-neutral Management 
 Services Implementation -( ManagementClient / ManagementServer)for user 
 client applications based on the following ,
 
MCTableResult - class com.adventnet.management.client.xml.MCTableResult.
This  is a generic table  result returned  by the ManagementServer for
 retrieving  device tables .
MCTableResult() - 
Constructor for class com.adventnet.management.client.xml.MCTableResult
 
MINOR_ALARM - 
Static variable in class com.adventnet.management.tl1.TL1Event
Constant for minor alarm.
MS_THREE_TIER_MODE - 
Static variable in class com.adventnet.management.ManagementServicesAPI
This is the constant used to specify ManagementServer in three
 tier Mode.
MS_TWO_TIER_MODE - 
Static variable in class com.adventnet.management.ManagementServicesAPI
This is the constant used to specify ManagementServer in two
 tier Mode.
MSCallbackListener - interface com.adventnet.management.MSCallbackListener.
This interface is used by the ProtocolProvider to notify the 
 asynchronous responses recieved to the ManagementServer.
MSConnectionListener - interface com.adventnet.management.MSConnectionListener.
This interface is used by the ProtocolProvider to notify the
 ManagementServer on the connection status of the established session 
 between  ProtocolProvider and Device Agent.
MSEventFilter - interface com.adventnet.management.MSEventFilter.
This interface should be implemented by the ProtocolProvider for
 converting the protocol specific event PDU into a generic 
 Event .
MSEventListener - interface com.adventnet.management.MSEventListener.
This is the interface to be implemented to by the client user
 application to recieve Event notifications from the device.

 User applications must register the interface implementation (say testEventListenerImpl)
 while registering for event notification using the
 Property.setComponent() method.
MSNotification - class com.adventnet.management.MSNotification.
Contains the parameters necessary for the ManagementServer for
 processing an Event from the ProtocolProvider .
MSNotification() - 
Constructor for class com.adventnet.management.MSNotification
 
msNotify(Object) - 
Method in interface com.adventnet.management.MSNotifyListener
This method will be used by the ManagementServer to get the 
 events recieved by the Provider.
MSNotifyListener - interface com.adventnet.management.MSNotifyListener.
This interface is used by the ProtocolProvider to notify the 
 ManagementServer about the notification received.


N

NON_ALARM - 
Static variable in class com.adventnet.management.tl1.TL1Event
Constant for non alarm.
NOSUCCESS - 
Static variable in class com.adventnet.management.ManagementServerResultEvent
Constant specifying result of the operation as failure.
notifResult - 
Variable in class com.adventnet.management.MSNotification
The Event PDU recieved by the ProtocolProvider



O

OBJECT_KEY - 
Variable in class com.adventnet.management.corba.CorbaProperty
Field specifying the key for the persisted object.
OBJECT_VALUE - 
Variable in class com.adventnet.management.corba.CorbaProperty
Denotes the object that needs to be persisted.
OP_GET - 
Static variable in class com.adventnet.management.corba.CorbaProperty
Constant to specify the operationType as get.
OP_GET_BULK - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as the operation type (using setOperationType)
 if the SNMP operation is a GET BULK
OP_GET_COLUMN_TABLE - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
 
OP_GET_COLUMN_WALK - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as the operation type (using setOperationType)
 to perform a SNMP table column walk.
OP_GET_NEXT - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as the operation type (using setOperationType)
 if the SNMP operation is a GET NEXT
OP_GET_TABLE - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as the operation type (using setOperationType)
 if a SNMP TABLE has to be obtained
OP_READ - 
Static variable in class com.adventnet.management.Property
Constant for specifying the type of operation like read to be done with
 this properties.
OP_REMOVE - 
Static variable in class com.adventnet.management.corba.CorbaProperty
Constant to specify the operationType as remove.
OP_SESSION_CLOSE - 
Static variable in class com.adventnet.management.tl1.TL1Property
Static constant for Session close.
OP_SESSION_ESTABLISH - 
Static variable in class com.adventnet.management.tl1.TL1Property
Static constant for Session connection.
OP_SET - 
Static variable in class com.adventnet.management.corba.CorbaProperty
Constant to specify the operationType as set.
OP_WRITE - 
Static variable in class com.adventnet.management.Property
Constant for specifying the type of operation like write to be done with
 this properties.



P

PARTIAL - 
Static variable in class com.adventnet.management.ManagementServerResultEvent
Constant specifying result of the operation as Partially
 complete.
processConnectionDown(Properties) - 
Method in interface com.adventnet.management.MSConnectionListener
This method is implemented by the ManagementServer to be 
 notified by the ProtocolProvider on an established  session going down .
processConnectionDown(Property) - 
Method in interface com.adventnet.management.DeviceConnectionListener
This method is implemented by the User Client Applications to be 
 notified if an established device session connection has
 gone down.

processConnectionUp(Properties) - 
Method in interface com.adventnet.management.MSConnectionListener
This method is implemented by the ManagementServer  to be 
 notified by the ProtocolProvider on an established  session coming up.
processError(Property, int, String) - 
Method in interface com.adventnet.management.ProtocolListener
This method is implemented by the User Client Applications to 
 receive error responses  in asynchronous request-response transactions
 and request-polling  

processError(Property, Object) - 
Method in interface com.adventnet.management.ProtocolListener
This method is implemented by the User Client Applications to 
 receive error responses as objects in asynchronous request-response transactions
 and request-polling  

 This gives a  detailed status of the error.
processException(Property, Exception) - 
Method in interface com.adventnet.management.ExceptionListener
This method is used by the User Client Applications to be 
 notified of unhandled Exceptions in the Management Server .

Property - class com.adventnet.management.Property.
This class defines the generic Property object used by the 
 ManagementServices implementation for all transactions with user client 
 applications and Protocol Provider(s).
Property() - 
Constructor for class com.adventnet.management.Property
 
ProtocolListener - interface com.adventnet.management.ProtocolListener.
This is the interface to be implemented  by the user
 application to receive responses in asynchronous request-response
 transactions and request-polling.
ProtocolProvider - interface com.adventnet.management.ProtocolProvider.
This is the interface which must be implemented by the ProtocolProvider(s)
 for plugging a particular protocol into the ManagementServer .
PUT_COMMAND - 
Static variable in class com.adventnet.management.ftp.FTPProperty
Identifier that defines the command is put.



R

receive(int) - 
Method in interface com.adventnet.management.ProtocolProvider
Gets the result for  send() as ManagementServerResultEvent
 for the given reqid returned for send().
receive(int) - 
Method in interface com.adventnet.management.ManagementServices
Gets the result for  send() as ManagementServerResultEvent
 for the given reqid returned for send().
registerClient(Property) - 
Method in interface com.adventnet.management.ManagementServices
Registers a Property request with the ManagementServices for Polling.
registerClient(Property[]) - 
Method in interface com.adventnet.management.ManagementServices
Registers an array of Property requests with the ManagementServices for
 Polling.
registerForNotification(Property) - 
Method in interface com.adventnet.management.ProtocolProvider
The Provider should register for recieving notifications based on the
 parameters in Property .
registerForNotification(Property) - 
Method in interface com.adventnet.management.ManagementServices
Registers a Property request with the ManagementServices for 
 receiving Event notifications.

 The user client application object should implement 
 MSEventListener interface for 
 receiving notifications.
removeMSCallbackListener(MSCallbackListener) - 
Method in interface com.adventnet.management.ProtocolProvider
Unregister from being notified when the Provider recieves responses.
removeMSConnectionListener(MSConnectionListener) - 
Method in interface com.adventnet.management.ProtocolProvider
Unregister from being notified when the Provider recieves
 connection notifications.
removeMSNotifyListener(MSNotifyListener) - 
Method in interface com.adventnet.management.ProtocolProvider
Unregister from being notified when the Provider recieves
 notifications.
removeUserProperty(String) - 
Method in class com.adventnet.management.Property
The method removes any user property present in the object matching
 the name passed as arguement and returns the value of the property if it exists, else null 
 is returned.
removeUserProperty(String) - 
Method in class com.adventnet.management.Event
The method removes any user property present in the Event object matching
 the name passed as arguement and returns the value of the property if it exists, else null 
 is returned.
requestId - 
Variable in class com.adventnet.management.MSNotification
The requestId with which the ManagementServer registered for recieving
 events in ProtocolProvider.registerForNotification(Property).
reRegisterClient(Property) - 
Method in interface com.adventnet.management.ManagementServices
Unregisters and registers a Property request with the 
 ManagementServices for Polling.
reRegisterClient(Property[]) - 
Method in interface com.adventnet.management.ManagementServices
Unregisters and registers a Property request with the 
 ManagementServices for Polling.
restart() - 
Method in interface com.adventnet.management.ManagementServices
This will restart the ManagementServices if they have been stopped using
 ManagementServices.stop().
RESULT_INT - 
Static variable in class com.adventnet.management.Property
Constant for specifying the type of int result
RESULT_LONG - 
Static variable in class com.adventnet.management.Property
Constant for specifying the type of long result
RESULT_OBJECT - 
Static variable in class com.adventnet.management.Property
Constant for specifying the type of Object result
RESULT_OBJECTARRAY - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
Constant for specifying the type of Object [] result
RESULT_OCTETSTRING - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
Constant for specifying the type of OctetString result
RESULT_STRING - 
Static variable in class com.adventnet.management.Property
Constant for specifying the type of String result
RESULT_USERTYPE - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
Constant for specifying the type of UserType result.
rowArray - 
Variable in class com.adventnet.management.client.xml.MCTableResult
The  rows of the device table.



S

send(Property) - 
Method in interface com.adventnet.management.ProtocolProvider
This method should convert the generic request Property to 
 a PDU for the corresponding protocol and send it to the device
 agent via the Protocol API.
send(Property) - 
Method in interface com.adventnet.management.ManagementServices
Asynchronous type of Request Response Transaction .
sendAction(Property) - 
Method in interface com.adventnet.management.ProtocolProvider
This method sends a generic request Property after converting it
 into  a PDU for the corresponding protocol and send it to the
 device agent via the Protocol API .
sendAction(Property) - 
Method in interface com.adventnet.management.ManagementServices
A unacknowledged type of Request Response Transaction .
SET_TYPE_BITSTRING - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type BITSTRING
SET_TYPE_COUNTER - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type COUNTER
SET_TYPE_COUNTER64 - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type COUNTER64
SET_TYPE_GAUGE - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type GAUGE
SET_TYPE_INTEGER - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type INTEGER
SET_TYPE_IPADDRESS - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type IPADDRESS
SET_TYPE_NETWORKADDRESS - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type NETWORKADDRESS
SET_TYPE_NSAP - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type NSAP
SET_TYPE_NULLOBJ - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type NULL
SET_TYPE_OBJECTID - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type OBJECTID
SET_TYPE_OPAQUE - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type OPAQUE
SET_TYPE_STRING - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type STRING
SET_TYPE_TIMETICKS - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type TIMETICKS
SET_TYPE_UINTEGER32 - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type UINTEGER32
SET_TYPE_UNSIGNED32 - 
Static variable in class com.adventnet.management.snmp.SnmpProperty
This should be set as variable type if the  Object ID (to be SET)
 is of type UNSIGNED32
setAccessId(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the Access Id with the given value.
setAttemptComplete(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Enables the flag to get the complete data from the agent by splitting
 the varbinds into multiple request.
setAuthPassword(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the authentication password as string in v3 requests.
setAuthProtocol(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the auth protocol as string in v3 requests.
setBinaryMode(boolean) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the mode in which file transfer will take place.
setBinaryModeList(boolean[]) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the  mode of  file transfer(binary/ascii).
setCategory(String) - 
Method in class com.adventnet.management.Event
Set the category of the event, like Threshold event etc.
setCommand(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for Command.
setCommand(String) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the command, which can be either get or put.
setCommandCode(String) - 
Method in class com.adventnet.management.tl1.TL1Property
Set the command code in the Input message.
setCommandList(String[]) - 
Method in class com.adventnet.management.cli.CLIProperty
Sets the list of commands to be executed in the Target Host.
setCommandList(String[]) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the array of commands for file tranfer operation.
setCommandList(String[]) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the list of commands to be executed on the device.
setCommunicationMode(int) - 
Method in interface com.adventnet.management.ProtocolProvider
Sets the the request response transaction mode between 
 ProtocolProvider and device agent (asynchronous or synchronous) .
setCommunity(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the community as string.
setComponent(Object) - 
Method in class com.adventnet.management.Property
Applications use this Method to pass their Object reference 
 to receive asynchronous responses and notifications.
setConnectionHandler(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the ConnectionHandler implementation Filename.
setConnectionListener(String) - 
Method in class com.adventnet.management.tl1.TL1Property
Set the ConnectionListener implementation Filename.
setContextID(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the contextid.
setContextName(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the context name.
setDBPassword(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
If database support is required, this method should be
 invoked to initialize the Jdbc Parameter.
setDBUserName(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
If you need to use database support, this method should be
 invoked to initialize the Jdbc Parameter.
setDebug(boolean) - 
Method in interface com.adventnet.management.ProtocolProvider
The provider should print debug messages and the PDU(s)
 on the console when this option is enabled.
setDebug(boolean) - 
Method in interface com.adventnet.management.ManagementServices
This is used to enable the debug mode in Management Services.
setDestinationFileList(String[]) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the array of destination file names for file transfer operation.
setDestinationFileList(String[]) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the list of destination file name(s) corresponding to each & every command 
 returned in the setCommandList API.
setDestinationFileName(String) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the destination file name.
setDomain(String) - 
Method in class com.adventnet.management.Event
Set the domain  name of the Agent which generates this event.
setDriverName(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
If database support is required, this method should be
 invoked to initialize the Jdbc Parameter.
setDummyProperty(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Used to set dummyproperty for other calculations.
setEnterprise(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the Enterprise OID for the trap that has to be received.
setEntity(String) - 
Method in class com.adventnet.management.Event
Set the Entity (also known as Failure Object) of the Event.
setErrObject(Object) - 
Method in class com.adventnet.management.ManagementServerResultEvent
This will set the error object
setErrStat(byte) - 
Method in class com.adventnet.management.ManagementServerResultEvent
This will set the error status as a byte.
setErrString(String) - 
Method in class com.adventnet.management.ManagementServerResultEvent
To set the error string with the given instance.
setEventResult(Property, Object) - 
Method in interface com.adventnet.management.MSEventListener
This method is used by the User Client Applications to be 
 notified of Events.
setFilterClass(String) - 
Method in class com.adventnet.management.Property
This is used by user client applications to set the name of a Class 
 which implements the interface Filter 
 The responses recieved from the ProtocolProvider will be passed
 to this filter before being given to the application.
setFilterParameters(String) - 
Method in class com.adventnet.management.Property
This method is used by user client applications to set the parameters 
 to be passed as argument to the getFilteredObject method of 
 the Filter class along with the response from the provider.
setGeneralBlock(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the general block with the given value.
setGenericType(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the Generic type for the trap that has to be received.
setGroupName(String) - 
Method in class com.adventnet.management.Property
Set the groupname of the Property .
setIndex(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the index for the table oid.
setInterfaceName(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of interfaceName.
setInterPacketDelay(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the delay that should be used between requests in milliseconds.
setInvokeObject(Object) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of invokeObject.
setLabel(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of label.
setLocalPort(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the local port as string.
setLoginName(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for LoginName.
setLoginPrompt(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for LoginPrompt.
setManagementServicesMode(int) - 
Static method in class com.adventnet.management.ManagementServicesAPI
This method is used to Set the ManagementServices Mode.

setMaxRepetitions(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the max-repetitions for get bulk operation as string.
setMessagePayloadBlock(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the Message payload block with the given value.
setMethodDetail(String, int, String[], Object[]) - 
Method in class com.adventnet.management.Property
This is used by applicatons to set the details of the method to get
 the result for request response transactions
setMethodName(String) - 
Method in class com.adventnet.management.Property
This method is set by the user client application to specify the
 method to which the result is to be given for  Request-Response
 transactions.
setMibsToBeLoaded(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set MIB Modules from files to be loaded.
setMibToBeUnLoaded(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the mib file name to be unloaded.
setModeList(String[]) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the array of mode for file transfer operation.
setNameReference(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of nameReference.
setNetwork(String) - 
Method in class com.adventnet.management.Event
Modifier method to Set the Network where the event occurs.
setNode(String) - 
Method in class com.adventnet.management.Event
Modifier method to Set the Node field of the Event.
setNonRepeaters(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the non-repeaters for get bulk operation as string.
setObject(Object) - 
Method in class com.adventnet.management.Event
Sets the given object as the object attribute of this Event.
setObjectID(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the object id.
setObjectIDList(String[]) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set a list object ids.
setOperationType(int) - 
Method in class com.adventnet.management.Property
Set the type of the command which will specify whether the request is 
 to read or write.
setORBClassName(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of ORBClassName.
setORBInitialHost(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of ORBInitialHost.
setORBInitialPort(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of ORBInitialPort.
setORBService(String) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of ORBService.
setPartialSet(boolean) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Enables partial SNMP SET when the argument is true.
setPassword(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for Password.
setPassword(String) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the password for the user account of ftp device.
setPasswordPrompt(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for PasswordPrompt.
setPerformPing(boolean) - 
Method in class com.adventnet.management.cli.CLIProperty
Sets the perform ping flag.
setPollInterval(long) - 
Method in class com.adventnet.management.Property
This is used to set the polling interval(in milliseconds) 
 used for poll registration.
setPrivPassword(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the privacy password as string in v3 requests.
setPromptAction(Properties) - 
Method in class com.adventnet.management.cli.CLIProperty
This method is used for setting
 the possible prompts and action/command to be 
 executed when the prompt is encountered.
setPromptList(String[]) - 
Method in class com.adventnet.management.cli.CLIProperty
Sets the list of prompt(s) to be expected after the end of each and 
  every command corresponding to the command provided in the 
  setCommandList method.
setProperties(Hashtable) - 
Method in class com.adventnet.management.cli.CLIProperty
This method will set a list of properties on this CLIProperty instance.
setProperties(Hashtable) - 
Method in class com.adventnet.management.tl1.TL1Property
This method sets the individual fields of this class with the values
 given in the hashtable.
setProperties(Hashtable) - 
Method in class com.adventnet.management.snmp.SnmpProperty
This method will set a Hashtable which will have the property values
 with the corresponding keys.
setProperties(Hashtable) - 
Method in class com.adventnet.management.corba.CorbaProperty
 
setProperties(Hashtable) - 
Method in class com.adventnet.management.Property
This method will be used by the ManagementServer to set the values of
 a list of parameters in the Property .
setProperties(Hashtable) - 
Method in class com.adventnet.management.client.ClientProperty
This is the implementaion of Property.setProperties()
setProperties(Hashtable) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the ftp properties from the specified Properties.
setProperties(Hashtable) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets a Hashtable which will have the property values
 with the corresponding keys.
setProperties(Properties) - 
Method in class com.adventnet.management.tl1.TL1Event
This method sets the properties of the TL1Event Object.
setProperties(Properties) - 
Method in class com.adventnet.management.snmp.SnmpEvent
This method sets the properties of the SnmpEvent Object.
setProperties(Properties) - 
Method in class com.adventnet.management.Event
This method sets the properties of the Event Object.
setPropertiesList(Vector) - 
Method in class com.adventnet.management.tl1.TL1Property
This method sets the individual fields of this class with the values
 given in the hashtables Vector .
setProperty(Property) - 
Method in class com.adventnet.management.Event
Set the Property registered for this Notification.
setPropertyType(String) - 
Method in class com.adventnet.management.Property
Set the type name of the Property.
setProtocolPDU(Object) - 
Method in class com.adventnet.management.Property
This method is used by the ManagementServer to set the ProtocolPDU
 for a request Property which it had obtained using getProtocolPDU
 from the ProtocolProvider .
setProtocolResult(Property, Object) - 
Method in interface com.adventnet.management.ProtocolListener
This method is implemented by the User Client Applications to 
 receive responses in asynchronous request-response transactions and 
 request-polling 

setRemoteHost(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the Remote host from which trap has to be received.
setRemoteHostList(String[]) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the remotehost list to this SnmpProperty instance.
setRequestID(int) - 
Method in class com.adventnet.management.Property
This method is used by the ManagementServer to set the requestId of
 a Property which is unique for each transaction between the 
 ManagementServer and the ProtocolProvider.
setRequestID(int) - 
Method in class com.adventnet.management.ManagementServerResultEvent
This will set the reqid id of the ManagementServerResultEvent.
setResponseMessageIdentifiers(String[]) - 
Method in class com.adventnet.management.tl1.TL1Property
This method is internally used by the API, and it should not be
 invoked by the user.
setResult(Object) - 
Method in class com.adventnet.management.ManagementServerResultEvent
This method will set the result as object
setResultType(int) - 
Method in class com.adventnet.management.Property
This method is used by applications to set the Class type of result
 which is returned to the user client aplications in Request Response
 transactions.
setRetries(int) - 
Method in class com.adventnet.management.Property
This is used to set the number of retries specified for  a 
 Property.
setSendPDUByGroup(boolean) - 
Method in class com.adventnet.management.snmp.SnmpProperty
This method is not implemented by the SnmpProperty and should not be
 used.
setSessionId(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Sets the Session Id.
setSessionId(String) - 
Method in class com.adventnet.management.Property
Set the Session Id of the request Property.
setSeverity(int) - 
Method in class com.adventnet.management.Event
Set the Severity of the Event object.
setShareSessions(boolean) - 
Method in interface com.adventnet.management.ProtocolProvider
This method sets the mode whether the sessions towards the same devices
 can be shared among Management clients for connection oriented 
 protocols.
setShellPrompt(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for ShellPrompt.
setSourceFileList(String[]) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the array of source file names for file transfer operation.
setSourceFileList(String[]) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the list of source file name(s) corresponding to each & every command 
 (either get or put) given to the 
 setCommandList API.
setSourceFileName(String) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the source file name.
setSpecificType(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the Specific type for the trap that has to be received.
setSuccessCode(int) - 
Method in class com.adventnet.management.ManagementServerResultEvent
This method will set the success code  of a particular
 response.
setTableOID(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the object id of the table.
setTargetHost(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Sets the target host.
setTargetHost(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the target the host name.
setTargetHost(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the target host.
setTargetHost(String) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the target ftp host name.
setTargetHost(String) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the target host.
setTargetId(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the target id with the given value.
setTargetPort(int) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the port in which ftp device is listening.
setTargetPort(String) - 
Method in class com.adventnet.management.cli.CLIProperty
Setter for the Target port.
setTargetPort(String) - 
Method in class com.adventnet.management.tl1.TL1Property
To set the target port number with the given value.
setTargetPort(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the target port as string.
setTargetPort(String) - 
Method in class com.adventnet.management.tftp.TftpProperty
Sets the target port.
setText(String) - 
Method in class com.adventnet.management.Event
This is the modifier method used to set the descriptive text message
 of the event.
setTime(long) - 
Method in class com.adventnet.management.Event
Set the time of occurrence (creation), in milliseconds, of this 
 Event object.
setTimeout(int) - 
Method in class com.adventnet.management.Property
This is used to set the timeout(in milliseconds) for this 
 Property.
setURL(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
If database support is required, this method should be
 invoked to initialize the Jdbc Parameter.
setURL(String) - 
Method in class com.adventnet.management.client.ClientProperty
This is used by the applications to set the URL location of the XML 
 file from which request Property(s) are to be constructed by the 
 ManagementServer.
setUserName(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the principal on whose behalf SNMPv3 requests are to be made.
setUserName(String) - 
Method in class com.adventnet.management.ftp.FTPProperty
Sets the name of the user account specified in the ftp device.
setUserProperty(String, String) - 
Method in class com.adventnet.management.Property
This method sets a user property to the Property Object.
setUserProperty(String, String) - 
Method in class com.adventnet.management.Event
This method sets a user property to the Event Object.
setV3ConfigTable(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Gets the table name that was configured for V3.
setV3DatabaseFlag(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
If database support is required for SNMP V3 , set this flag to true.
setVarBindCount(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Set the number of varbinds per request to get the complete data from
 the agent by splitting the varbinds into multiple request.
setVersion(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets SNMP version.
setWriteCommunity(String) - 
Method in class com.adventnet.management.snmp.SnmpProperty
Sets the write community as string.
setWriteType(byte) - 
Method in class com.adventnet.management.Property
Set the Class type of the value for the OP_WRITE operation.
setWriteTypes(byte[]) - 
Method in class com.adventnet.management.Property
Set the class types of the set of values to be set for the 
 OP_WRITE operation.
setWriteValue(String) - 
Method in class com.adventnet.management.Property
This is used to set the value for a OP_WRITE operation in
 a Property request .
setWriteValues(String[]) - 
Method in class com.adventnet.management.Property
This is used to set the values for a OP_WRITE operation in
 a Property request .
setXMLDoc(Element[]) - 
Method in class com.adventnet.management.corba.CorbaProperty
Set the value of XMLDoc.
SnmpEvent - class com.adventnet.management.snmp.SnmpEvent.
This class forms the basis of every Event generated in Management Server .
SnmpEvent() - 
Constructor for class com.adventnet.management.snmp.SnmpEvent
 
SnmpProperty - class com.adventnet.management.snmp.SnmpProperty.
This is the implementation of com.adventnet.management.Property for SNMP
 protocol.
SnmpProperty() - 
Constructor for class com.adventnet.management.snmp.SnmpProperty
This creates an instance of SnmpProperty and sets the Protocol tpe field
 to 'SNMP'
stop() - 
Method in interface com.adventnet.management.ManagementServices
This will temporarily shutdown the ManagementServices.
SUCCESS - 
Static variable in class com.adventnet.management.ManagementServerResultEvent
Constant specifying result of the operation as success.
SYNC_COMM - 
Static variable in interface com.adventnet.management.ProtocolProvider
This is the constant used to specify synchronous communication mode
 between ProtocolProvider and Device agent .
syncSend(Property) - 
Method in interface com.adventnet.management.ProtocolProvider
This method should convert the generic request Property to 
 a PDU for the corresponding protocol and send it to the device
 agent via the Protocol API .
syncSend(Property) - 
Method in interface com.adventnet.management.ManagementServices
Synchronous type of Request Response Transaction .



T

TABLE_END - 
Static variable in class com.adventnet.management.client.xml.MCTableResult
TABLE_END indicates that the table updation is complete.
TABLE_IN_PROGRESS - 
Static variable in class com.adventnet.management.client.xml.MCTableResult
TABLE_IN_PROGRESS indicates that the table updation is in progress
 and more updation(s) will follow.
terminateSession(Property) - 
Method in interface com.adventnet.management.ProtocolProvider
Disconnect session from communication with device based on the
 parameters in the  request Property .
terminateSession(Property) - 
Method in interface com.adventnet.management.ManagementServices
Used to terminate an established  device session .
terminateSession(String) - 
Method in interface com.adventnet.management.ManagementServices
This is used to terminate the session  using the sessionId
 returned during establish.
TftpProperty - class com.adventnet.management.tftp.TftpProperty.
This is the implementation of com.adventnet.management.Property 
 for TFTP protocol.
TftpProperty() - 
Constructor for class com.adventnet.management.tftp.TftpProperty
A convenience constructor for creating an instance of
 TftpProperty.
TL1Event - class com.adventnet.management.tl1.TL1Event.
This class forms the basis of every Event generated in Management Server .
TL1Event() - 
Constructor for class com.adventnet.management.tl1.TL1Event
 
TL1Property - class com.adventnet.management.tl1.TL1Property.
This is the implementation of com.adventnet.management.Property 
 for TL1 Protocol.It encapsulates the Information about the device like name
 of the device, port no on which the TL1 agent is listening on the device.
TL1Property() - 
Constructor for class com.adventnet.management.tl1.TL1Property
An empty Constructor of this class.



U

unregisterClient(Property) - 
Method in interface com.adventnet.management.ManagementServices
Unregisters a Property request with the ManagementServices from Polling.
unregisterClient(Property[]) - 
Method in interface com.adventnet.management.ManagementServices
Unregisters an array of Property requests with the ManagementServices 
 from Polling.
unregisterForNotification(Property) - 
Method in interface com.adventnet.management.ProtocolProvider
Unregister From Recieving Notifications based on the parameters
 in the request Property .
unregisterForNotification(Property) - 
Method in interface com.adventnet.management.ManagementServices
Unregisters a Property request with the ManagementServices from receiving
 events.

unregisterForNotification(String) - 
Method in interface com.adventnet.management.ManagementServices
Unregisters a Property request with the ManagementServices from receiving
 events.



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







  
      Overview 
      Package 
      Class 
      Tree 
      Deprecated 
    Index 
      Help 
  



WebNMS 5 API Specification





 PREV 
 NEXT

  FRAMES   
 NO FRAMES