org.snmp4j.tools.console
Class SnmpRequest

java.lang.Object
  extended by org.snmp4j.tools.console.SnmpRequest
All Implemented Interfaces:
java.util.EventListener, CommandResponder, PDUFactory

public class SnmpRequest
extends java.lang.Object
implements CommandResponder, PDUFactory

The SnmpRequest application is an example implementation of most of the SNMP4J features. It can be used to send SNMP requests to a target or to listen for traps/notifications and inform requests.

Version:
1.9
Author:
Frank Fock

Field Summary
static int CVS_TABLE
           
static int DEFAULT
           
static int LISTEN
           
protected  int operation
           
static int SNAPSHOT_CREATION
           
static int SNAPSHOT_DUMP
           
static int TABLE
           
static int TIME_BASED_CVS_TABLE
           
static int WALK
           
 
Constructor Summary
SnmpRequest(java.lang.String[] args)
           
 
Method Summary
 PDU createPDU(Target target)
          Create a PDU instance for the supplied target.
 Address getAddress()
           
 OctetString getAuthoritativeEngineID()
           
 OctetString getAuthPassphrase()
           
 OID getAuthProtocol()
           
 OctetString getCommunity()
           
 OctetString getContextEngineID()
           
 OctetString getContextName()
           
 OID getLowerBoundIndex()
           
 int getMaxRepetitions()
           
 int getNonRepeaters()
           
 int getNumDispatcherThreads()
           
 int getOperation()
           
 int getPduType()
           
 OctetString getPrivPassphrase()
           
 OID getPrivProtocol()
           
 int getRetries()
           
 OctetString getSecurityName()
           
 TimeTicks getSysUpTime()
           
 Target getTarget()
           
 int getTimeout()
           
 OID getTrapOID()
           
 OID getUpperBoundIndex()
           
 java.util.Vector getVbs()
           
 int getVersion()
           
 boolean isUseDenseTableOperation()
           
 void listen()
           
static void main(java.lang.String[] args)
           
protected static void printReport(PDU response)
           
protected static void printUsage()
          printUsage
protected static void printVariableBindings(PDU response)
           
protected static void printVersion()
           
 void processPdu(CommandResponderEvent e)
          Process an incoming request, report or notification PDU.
 PDU send()
           
 void setAddress(Address address)
           
 void setAuthoritativeEngineID(OctetString authoritativeEngineID)
           
 void setAuthPassphrase(OctetString authPassphrase)
           
 void setAuthProtocol(OID authProtocol)
           
 void setCommunity(OctetString community)
           
 void setContextEngineID(OctetString contextEngineID)
           
 void setContextName(OctetString contextName)
           
 void setLowerBoundIndex(OID lowerBoundIndex)
           
 void setMaxRepetitions(int maxRepetitions)
           
 void setNonRepeaters(int nonRepeaters)
           
 void setNumDispatcherThreads(int numDispatcherThreads)
           
 void setOperation(int operation)
           
 void setPduType(int pduType)
           
 void setPrivPassphrase(OctetString privPassphrase)
           
 void setPrivProtocol(OID privProtocol)
           
 void setRetries(int retries)
           
 void setSecurityName(OctetString securityName)
           
 void setSysUpTime(TimeTicks sysUpTime)
           
 void setTarget(Target target)
           
 void setTimeout(int timeout)
           
 void setTrapOID(OID trapOID)
           
 void setUpperBoundIndex(OID upperBoundIndex)
           
 void setUseDenseTableOperation(boolean useDenseTableOperation)
           
 void setVbs(java.util.Vector vbs)
           
 void setVersion(int version)
           
 void table()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT

public static final int DEFAULT
See Also:
Constant Field Values

WALK

public static final int WALK
See Also:
Constant Field Values

LISTEN

public static final int LISTEN
See Also:
Constant Field Values

TABLE

public static final int TABLE
See Also:
Constant Field Values

CVS_TABLE

public static final int CVS_TABLE
See Also:
Constant Field Values

TIME_BASED_CVS_TABLE

public static final int TIME_BASED_CVS_TABLE
See Also:
Constant Field Values

SNAPSHOT_CREATION

public static final int SNAPSHOT_CREATION
See Also:
Constant Field Values

SNAPSHOT_DUMP

public static final int SNAPSHOT_DUMP
See Also:
Constant Field Values

operation

protected int operation
Constructor Detail

SnmpRequest

public SnmpRequest(java.lang.String[] args)
Method Detail

getPduType

public int getPduType()

getVersion

public int getVersion()

getVbs

public java.util.Vector getVbs()

isUseDenseTableOperation

public boolean isUseDenseTableOperation()

getUpperBoundIndex

public OID getUpperBoundIndex()

getTrapOID

public OID getTrapOID()

getTimeout

public int getTimeout()

getTarget

public Target getTarget()

getSysUpTime

public TimeTicks getSysUpTime()

getSecurityName

public OctetString getSecurityName()

getRetries

public int getRetries()

getPrivProtocol

public OID getPrivProtocol()

getPrivPassphrase

public OctetString getPrivPassphrase()

getOperation

public int getOperation()

getNumDispatcherThreads

public int getNumDispatcherThreads()

getNonRepeaters

public int getNonRepeaters()

getMaxRepetitions

public int getMaxRepetitions()

getLowerBoundIndex

public OID getLowerBoundIndex()

getContextName

public OctetString getContextName()

getContextEngineID

public OctetString getContextEngineID()

getCommunity

public OctetString getCommunity()

getAuthoritativeEngineID

public OctetString getAuthoritativeEngineID()

getAuthProtocol

public OID getAuthProtocol()

getAuthPassphrase

public OctetString getAuthPassphrase()

getAddress

public Address getAddress()

listen

public void listen()
            throws java.io.IOException
Throws:
java.io.IOException

send

public PDU send()
         throws java.io.IOException
Throws:
java.io.IOException

printVersion

protected static void printVersion()

printUsage

protected static void printUsage()
printUsage


printVariableBindings

protected static void printVariableBindings(PDU response)

printReport

protected static void printReport(PDU response)

processPdu

public void processPdu(CommandResponderEvent e)
Description copied from interface: CommandResponder
Process an incoming request, report or notification PDU.

Specified by:
processPdu in interface CommandResponder
Parameters:
e - a CommandResponderEvent instance containing the PDU to process and some additional information returned by the message processing model that decoded the SNMP message.

createPDU

public PDU createPDU(Target target)
Description copied from interface: PDUFactory
Create a PDU instance for the supplied target. The created PDU has to be compliant to the SNMP version defined by the supplied target. For example, a SNMPv3 target requires a ScopedPDU instance.

Specified by:
createPDU in interface PDUFactory
Parameters:
target - the Target where the PDU to be created will be sent.
Returns:
PDU a PDU instance that is compatible with the supplied target.

table

public void table()
           throws java.io.IOException
Throws:
java.io.IOException

main

public static void main(java.lang.String[] args)

setAddress

public void setAddress(Address address)

setVersion

public void setVersion(int version)

setVbs

public void setVbs(java.util.Vector vbs)

setUseDenseTableOperation

public void setUseDenseTableOperation(boolean useDenseTableOperation)

setUpperBoundIndex

public void setUpperBoundIndex(OID upperBoundIndex)

setTrapOID

public void setTrapOID(OID trapOID)

setTimeout

public void setTimeout(int timeout)

setTarget

public void setTarget(Target target)

setSysUpTime

public void setSysUpTime(TimeTicks sysUpTime)

setSecurityName

public void setSecurityName(OctetString securityName)

setRetries

public void setRetries(int retries)

setPrivProtocol

public void setPrivProtocol(OID privProtocol)

setPrivPassphrase

public void setPrivPassphrase(OctetString privPassphrase)

setPduType

public void setPduType(int pduType)

setOperation

public void setOperation(int operation)

setNumDispatcherThreads

public void setNumDispatcherThreads(int numDispatcherThreads)

setNonRepeaters

public void setNonRepeaters(int nonRepeaters)

setMaxRepetitions

public void setMaxRepetitions(int maxRepetitions)

setLowerBoundIndex

public void setLowerBoundIndex(OID lowerBoundIndex)

setContextName

public void setContextName(OctetString contextName)

setContextEngineID

public void setContextEngineID(OctetString contextEngineID)

setCommunity

public void setCommunity(OctetString community)

setAuthoritativeEngineID

public void setAuthoritativeEngineID(OctetString authoritativeEngineID)

setAuthProtocol

public void setAuthProtocol(OID authProtocol)

setAuthPassphrase

public void setAuthPassphrase(OctetString authPassphrase)

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.