Package org.snmp4j.tools.console
Class SnmpRequest
java.lang.Object
org.snmp4j.tools.console.SnmpRequest
- All Implemented Interfaces:
EventListener,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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intprotected intstatic final intstatic final intstatic final intstatic final intstatic final int -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreatePDU(MessageProcessingModel messageProcessingModel) Creates aPDUinstance that is compatible with the given SNMP version (message processing model).Creates aPDUinstance for the supplied target.intintintintintintintVector<? extends VariableBinding>getVbs()intbooleanvoidlisten()static voidprotected static voidprintReport(PDU response) protected static voidprintUsageprotected static voidprintVariableBindings(PDU response) protected static voidvoidProcess an incoming request, report or notification PDU.send()voidsetAddress(Address address) voidsetAuthoritativeEngineID(OctetString authoritativeEngineID) voidsetAuthPassphrase(OctetString authPassphrase) voidsetAuthProtocol(OID authProtocol) voidsetCommunity(OctetString community) voidsetContextEngineID(OctetString contextEngineID) voidsetContextName(OctetString contextName) voidsetLowerBoundIndex(OID lowerBoundIndex) voidsetMaxRepetitions(int maxRepetitions) voidsetNonRepeaters(int nonRepeaters) voidsetNumDispatcherThreads(int numDispatcherThreads) voidsetOperation(int operation) voidsetPduType(int pduType) voidsetPrivPassphrase(OctetString privPassphrase) voidsetPrivProtocol(OID privProtocol) voidsetRetries(int retries) voidsetSecurityName(OctetString securityName) voidsetSysUpTime(TimeTicks sysUpTime) voidvoidsetTimeout(int timeout) voidsetTrapOID(OID trapOID) voidsetUpperBoundIndex(OID upperBoundIndex) voidsetUseDenseTableOperation(boolean useDenseTableOperation) voidsetVbs(Vector<VariableBinding> vbs) voidsetVersion(int version) voidtable()
-
Field Details
-
DEFAULT
public static final int DEFAULT- See Also:
-
WALK
public static final int WALK- See Also:
-
LISTEN
public static final int LISTEN- See Also:
-
TABLE
public static final int TABLE- See Also:
-
CVS_TABLE
public static final int CVS_TABLE- See Also:
-
TIME_BASED_CVS_TABLE
public static final int TIME_BASED_CVS_TABLE- See Also:
-
SNAPSHOT_CREATION
public static final int SNAPSHOT_CREATION- See Also:
-
SNAPSHOT_DUMP
public static final int SNAPSHOT_DUMP- See Also:
-
operation
protected int operation
-
-
Constructor Details
-
SnmpRequest
-
-
Method Details
-
getPduType
public int getPduType() -
getVersion
public int getVersion() -
getVbs
-
isUseDenseTableOperation
public boolean isUseDenseTableOperation() -
getUpperBoundIndex
-
getTrapOID
-
getTimeout
public int getTimeout() -
getTarget
-
getSysUpTime
-
getSecurityName
-
getRetries
public int getRetries() -
getPrivProtocol
-
getPrivPassphrase
-
getOperation
public int getOperation() -
getNumDispatcherThreads
public int getNumDispatcherThreads() -
getNonRepeaters
public int getNonRepeaters() -
getMaxRepetitions
public int getMaxRepetitions() -
getLowerBoundIndex
-
getContextName
-
getContextEngineID
-
getCommunity
-
getAuthoritativeEngineID
-
getAuthProtocol
-
getAuthPassphrase
-
getAddress
-
listen
- Throws:
IOException
-
send
- Throws:
IOException
-
printVersion
protected static void printVersion() -
printUsage
protected static void printUsage()printUsage -
printVariableBindings
-
printReport
-
processPdu
Description copied from interface:CommandResponderProcess an incoming request, report or notification PDU.- Specified by:
processPduin interfaceCommandResponder- Parameters:
e- aCommandResponderEventinstance containing the PDU to process and some additional information returned by the message processing model that decoded the SNMP message.
-
createPDU
Description copied from interface:PDUFactoryCreates aPDUinstance 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:
createPDUin interfacePDUFactory- Parameters:
target- theTargetwhere the PDU to be created will be sent.- Returns:
- PDU a PDU instance that is compatible with the supplied target.
-
createPDU
Description copied from interface:PDUFactoryCreates aPDUinstance that is compatible with the given SNMP version (message processing model).- Specified by:
createPDUin interfacePDUFactory- Parameters:
messageProcessingModel- aMessageProcessingModelinstance.- Returns:
- a
PDUinstance that is compatible with the given SNMP version (message processing model).
-
table
- Throws:
IOException
-
main
-
setAddress
-
setVersion
public void setVersion(int version) -
setVbs
-
setUseDenseTableOperation
public void setUseDenseTableOperation(boolean useDenseTableOperation) -
setUpperBoundIndex
-
setTrapOID
-
setTimeout
public void setTimeout(int timeout) -
setTarget
-
setSysUpTime
-
setSecurityName
-
setRetries
public void setRetries(int retries) -
setPrivProtocol
-
setPrivPassphrase
-
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
-
setContextName
-
setContextEngineID
-
setCommunity
-
setAuthoritativeEngineID
-
setAuthProtocol
-
setAuthPassphrase
-