com.adventnet.snmp.rmi
Interface SnmpTarget

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
SnmpPoller, SnmpTable
All Known Implementing Classes:
SnmpPollerImpl_Stub, SnmpTableImpl_Stub, SnmpTargetImpl_Stub

public interface SnmpTarget
extends java.rmi.Remote

This RMI interface defines the set of services accessible remotely from an RMI client to the RMI server. By obtaining a remote reference to the object implementing this interface, the RMI client application can perform RMI calls.

Please see the RMI client examples for more information on getting started using the RMI APIs. You will find it very useful to get familiar with the com.adventnet.snmp.beans package before using the RMI APIs, since the RMI APIs mirror and are derived from the beans equivalents.


Field Summary
static byte AUTH_NO_PRIV
          v3 only Used to specify that authenticated message be sent to the peer.
static byte AUTH_PRIV
          v3 only Used to specify that authentication and privacy are used in the communication with the peer.
static int CBC_3DES
          v3 only Constant for the SNMPv3 usmUserPrivProtocol CBC_3DES.
static int CBC_DES
          v3 only Constant for the SNMPv3 usmUserPrivProtocol CBC_DES.
static int CFB_AES_128
          v3 only Constant for the SNMPv3 usmUserPrivProtocol CFB_AES_128.
static int CFB_AES_192
          v3 only Constant for the SNMPv3 usmUserPrivProtocol CFB_AES_192.
static int CFB_AES_256
          v3 only Constant for the SNMPv3 usmUserPrivProtocol CFB_AES_256.
static int MD5_AUTH
          v3 only Constant for SNMPv3 usmHMACMD5AuthProtocol.
static int NO_AUTH
          v3 only Constant for SNMPv3 usmNoAuthProtocol.
static byte NO_AUTH_NO_PRIV
          v3 only Used to specify that both authentication and privacy should not be used.
static int NO_PRIV
          v3 only Constant for SNMPv3 usmNoPrivProtocol.
static int SHA_AUTH
          v3 only Constant for SNMPv3 usmHMACSHAAuthProtocol.
static byte SNMPGET
          Constant for SNMP Get Request.
static byte SNMPGETBULK
          v2c and v3 only Constant for SNMP GetBulk Request.
static byte SNMPGETNEXT
          Constant for SNMP GetNext Request.
static byte SNMPINFORM
          v2c and v3 only Constant for SNMP Inform Request.
static byte SNMPREPORT
          v2c and v3 only Constant for SNMP Report.
static byte SNMPRESPONSE
          Constant for SNMP Response.
static byte SNMPSET
          Constant for SNMP Set Request.
static byte SNMPTRAP
          Constant for SNMP Trap.
static byte SNMPV2TRAP
          v2c and v3 only Constant for SNMPv2 Trap.
static int VERSION1
          v2c and v3 only Constant for SNMP version 1.
static int VERSION2C
          v2c and v3 only Constant for SNMP version 2C.
static int VERSION3
          v3 only Constant for SNMP version 3.
 
Method Summary
 void addLogClient(LogInterface client)
          Adds the Log client to which the target has to redirect the log messages.
 int addObjectID(java.lang.String s)
          Adds an OID specified by the string to the OID list and returns the index of the entry.
 void addResultListener(ResultListener l)
          Adds a listener for events from this target.
 int addSnmpOID(SnmpOID oid)
          Adds an OID to the list of OIDs and returns the index of the added entry.
 void create_v3_tables()
          v3 only Initializes v3 parameters.
 boolean getAttemptComplete()
          Returns a boolean indicating if PDU-splitting (splitting the varBindList into multiple requests) is enabled to get the complete data.
 boolean getAttemptPartial()
          Returns the boolean state of whether this target will try to get partial data from an agent, in case of a multi-variable request.
 java.lang.String getAuthPassword()
          v3 only Gets the SNMPv3 usmUser's Auth Password previously set on this target, or else, the default value.
 int getAuthProtocol()
          v3 only Gets the SNMPv3 usmUser's Auth Protocol previously set on this target, or else, the default value.
 java.lang.String getCommunity()
          Gets the community previously set on this target, or else, the default value.
 java.lang.String getContextID()
          v3 only Gets the SNMPv3 contextID previously set on this target, or else, the default value.
 java.lang.String getContextName()
          v3 only Gets the SNMPv3 Context name previously set on this target, or else, the default value.
 int getErrorCode()
          Gets the error code corresponding to the last request.
 java.lang.String getErrorString()
          Gets the error string corresponding to the last request.
 int getExceptionCode()
          v2c and v3 only Gets the exception code for the last request.
 int getMaxNumRows()
          Gets the maximum number of rows that can be processed, default value is 1000.
 int getMaxRepetitions()
          v2c and v3 only Gets the max-repetitions value for a GetBulk request previously set on this target, or else, the default value 50.
 java.lang.String getMibModules()
          Gets the MIBs loaded in this applet/application - a white-space separated list of mib files.
 MibOperations getMibOperations()
          Gets the MibOperations object reference.
 int getNonRepeaters()
          v2c and v3 only Gets the non-repeaters value for a GetBulk request previously set on this target, or else, the default value 0.
 java.lang.String getObjectID()
          Returns the first object ID as a string.
 java.lang.String getObjectID(int index)
          Returns the object ID at the specified index as a String.
 java.lang.String[] getObjectIDList()
          Returns the list of object IDs as a string array
 java.lang.String getPrincipal()
          v3 only Gets the SNMPv3 Principal previously set on this target, or else, the default value.
 java.lang.String getPrivPassword()
          v3 only Gets the SNMPv3 usmUser's Privacy Password previously set on this target, or else, the default value.
 int getPrivProtocol()
          v3 only Gets the usmUserPrivProtocol previously set on this target, or else, the default value.
 int getRetries()
          Gets the retries value previously set on this target, or else, the default retries 0.
 java.lang.String getSecurityLevel()
          v3 only Gets the SNMPv3 SecurityLevel
 int getSecurityModel()
          v3 only Gets the SNMPv3 securityModel previously set on this target, or else, the default value.
 boolean getSendTimeoutEvents()
          Returns the boolean state of whether this target will send timeout events to a registered listener.
 SnmpOID getSnmpOID()
          Returns the first SnmpOID from the list of object IDs.
 SnmpOID[] getSnmpOIDList()
          Returns the list of object IDs as an array of SnmpOID instances.
 int getSnmpVersion()
          v2c and v3 only Gets the SNMP version previously set on this target, or else, the default version.
 java.lang.String getTargetHost()
          Gets the hostname previously set on this target, or else, the default value.
 int getTargetPort()
          Gets the port number previously set on this target, or else, the default value.
 int getTimeout()
          Gets the timeout value (in sec) previously set on this target, or else, the default timeout 5.
 int getTimeoutInMilliSec()
          Returns the timeout value in milliseconds.
 int getVarBindCount()
          Returns the number of varBinds used with the split-PDU.
 java.lang.String getWriteCommunity()
          Gets the community used for Set requests previously set on this target, or else, the default value.
 void initSecurityProvider()
          v3 only Initialises the SNMPv3 Security provider.
 boolean isInSubTree(SnmpOID rootoid, SnmpOID objid)
          Checks if objid has rootoid as an ancestor, and returns true if it does.
 boolean isSerialize()
          v3 only Returns the status of Serialization of v3 tables ( USMUserTable and SnmpEngineTable )
 boolean isSupportedSecurityModel(int secModel)
          v3 only Specifies if a particular security model is supported or not.
 void loadMibs(java.lang.String mibs)
          Loads the mibs specified by white-space separated list of mibs.
 void manage_v3_tables()
          v3 only Method to create new users and add them to userTable in USMUserTable.
 void releaseResources()
          Though the resources will be cleaned up by the garbage collector, if the application is no more using the SnmpTarget instances, this method can be used to immediately release the resources.
 void removeLogClient()
          Removes the Log client for which the target has been registered to redirect the log Messages.
 void removeResultListener(ResultListener l)
          Removes a listener for events from this target.
 void setAttemptComplete(boolean flag)
          Enables getting complete data from the agent by splitting the varBindList into multiple requests.
 void setAttemptPartial(boolean b)
          Sets the boolean state of whether this target will try to get partial data from an agent, in case of a multi-variable request.
 void setAuthPassword(java.lang.String password)
          v3 only Sets the SNMPv3 usmUser's Auth Password.
 void setAuthProtocol(int protocol)
          v3 only Sets the SNMPv3 usmUser's Auth Protocol.
 void setCommunity(java.lang.String s)
          Sets the community.
 void setContextID(java.lang.String ctxtID)
          v3 only Sets the SNMPv3 contextID.
 void setContextName(java.lang.String cName)
          v3 only Sets the SNMPv3 Context name.
 void setDebug(boolean debug)
          Enables debug output to be printed.
 void setMaxNumRows(int maxRows)
          Sets the maximum number of rows that can be processed, default value is 1000.
 void setMaxRepetitions(int i)
          v2c and v3 only Sets the max-repetitions value to be used for a GetBulk request.
 void setMibModules(java.lang.String mibs)
          Sets the MIBs loaded in this applet/application - a white-space separated list of mib files.
 void setNonRepeaters(int i)
          v2c and v3 only Sets the non-repeaters value to be used for a GetBulk request.
 void setObjectID(int index, java.lang.String s)
          Sets the object ID value at index based on specified string
 void setObjectID(java.lang.String s)
          Sets the first object ID value based on specified string
 void setObjectIDList(java.lang.String[] s)
          Sets the list of object IDs based on the specified string array
 void setParams(java.lang.String host, java.lang.String port, java.lang.String community, java.lang.String mib, java.lang.String oid)
          Sets multiple parameters like TargetHost, Port, Community, MibModule and OID.
 void setParams(java.lang.String host, java.lang.String port, java.lang.String community, java.lang.String mib, java.lang.String[] oidlist)
          Sets multiple parameters like TargetHost, Port, Community, MibModule and OID list.
 void setPrincipal(java.lang.String s)
          v3 only Sets the SNMPv3 Principal.
 void setPrivPassword(java.lang.String password)
          v3 only Sets the SNMPv3 usmUser's Privacy Password.
 void setPrivProtocol(int privProtocol)
          v3 only Sets the usmUserPrivProtocol.
 void setRetries(int i)
          Sets the retries value.
 void setSecurityLevel(byte sLevel)
          v3 only Sets the SNMPv3 SecurityLevel
 void setSecurityModel(int secModel)
          v3 only Sets the SNMPv3 Security Model.
 void setSendTimeoutEvents(boolean b)
          Sets the boolean state of whether this target will send timeout events to a registered listener.
 void setSnmpOID(SnmpOID oid)
          Sets the first SnmpOID in the list of object IDs.
 void setSnmpOIDList(SnmpOID[] list)
          Sets the list of object IDs as the given array of SnmpOID instances.
 void setSnmpVersion(int i)
          v2c and v3 only Sets the SNMP version.
 void setTargetHost(java.lang.String s)
          Sets the hostname of the remote SNMP entity.
 void setTargetPort(int i)
          Sets the port number of the remote SNMP entity.
 void setTimeout(int i)
          Sets the timeout value in sec.
 void setTimeoutInMilliSec(int time)
          Sets the timeout value which should be given in milliseconds.
 void setVarBindCount(int count)
          Sets the number of varBinds to be filled per request to get complete data from agent, in case of splitting the varBindList into multiple requests.
 void setWriteCommunity(java.lang.String s)
          Sets the community to be used for Set requests.
 java.lang.String snmpGet()
          Queries the target and returns as a string the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVar snmpGet(SnmpOID oid)
          Gets the SNMP variable identified by specified Object Identifier.
 java.lang.String[][] snmpGetAllList()
          Gets all instances of variables in the OID list.
 SnmpVarBind[][] snmpGetAllVariableBindings()
          Gets all instances of variables in the OID list.
 SnmpVar[][] snmpGetAllVariables()
          Gets all instances of variables in the OID list.
 java.lang.String[][] snmpGetBulkList()
          v2c and v3 only Gets bulk on list of variables in the OID list.
 SnmpVarBind[][] snmpGetBulkVariableBindings()
          v2c and v3 only Gets bulk on list of variables in the OID list.
 SnmpVar[][] snmpGetBulkVariables()
          v2c and v3 only Gets bulk on list of variables in the OID list.
 java.lang.String[] snmpGetList()
          Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVar[] snmpGetList(SnmpOID[] oids)
          Gets the list of SNMP variables identified by the Object Identifier list stored in this SnmpTarget instance.
 java.lang.String snmpGetNext()
          Queries the target and returns as a string the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVar snmpGetNext(SnmpOID oid)
          Gets the SNMP variable identified by specified Object Identifier.
 java.lang.String[] snmpGetNextList()
          Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVar[] snmpGetNextList(SnmpOID[] oids)
          Gets the list of SNMP variables identified by the Object Identifier list stored in this SnmpTarget instance.
 SnmpVar snmpGetNextVariable()
          Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVarBind snmpGetNextVariableBinding()
          Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVarBind[] snmpGetNextVariableBindings()
          Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVar[] snmpGetNextVariables()
          Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVar snmpGetVariable()
          Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVarBind snmpGetVariableBinding()
          Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVarBind[] snmpGetVariableBindings()
          Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVar[] snmpGetVariables()
          Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVarBind[] snmpSendInformRequest(long uptime, SnmpOID trapOid, SnmpVar[] values)
          v2c and v3 only Sends an SNMPv2 inform pdu with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.
 java.lang.String[] snmpSendInformRequest(long uptime, java.lang.String trapOid, java.lang.String[] values)
          v2c and v3 only Sends an SNMPv2 inform pdu with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.
 void snmpSendNotification(long uptime, SnmpOID trapOid, SnmpVar[] values)
          v2c and v3 only Sends an SNMPv2 notification pdu with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.
 void snmpSendTrap(SnmpOID enterprise, java.lang.String agenthost, int genericType, int specificType, long uptime, SnmpVar[] values)
          Sends an SNMP trap, with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.
 void snmpSendTrap(java.lang.String enterprise, java.lang.String agenthost, int genericType, int specificType, long uptime, java.lang.String[] values)
          Sends an SNMP trap, with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.
 java.lang.String snmpSet(java.lang.String value)
          Performs an SNMP Set to the target using value specified of the first variable on the variable list.
 java.lang.String snmpSet(java.lang.String value, byte type)
          Performs an SNMP Set to the target of the first variable on the variable list using value specified.
 java.lang.String[] snmpSetList(java.lang.String[] values)
          Sets the list of SNMP variable bindings on the agent using the Object Identifier list previously set in this SnmpTarget instance.
 SnmpVar snmpSetVariable(SnmpVar var)
          Performs an SNMP Set with specified value to the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance.
 SnmpVar[] snmpSetVariables(SnmpVar[] values)
          Performs an SNMP set, with values specified, the list of SNMP variable bindings on the agent, using the Object Identifier list previously set in this SnmpTarget instance.
 

Field Detail

SNMPGET

public static final byte SNMPGET
Constant for SNMP Get Request.

See Also:
Constant Field Values

SNMPGETNEXT

public static final byte SNMPGETNEXT
Constant for SNMP GetNext Request.

See Also:
Constant Field Values

SNMPRESPONSE

public static final byte SNMPRESPONSE
Constant for SNMP Response.

See Also:
Constant Field Values

SNMPSET

public static final byte SNMPSET
Constant for SNMP Set Request.

See Also:
Constant Field Values

SNMPTRAP

public static final byte SNMPTRAP
Constant for SNMP Trap.

See Also:
Constant Field Values

SNMPGETBULK

public static final byte SNMPGETBULK
v2c and v3 only Constant for SNMP GetBulk Request.

See Also:
Constant Field Values

SNMPINFORM

public static final byte SNMPINFORM
v2c and v3 only Constant for SNMP Inform Request.

See Also:
Constant Field Values

SNMPV2TRAP

public static final byte SNMPV2TRAP
v2c and v3 only Constant for SNMPv2 Trap.

See Also:
Constant Field Values

SNMPREPORT

public static final byte SNMPREPORT
v2c and v3 only Constant for SNMP Report.

See Also:
Constant Field Values

VERSION1

public static final int VERSION1
v2c and v3 only Constant for SNMP version 1.

See Also:
Constant Field Values

VERSION2C

public static final int VERSION2C
v2c and v3 only Constant for SNMP version 2C.

See Also:
Constant Field Values

VERSION3

public static final int VERSION3
v3 only Constant for SNMP version 3.

See Also:
Constant Field Values

NO_AUTH

public static final int NO_AUTH
v3 only Constant for SNMPv3 usmNoAuthProtocol.

See Also:
Constant Field Values

MD5_AUTH

public static final int MD5_AUTH
v3 only Constant for SNMPv3 usmHMACMD5AuthProtocol.

See Also:
Constant Field Values

SHA_AUTH

public static final int SHA_AUTH
v3 only Constant for SNMPv3 usmHMACSHAAuthProtocol.

See Also:
Constant Field Values

NO_PRIV

public static final int NO_PRIV
v3 only Constant for SNMPv3 usmNoPrivProtocol.

See Also:
Constant Field Values

CBC_DES

public static final int CBC_DES
v3 only Constant for the SNMPv3 usmUserPrivProtocol CBC_DES.

See Also:
Constant Field Values

CFB_AES_128

public static final int CFB_AES_128
v3 only Constant for the SNMPv3 usmUserPrivProtocol CFB_AES_128.

See Also:
Constant Field Values

CFB_AES_192

public static final int CFB_AES_192
v3 only Constant for the SNMPv3 usmUserPrivProtocol CFB_AES_192.

See Also:
Constant Field Values

CFB_AES_256

public static final int CFB_AES_256
v3 only Constant for the SNMPv3 usmUserPrivProtocol CFB_AES_256.

See Also:
Constant Field Values

CBC_3DES

public static final int CBC_3DES
v3 only Constant for the SNMPv3 usmUserPrivProtocol CBC_3DES.

See Also:
Constant Field Values

NO_AUTH_NO_PRIV

public static final byte NO_AUTH_NO_PRIV
v3 only Used to specify that both authentication and privacy should not be used.

See Also:
Constant Field Values

AUTH_NO_PRIV

public static final byte AUTH_NO_PRIV
v3 only Used to specify that authenticated message be sent to the peer.

See Also:
Constant Field Values

AUTH_PRIV

public static final byte AUTH_PRIV
v3 only Used to specify that authentication and privacy are used in the communication with the peer.

See Also:
Constant Field Values
Method Detail

releaseResources

public void releaseResources()
                      throws java.rmi.RemoteException
Though the resources will be cleaned up by the garbage collector, if the application is no more using the SnmpTarget instances, this method can be used to immediately release the resources.

java.rmi.RemoteException

setParams

public void setParams(java.lang.String host,
                      java.lang.String port,
                      java.lang.String community,
                      java.lang.String mib,
                      java.lang.String oid)
               throws java.rmi.RemoteException
Sets multiple parameters like TargetHost, Port, Community, MibModule and OID. If any of these parameters need not be set, then it should be given as null.

Parameters:
host - target host
port - target port
community - community name
mib - mib file
oid - OID
java.rmi.RemoteException

setParams

public void setParams(java.lang.String host,
                      java.lang.String port,
                      java.lang.String community,
                      java.lang.String mib,
                      java.lang.String[] oidlist)
               throws java.rmi.RemoteException
Sets multiple parameters like TargetHost, Port, Community, MibModule and OID list. If any of these parameters need not be set, then it should be given as null.

Parameters:
host - target host
port - target port
community - community name
mib - mib file
oidlist - a String array of OIDs
java.rmi.RemoteException

loadMibs

public void loadMibs(java.lang.String mibs)
              throws java.rmi.RemoteException
Loads the mibs specified by white-space separated list of mibs. If first SnmpTarget has been opened with applet parameter, then URLs will be used. MIB loading applies across all beans in this package, i.e. MIBs can be loaded in any of the bean instances, and will be available across all beans in this package, across the VM.

java.rmi.RemoteException

snmpGet

public java.lang.String snmpGet()
                         throws java.rmi.RemoteException
Queries the target and returns as a string the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetVariable

public SnmpVar snmpGetVariable()
                        throws java.rmi.RemoteException
Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetVariableBinding

public SnmpVarBind snmpGetVariableBinding()
                                   throws java.rmi.RemoteException
Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGet

public SnmpVar snmpGet(SnmpOID oid)
                throws java.rmi.RemoteException
Gets the SNMP variable identified by specified Object Identifier. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetList

public java.lang.String[] snmpGetList()
                               throws java.rmi.RemoteException
Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetVariables

public SnmpVar[] snmpGetVariables()
                           throws java.rmi.RemoteException
Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetVariableBindings

public SnmpVarBind[] snmpGetVariableBindings()
                                      throws java.rmi.RemoteException
Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetList

public SnmpVar[] snmpGetList(SnmpOID[] oids)
                      throws java.rmi.RemoteException
Gets the list of SNMP variables identified by the Object Identifier list stored in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNext

public java.lang.String snmpGetNext()
                             throws java.rmi.RemoteException
Queries the target and returns as a string the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNextVariable

public SnmpVar snmpGetNextVariable()
                            throws java.rmi.RemoteException
Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNextVariableBinding

public SnmpVarBind snmpGetNextVariableBinding()
                                       throws java.rmi.RemoteException
Queries the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNext

public SnmpVar snmpGetNext(SnmpOID oid)
                    throws java.rmi.RemoteException
Gets the SNMP variable identified by specified Object Identifier. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNextList

public java.lang.String[] snmpGetNextList()
                                   throws java.rmi.RemoteException
Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNextVariables

public SnmpVar[] snmpGetNextVariables()
                               throws java.rmi.RemoteException
Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNextVariableBindings

public SnmpVarBind[] snmpGetNextVariableBindings()
                                          throws java.rmi.RemoteException
Queries the agent and returns the list of SNMP variable bindings from the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpGetNextList

public SnmpVar[] snmpGetNextList(SnmpOID[] oids)
                          throws java.rmi.RemoteException
Gets the list of SNMP variables identified by the Object Identifier list stored in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSet

public java.lang.String snmpSet(java.lang.String value)
                         throws java.rmi.RemoteException
Performs an SNMP Set to the target using value specified of the first variable on the variable list. This method will fail if MIB with this variable is not loaded of this is not a leaf node in the MIB. Returns as a string the value returned by the target. Throws Exception if no OID specified earlier or in case of errors. Get error details using getErrorString().

java.rmi.RemoteException

snmpSet

public java.lang.String snmpSet(java.lang.String value,
                                byte type)
                         throws java.rmi.RemoteException
Performs an SNMP Set to the target of the first variable on the variable list using value specified. Returns as a string the value returned by the target. Throws Exception if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSetVariable

public SnmpVar snmpSetVariable(SnmpVar var)
                        throws java.rmi.RemoteException
Performs an SNMP Set with specified value to the target and returns the SNMP variable identified by the first Object Identifier stored in this SnmpTarget instance. Return null if no OID specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSetList

public java.lang.String[] snmpSetList(java.lang.String[] values)
                               throws java.rmi.RemoteException
Sets the list of SNMP variable bindings on the agent using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSetVariables

public SnmpVar[] snmpSetVariables(SnmpVar[] values)
                           throws java.rmi.RemoteException
Performs an SNMP set, with values specified, the list of SNMP variable bindings on the agent, using the Object Identifier list previously set in this SnmpTarget instance. Return null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSendTrap

public void snmpSendTrap(java.lang.String enterprise,
                         java.lang.String agenthost,
                         int genericType,
                         int specificType,
                         long uptime,
                         java.lang.String[] values)
                  throws java.rmi.RemoteException
Sends an SNMP trap, with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified. Returns null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSendTrap

public void snmpSendTrap(SnmpOID enterprise,
                         java.lang.String agenthost,
                         int genericType,
                         int specificType,
                         long uptime,
                         SnmpVar[] values)
                  throws java.rmi.RemoteException
Sends an SNMP trap, with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified. Returns null if no OIDs specified earlier or in case of errors. See error data for details, i.e. use getErrorString() to see the reason for failure.

java.rmi.RemoteException

snmpSendNotification

public void snmpSendNotification(long uptime,
                                 SnmpOID trapOid,
                                 SnmpVar[] values)
                          throws java.rmi.RemoteException
v2c and v3 only Sends an SNMPv2 notification pdu with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.

Parameters:
uptime - The sysUptime value. This is the first oid sent with the notification. The corresponding oid need not be present in the oidList.
values - Contains an array of SnmpVar values corresponding to the oids in the oidList.
trapOid - This should contain the oid corresponding to the snmpTrapOID.
Throws:
DataException - is thrown for invalid values.
java.rmi.RemoteException

snmpSendInformRequest

public java.lang.String[] snmpSendInformRequest(long uptime,
                                                java.lang.String trapOid,
                                                java.lang.String[] values)
                                         throws java.rmi.RemoteException
v2c and v3 only Sends an SNMPv2 inform pdu with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.

Parameters:
uptime - The sysUptime value. This is the first oid sent with the notification. The corresponding oid need not be present in the oidList.
values - Contains an array of string values corresponding to the oids in the oidList.
trapOid - This should contain the oid string corresponding to the snmpTrapOID.
Throws:
DataException - is thrown for invalid values.
java.rmi.RemoteException

snmpSendInformRequest

public SnmpVarBind[] snmpSendInformRequest(long uptime,
                                           SnmpOID trapOid,
                                           SnmpVar[] values)
                                    throws java.rmi.RemoteException
v2c and v3 only Sends an SNMPv2 inform pdu with parameters specified and variable bindings using object ids from the Object Identifier list previously set in this SnmpTarget instance, and the values specified.

Parameters:
uptime - The sysUptime value. This is the first oid sent with the notification. The corresponding oid need not be present in the oidList.
values - Contains an array of SnmpVar values corresponding to the oids in the oidList.
trapOid - This should contain the oid corresponding to the snmpTrapOID.
Throws:
DataException - is thrown for invalid values.
java.rmi.RemoteException

addObjectID

public int addObjectID(java.lang.String s)
                throws java.rmi.RemoteException
Adds an OID specified by the string to the OID list and returns the index of the entry.

java.rmi.RemoteException

addSnmpOID

public int addSnmpOID(SnmpOID oid)
               throws java.rmi.RemoteException
Adds an OID to the list of OIDs and returns the index of the added entry.

java.rmi.RemoteException

getObjectID

public java.lang.String getObjectID(int index)
                             throws java.rmi.RemoteException
Returns the object ID at the specified index as a String.

java.rmi.RemoteException

getObjectID

public java.lang.String getObjectID()
                             throws java.rmi.RemoteException
Returns the first object ID as a string.

java.rmi.RemoteException

setObjectID

public void setObjectID(java.lang.String s)
                 throws java.rmi.RemoteException
Sets the first object ID value based on specified string

java.rmi.RemoteException

setObjectID

public void setObjectID(int index,
                        java.lang.String s)
                 throws java.rmi.RemoteException
Sets the object ID value at index based on specified string

java.rmi.RemoteException

getObjectIDList

public java.lang.String[] getObjectIDList()
                                   throws java.rmi.RemoteException
Returns the list of object IDs as a string array

java.rmi.RemoteException

setObjectIDList

public void setObjectIDList(java.lang.String[] s)
                     throws java.rmi.RemoteException
Sets the list of object IDs based on the specified string array

java.rmi.RemoteException

getSnmpOID

public SnmpOID getSnmpOID()
                   throws java.rmi.RemoteException
Returns the first SnmpOID from the list of object IDs.

java.rmi.RemoteException

setDebug

public void setDebug(boolean debug)
              throws java.rmi.RemoteException
Enables debug output to be printed.

java.rmi.RemoteException

getMibModules

public java.lang.String getMibModules()
                               throws java.rmi.RemoteException
Gets the MIBs loaded in this applet/application - a white-space separated list of mib files.

java.rmi.RemoteException

setMibModules

public void setMibModules(java.lang.String mibs)
                   throws java.rmi.RemoteException
Sets the MIBs loaded in this applet/application - a white-space separated list of mib files.

java.rmi.RemoteException

setSnmpOID

public void setSnmpOID(SnmpOID oid)
                throws java.rmi.RemoteException
Sets the first SnmpOID in the list of object IDs.

java.rmi.RemoteException

getSnmpOIDList

public SnmpOID[] getSnmpOIDList()
                         throws java.rmi.RemoteException
Returns the list of object IDs as an array of SnmpOID instances.

java.rmi.RemoteException

setSnmpOIDList

public void setSnmpOIDList(SnmpOID[] list)
                    throws java.rmi.RemoteException
Sets the list of object IDs as the given array of SnmpOID instances.

java.rmi.RemoteException

getTargetHost

public java.lang.String getTargetHost()
                               throws java.rmi.RemoteException
Gets the hostname previously set on this target, or else, the default value.

java.rmi.RemoteException

setTargetHost

public void setTargetHost(java.lang.String s)
                   throws java.rmi.RemoteException
Sets the hostname of the remote SNMP entity.

java.rmi.RemoteException

getTargetPort

public int getTargetPort()
                  throws java.rmi.RemoteException
Gets the port number previously set on this target, or else, the default value.

java.rmi.RemoteException

setTargetPort

public void setTargetPort(int i)
                   throws java.rmi.RemoteException
Sets the port number of the remote SNMP entity.

java.rmi.RemoteException

getPrincipal

public java.lang.String getPrincipal()
                              throws java.rmi.RemoteException
v3 only Gets the SNMPv3 Principal previously set on this target, or else, the default value.

java.rmi.RemoteException

setPrincipal

public void setPrincipal(java.lang.String s)
                  throws java.rmi.RemoteException
v3 only Sets the SNMPv3 Principal.

java.rmi.RemoteException

getSecurityModel

public int getSecurityModel()
                     throws java.rmi.RemoteException
v3 only Gets the SNMPv3 securityModel previously set on this target, or else, the default value.

java.rmi.RemoteException

setSecurityModel

public void setSecurityModel(int secModel)
                      throws java.rmi.RemoteException
v3 only Sets the SNMPv3 Security Model.

java.rmi.RemoteException

initSecurityProvider

public void initSecurityProvider()
                          throws java.rmi.RemoteException
v3 only Initialises the SNMPv3 Security provider.

java.rmi.RemoteException

getAuthProtocol

public int getAuthProtocol()
                    throws java.rmi.RemoteException
v3 only Gets the SNMPv3 usmUser's Auth Protocol previously set on this target, or else, the default value.

java.rmi.RemoteException

setAuthProtocol

public void setAuthProtocol(int protocol)
                     throws java.rmi.RemoteException
v3 only Sets the SNMPv3 usmUser's Auth Protocol.

java.rmi.RemoteException

getAuthPassword

public java.lang.String getAuthPassword()
                                 throws java.rmi.RemoteException
v3 only Gets the SNMPv3 usmUser's Auth Password previously set on this target, or else, the default value.

java.rmi.RemoteException

setAuthPassword

public void setAuthPassword(java.lang.String password)
                     throws java.rmi.RemoteException
v3 only Sets the SNMPv3 usmUser's Auth Password.

java.rmi.RemoteException

getPrivProtocol

public int getPrivProtocol()
                    throws java.rmi.RemoteException
v3 only Gets the usmUserPrivProtocol previously set on this target, or else, the default value.

java.rmi.RemoteException

setPrivProtocol

public void setPrivProtocol(int privProtocol)
                     throws java.rmi.RemoteException
v3 only Sets the usmUserPrivProtocol.

java.rmi.RemoteException

getPrivPassword

public java.lang.String getPrivPassword()
                                 throws java.rmi.RemoteException
v3 only Gets the SNMPv3 usmUser's Privacy Password previously set on this target, or else, the default value.

java.rmi.RemoteException

setPrivPassword

public void setPrivPassword(java.lang.String password)
                     throws java.rmi.RemoteException
v3 only Sets the SNMPv3 usmUser's Privacy Password.

java.rmi.RemoteException

getContextName

public java.lang.String getContextName()
                                throws java.rmi.RemoteException
v3 only Gets the SNMPv3 Context name previously set on this target, or else, the default value.

java.rmi.RemoteException

setContextName

public void setContextName(java.lang.String cName)
                    throws java.rmi.RemoteException
v3 only Sets the SNMPv3 Context name.

java.rmi.RemoteException

getContextID

public java.lang.String getContextID()
                              throws java.rmi.RemoteException
v3 only Gets the SNMPv3 contextID previously set on this target, or else, the default value.

java.rmi.RemoteException

setContextID

public void setContextID(java.lang.String ctxtID)
                  throws java.rmi.RemoteException
v3 only Sets the SNMPv3 contextID.

java.rmi.RemoteException

getCommunity

public java.lang.String getCommunity()
                              throws java.rmi.RemoteException
Gets the community previously set on this target, or else, the default value.

java.rmi.RemoteException

setCommunity

public void setCommunity(java.lang.String s)
                  throws java.rmi.RemoteException
Sets the community.

java.rmi.RemoteException

getWriteCommunity

public java.lang.String getWriteCommunity()
                                   throws java.rmi.RemoteException
Gets the community used for Set requests previously set on this target, or else, the default value.

java.rmi.RemoteException

setWriteCommunity

public void setWriteCommunity(java.lang.String s)
                       throws java.rmi.RemoteException
Sets the community to be used for Set requests.

java.rmi.RemoteException

getTimeout

public int getTimeout()
               throws java.rmi.RemoteException
Gets the timeout value (in sec) previously set on this target, or else, the default timeout 5.

java.rmi.RemoteException

setTimeout

public void setTimeout(int i)
                throws java.rmi.RemoteException
Sets the timeout value in sec.

java.rmi.RemoteException

getRetries

public int getRetries()
               throws java.rmi.RemoteException
Gets the retries value previously set on this target, or else, the default retries 0.

java.rmi.RemoteException

setRetries

public void setRetries(int i)
                throws java.rmi.RemoteException
Sets the retries value. Default is 0.

java.rmi.RemoteException

getMaxRepetitions

public int getMaxRepetitions()
                      throws java.rmi.RemoteException
v2c and v3 only Gets the max-repetitions value for a GetBulk request previously set on this target, or else, the default value 50.

java.rmi.RemoteException

setMaxRepetitions

public void setMaxRepetitions(int i)
                       throws java.rmi.RemoteException
v2c and v3 only Sets the max-repetitions value to be used for a GetBulk request.

java.rmi.RemoteException

getNonRepeaters

public int getNonRepeaters()
                    throws java.rmi.RemoteException
v2c and v3 only Gets the non-repeaters value for a GetBulk request previously set on this target, or else, the default value 0.

java.rmi.RemoteException

setNonRepeaters

public void setNonRepeaters(int i)
                     throws java.rmi.RemoteException
v2c and v3 only Sets the non-repeaters value to be used for a GetBulk request.

java.rmi.RemoteException

getSnmpVersion

public int getSnmpVersion()
                   throws java.rmi.RemoteException
v2c and v3 only Gets the SNMP version previously set on this target, or else, the default version. 0 is version 1 (default) and 1 is version 2C.

java.rmi.RemoteException

setSnmpVersion

public void setSnmpVersion(int i)
                    throws java.rmi.RemoteException
v2c and v3 only Sets the SNMP version. 0 is version 1 (default) and 1 is version 2C.

java.rmi.RemoteException

getErrorString

public java.lang.String getErrorString()
                                throws java.rmi.RemoteException
Gets the error string corresponding to the last request.

java.rmi.RemoteException

getErrorCode

public int getErrorCode()
                 throws java.rmi.RemoteException
Gets the error code corresponding to the last request.

java.rmi.RemoteException

getAttemptPartial

public boolean getAttemptPartial()
                          throws java.rmi.RemoteException
Returns the boolean state of whether this target will try to get partial data from an agent, in case of a multi-variable request.

java.rmi.RemoteException

setAttemptPartial

public void setAttemptPartial(boolean b)
                       throws java.rmi.RemoteException
Sets the boolean state of whether this target will try to get partial data from an agent, in case of a multi-variable request.

java.rmi.RemoteException

setAttemptComplete

public void setAttemptComplete(boolean flag)
                        throws java.rmi.RemoteException
Enables getting complete data from the agent by splitting the varBindList into multiple requests. By default PDU-splitting is disabled.

java.rmi.RemoteException

getAttemptComplete

public boolean getAttemptComplete()
                           throws java.rmi.RemoteException
Returns a boolean indicating if PDU-splitting (splitting the varBindList into multiple requests) is enabled to get the complete data. By default, PDU-splitting is disabled.

java.rmi.RemoteException

getVarBindCount

public int getVarBindCount()
                    throws java.rmi.RemoteException
Returns the number of varBinds used with the split-PDU. Default value is 0.

java.rmi.RemoteException

setVarBindCount

public void setVarBindCount(int count)
                     throws java.rmi.RemoteException
Sets the number of varBinds to be filled per request to get complete data from agent, in case of splitting the varBindList into multiple requests. Default value is 0.

java.rmi.RemoteException

getSendTimeoutEvents

public boolean getSendTimeoutEvents()
                             throws java.rmi.RemoteException
Returns the boolean state of whether this target will send timeout events to a registered listener.

java.rmi.RemoteException

setSendTimeoutEvents

public void setSendTimeoutEvents(boolean b)
                          throws java.rmi.RemoteException
Sets the boolean state of whether this target will send timeout events to a registered listener.

java.rmi.RemoteException

addResultListener

public void addResultListener(ResultListener l)
                       throws java.rmi.RemoteException
Adds a listener for events from this target. The listener listens for events from any or all SNMP requests.

java.rmi.RemoteException

removeResultListener

public void removeResultListener(ResultListener l)
                          throws java.rmi.RemoteException
Removes a listener for events from this target.

java.rmi.RemoteException

getMibOperations

public MibOperations getMibOperations()
                               throws java.rmi.RemoteException
Gets the MibOperations object reference. This allows using additonal MibOperations functions if needed.

java.rmi.RemoteException

snmpGetAllList

public java.lang.String[][] snmpGetAllList()
                                    throws java.rmi.RemoteException
Gets all instances of variables in the OID list. Returns variables as a two dimensional array of strings Useful for small tables. Returns null if no OIDs specified earlier or in case of errors. Get error details using getErrorString().

java.rmi.RemoteException

snmpGetAllVariables

public SnmpVar[][] snmpGetAllVariables()
                                throws java.rmi.RemoteException
Gets all instances of variables in the OID list. Returns variables as a two dimensional array of SnmpVar's Useful for small tables. Returns null if no OIDs specified earlier or in case of errors. Get error details using getErrorString().

java.rmi.RemoteException

snmpGetAllVariableBindings

public SnmpVarBind[][] snmpGetAllVariableBindings()
                                           throws java.rmi.RemoteException
Gets all instances of variables in the OID list. Returns variables as a two dimensional array of SnmpVarBind's Useful for small tables. Returns null if no OIDs specified earlier or in case of errors. Get error details using getErrorString().

java.rmi.RemoteException

snmpGetBulkList

public java.lang.String[][] snmpGetBulkList()
                                     throws java.rmi.RemoteException
v2c and v3 only Gets bulk on list of variables in the OID list. Available only for SNMPv2c and SNMPv3 cases. v2c and v3 only Returns String-valued variables as a two dimensional array of String's. Returns null if no OIDs specified earlier or in case of errors. Get error details using getErrorString().

Please see RFC 1905 if you're not familiar with getbulk. Beyond the first set of non-repeater OIDS, i.e. OIDs that want only a single next value, the data can be viewed a table, where we're getting rows upto "max repetitions" rows. The returned data is composed of a two-dimensional array where the first "nonRepeaters" columns have only the first data element filled in. The remaining have the rows filled in as expected. Typically, non-repeaters is 0, and we'd be returning a completely filled-in 2-D array of values.

The OID List after this request is set to the last set of OIDs in the returned bulk data, except for the initial non-repeaters for which it is set to the first and only returned OID.

java.rmi.RemoteException

snmpGetBulkVariables

public SnmpVar[][] snmpGetBulkVariables()
                                 throws java.rmi.RemoteException
v2c and v3 only Gets bulk on list of variables in the OID list. Available only for SNMPv2c and SNMPv3 cases. v2c and v3 only Returns variables as a two dimensional array of SnmpVar's. Returns null if no OIDs specified earlier or in case of errors. Get error details using getErrorString().

Please see RFC 1905 if you're not familiar with getbulk. Beyond the first set of non-repeater OIDS, i.e. OIDs that want only a single next value, the data can be viewed a table, where we're getting rows upto "max repetitions" rows. The returned data is composed of a two-dimensional array where the first "nonRepeaters" columns have only the first data element filled in. The remaining have the rows filled in as expected. Typically, non-repeaters is 0, and we'd be returning a completely filled-in 2-D array of values.

The OID List after this request is set to the last set of OIDs in the returned bulk data, except for the initial non-repeaters for which it is set to the first and only returned OID.

java.rmi.RemoteException

snmpGetBulkVariableBindings

public SnmpVarBind[][] snmpGetBulkVariableBindings()
                                            throws java.rmi.RemoteException
v2c and v3 only Gets bulk on list of variables in the OID list. Available only for SNMPv2c and SNMPv3 cases. v2c and v3 only Returns variable bindings as a two dimensional array of SnmpVarBind's. Returns null if no OIDs specified earlier or in case of errors. Get error details using getErrorString().

Please see RFC 1905 if you're not familiar with getbulk. Beyond the first set of non-repeater OIDS, i.e. OIDs that want only a single next value, the data can be viewed a table, where we're getting rows upto "max repetitions" rows. The returned data is composed of a two-dimensional array where the first "nonRepeaters" columns have only the first data element filled in. The remaining have the rows filled in as expected. Typically, non-repeaters is 0, and we'd be returning a completely filled-in 2-D array of values.

The OID List after this request is set to the last set of OIDs in the returned bulk data, except for the initial non-repeaters for which it is set to the first and only returned OID.

java.rmi.RemoteException

isInSubTree

public boolean isInSubTree(SnmpOID rootoid,
                           SnmpOID objid)
                    throws java.rmi.RemoteException
Checks if objid has rootoid as an ancestor, and returns true if it does. This performs a straightforward compare to see if the object-id starts with the rootoid. It is useful for walking through a column in which a walk could be terminated when the returned object id is not in the sub-tree of the column oid.

java.rmi.RemoteException

getSecurityLevel

public java.lang.String getSecurityLevel()
                                  throws java.rmi.RemoteException
v3 only Gets the SNMPv3 SecurityLevel

java.rmi.RemoteException

setSecurityLevel

public void setSecurityLevel(byte sLevel)
                      throws java.rmi.RemoteException
v3 only Sets the SNMPv3 SecurityLevel

java.rmi.RemoteException

isSerialize

public boolean isSerialize()
                    throws java.rmi.RemoteException
v3 only Returns the status of Serialization of v3 tables ( USMUserTable and SnmpEngineTable )

java.rmi.RemoteException

create_v3_tables

public void create_v3_tables()
                      throws java.rmi.RemoteException
v3 only Initializes v3 parameters.

java.rmi.RemoteException

setMaxNumRows

public void setMaxNumRows(int maxRows)
                   throws java.rmi.RemoteException
Sets the maximum number of rows that can be processed, default value is 1000.

java.rmi.RemoteException

getMaxNumRows

public int getMaxNumRows()
                  throws java.rmi.RemoteException
Gets the maximum number of rows that can be processed, default value is 1000.

java.rmi.RemoteException

isSupportedSecurityModel

public boolean isSupportedSecurityModel(int secModel)
                                 throws java.rmi.RemoteException
v3 only Specifies if a particular security model is supported or not. Returns true if the security model is supported. False otherwise.

Parameters:
secModel - The secuirty model number which needs to be checked if it is supported.
Returns:
true if the specified securitymodel is supported. False otherwise.
java.rmi.RemoteException

manage_v3_tables

public void manage_v3_tables()
                      throws java.rmi.RemoteException
v3 only Method to create new users and add them to userTable in USMUserTable. If the v3 parameters specified are already present in the userTable, it modifies the entry. However the UserName cannot be modified.

java.rmi.RemoteException

addLogClient

public void addLogClient(LogInterface client)
                  throws java.rmi.RemoteException
Adds the Log client to which the target has to redirect the log messages.

java.rmi.RemoteException

getExceptionCode

public int getExceptionCode()
                     throws java.rmi.RemoteException
v2c and v3 only Gets the exception code for the last request. Before sending any request the exception code will be -1.

Returns:
the exception code in case of exception and 0 if there is no exception.
java.rmi.RemoteException

removeLogClient

public void removeLogClient()
                     throws java.rmi.RemoteException
Removes the Log client for which the target has been registered to redirect the log Messages.

java.rmi.RemoteException

setTimeoutInMilliSec

public void setTimeoutInMilliSec(int time)
                          throws java.rmi.RemoteException
Sets the timeout value which should be given in milliseconds.

Parameters:
time - The timeout value to be set in milliseconds.
java.rmi.RemoteException

getTimeoutInMilliSec

public int getTimeoutInMilliSec()
                         throws java.rmi.RemoteException
Returns the timeout value in milliseconds.

Returns:
the timeout value in milliseconds.
java.rmi.RemoteException


Copyright (c)ZOHO Corp. 1996-2012