| Package | Description |
|---|---|
| org.snmp4j |
Provides classes and interfaces for creating, sending, and receiving SNMP
messages.
|
| org.snmp4j.event |
Provides classes and interfaces for SNMP4J event processing.
|
| org.snmp4j.mp |
Provides classes and interfaces for the SNMP message processing.
|
| org.snmp4j.tools.console | |
| org.snmp4j.util |
Contains table retrieval utilities and multi-threading support classes as
well as miscellaneous utility classes.
|
| Modifier and Type | Class and Description |
|---|---|
class |
PDUv1
The
PDUv1 represents SNMPv1 PDUs. |
class |
ScopedPDU
The
ScopedPDU class represents a SNMPv3 scoped PDU. |
| Modifier and Type | Method and Description |
|---|---|
PDU |
MutablePDU.getPdu() |
PDU |
CommandResponderEvent.getPDU() |
PDU |
Snmp.sendPDU(PDU pdu,
Target target)
Deprecated.
This method has been deprecated because it does not return
the transport address of the entity (target) that sent the response.
Please use
Snmp.send(PDU pdu, Target target) instead. It returns
a ResponseEvent object holding the response PDU and transport
address of a successfully received response. This method will be supported
until v2.0. |
| Modifier and Type | Method and Description |
|---|---|
void |
Snmp.cancel(PDU request,
ResponseListener listener) |
void |
Session.cancel(PDU request,
ResponseListener listener)
Cancels an asynchronous request.
|
protected void |
MessageDispatcherImpl.checkOutgoingMsg(Address transportAddress,
int messageProcessingModel,
PDU pdu)
Checks outgoing messages for consistency between PDU and target used.
|
ResponseEvent |
Snmp.get(PDU pdu,
Target target)
Sends a GET request to a target.
|
void |
Snmp.get(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Asynchronously sends a GET request
PDU to the given target. |
ResponseEvent |
Snmp.getBulk(PDU pdu,
Target target)
Sends a GETBULK request to a target.
|
void |
Snmp.getBulk(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Asynchronously sends a GETBULK request
PDU to the given
target. |
ResponseEvent |
Snmp.getNext(PDU pdu,
Target target)
Sends a GETNEXT request to a target.
|
void |
Snmp.getNext(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Asynchronously sends a GETNEXT request
PDU to the given
target. |
ResponseEvent |
Snmp.inform(PDU pdu,
Target target)
Sends an INFORM request to a target.
|
void |
Snmp.inform(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Asynchronously sends an INFORM request
PDU to the given
target. |
void |
Snmp.notify(PDU pdu,
Target target)
Sends a SNMPv2c or SNMPv3 notification to a target.
|
int |
MessageDispatcherImpl.returnResponsePdu(int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation) |
int |
MessageDispatcher.returnResponsePdu(int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation)
Returns a response PDU to the sender of the corresponding request PDU.
|
ResponseEvent |
Snmp.send(PDU pdu,
Target target) |
ResponseEvent |
Session.send(PDU pdu,
Target target)
Sends a
PDU to the given target and returns the received
response PDU. |
void |
Snmp.send(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener) |
void |
Session.send(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Asynchronously sends a
PDU to the given target. |
ResponseEvent |
Snmp.send(PDU pdu,
Target target,
TransportMapping transport)
Sends a
PDU to the given target and if the PDU
is a confirmed request, then the received response is returned
synchronously. |
ResponseEvent |
Session.send(PDU pdu,
Target target,
TransportMapping transport)
Sends a
PDU to the given target and returns the received
response PDU encapsulated in a ResponseEvent
object that also includes:
the transport address of the response sending peer,
the Target information of the target,
the request PDU,
the response PDU (if any). |
void |
Snmp.send(PDU pdu,
Target target,
TransportMapping transport,
Object userHandle,
ResponseListener listener) |
void |
Session.send(PDU pdu,
Target target,
TransportMapping transport,
Object userHandle,
ResponseListener listener)
Asynchronously sends a
PDU to the given target. |
protected PduHandle |
Snmp.sendMessage(PDU pdu,
Target target,
TransportMapping transport,
PduHandleCallback pduHandleCallback)
Actually sends a PDU to a target and returns a handle for the sent PDU.
|
PduHandle |
MessageDispatcherImpl.sendPdu(Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse) |
PduHandle |
MessageDispatcher.sendPdu(Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse)
Sends a PDU to the supplied transport address.
|
PDU |
Snmp.sendPDU(PDU pdu,
Target target)
Deprecated.
This method has been deprecated because it does not return
the transport address of the entity (target) that sent the response.
Please use
Snmp.send(PDU pdu, Target target) instead. It returns
a ResponseEvent object holding the response PDU and transport
address of a successfully received response. This method will be supported
until v2.0. |
void |
Snmp.sendPDU(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Deprecated.
Please use
Snmp.send(PDU pdu, Target target, Object
userHandle, ResponseListener listener) instead. It has exactly
the same function but follows the new naming scheme. This method
will be supported until v2.0. |
PduHandle |
MessageDispatcherImpl.sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse) |
PduHandle |
MessageDispatcher.sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse)
Sends a PDU to the supplied transport address.
|
PduHandle |
MessageDispatcherImpl.sendPdu(TransportMapping transport,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandleCallback pduHandleCallback) |
PduHandle |
MessageDispatcher.sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandleCallback callback)
Sends a PDU to the supplied transport address and returns the
PduHandle that uniquely identifies the request as response
after the request has been sent and otional, if a
PduHandleCallback is given, it returns also the
PduHandle just before the request is sent through the
the callback interface. |
ResponseEvent |
Snmp.set(PDU pdu,
Target target)
Sends a SET request to a target.
|
void |
Snmp.set(PDU pdu,
Target target,
Object userHandle,
ResponseListener listener)
Asynchronously sends a SET request
PDU to the given target. |
void |
MutablePDU.setPdu(PDU pdu) |
void |
CommandResponderEvent.setPDU(PDU pdu) |
| Constructor and Description |
|---|
CommandResponderEvent(MessageDispatcher messageDispatcher,
TransportMapping transportMapping,
Address sourceAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PduHandle pduHandle,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference)
Constructs an event for processing an incoming request or notification PDU.
|
PDU(PDU other)
Copy constructor.
|
| Modifier and Type | Method and Description |
|---|---|
PDU |
ResponseEvent.getRequest()
Gets the request PDU.
|
PDU |
ResponseEvent.getResponse()
Gets the response PDU.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
ResponseEvent.setRequest(PDU request) |
protected void |
ResponseEvent.setResponse(PDU response) |
| Constructor and Description |
|---|
ResponseEvent(Object source,
Address peerAddress,
PDU request,
PDU response,
Object userObject)
Creates an
ResponseEvent instance. |
ResponseEvent(Object source,
Address peerAddress,
PDU request,
PDU response,
Object userObject,
Exception error)
Creates an
ResponseEvent instance with an exception object
indicating a message processing error. |
| Modifier and Type | Method and Description |
|---|---|
PDU |
MPv3.createPDU(Target target)
Creates a PDU class that is used to parse incoming SNMP messages.
|
| Modifier and Type | Method and Description |
|---|---|
int |
MPv3.prepareOutgoingMessage(Address transportAddress,
int maxMessageSize,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandle sendPduHandle,
Address destTransportAddress,
BEROutputStream outgoingMessage) |
int |
MPv2c.prepareOutgoingMessage(Address transportAddress,
int maxMessageSize,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandle sendPduHandle,
Address destTransportAddress,
BEROutputStream outgoingMessage) |
int |
MPv1.prepareOutgoingMessage(Address transportAddress,
int maxMessageSize,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandle sendPduHandle,
Address destTransportAddress,
BEROutputStream outgoingMessage) |
int |
MessageProcessingModel.prepareOutgoingMessage(Address transportAddress,
int maxMsgSize,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandle sendPduHandle,
Address destTransportAddress,
BEROutputStream outgoingMessage)
Prepares an outgoing message as defined in RFC3412 §7.1.
|
int |
MPv3.prepareResponseMessage(int messageProcessingModel,
int maxMessageSize,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation,
BEROutputStream outgoingMessage) |
int |
MPv2c.prepareResponseMessage(int messageProcessingModel,
int maxMessageSize,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation,
BEROutputStream outgoingMessage) |
int |
MPv1.prepareResponseMessage(int messageProcessingModel,
int maxMessageSize,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation,
BEROutputStream outgoingMessage) |
int |
MessageProcessingModel.prepareResponseMessage(int messageProcessingModel,
int maxMsgSize,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation,
BEROutputStream outgoingMessage)
Prepares a response message as defined in RFC3412 §7.1.
|
| Modifier and Type | Method and Description |
|---|---|
PDU |
SnmpRequest.createPDU(Target target) |
PDU |
SnmpRequest.send() |
| Modifier and Type | Method and Description |
|---|---|
protected static void |
SnmpRequest.printReport(PDU response) |
protected static void |
SnmpRequest.printVariableBindings(PDU response) |
| Modifier and Type | Field and Description |
|---|---|
protected PDU |
RetrievalEvent.reportPDU |
| Modifier and Type | Method and Description |
|---|---|
static PDU |
DefaultPDUFactory.createPDU(int targetVersion)
Create a
PDU instance for the specified SNMP version. |
PDU |
SnmpConfigurator.InnerPDUFactory.createPDU(Target target) |
PDU |
PDUFactory.createPDU(Target target)
Create a
PDU instance for the supplied target. |
PDU |
DefaultPDUFactory.createPDU(Target target)
Create a
PDU instance for the supplied target. |
static PDU |
DefaultPDUFactory.createPDU(Target target,
int pduType)
Create a
PDU instance for the supplied target. |
PDU |
RetrievalEvent.getReportPDU()
Gets the report PDU associated with this event.
|
| Modifier and Type | Method and Description |
|---|---|
int |
MultiThreadedMessageDispatcher.returnResponsePdu(int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
int maxSizeResponseScopedPDU,
StateReference stateReference,
StatusInformation statusInformation) |
PduHandle |
MultiThreadedMessageDispatcher.sendPdu(Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse) |
PduHandle |
MultiThreadedMessageDispatcher.sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse) |
PduHandle |
MultiThreadedMessageDispatcher.sendPdu(TransportMapping transportMapping,
Address transportAddress,
int messageProcessingModel,
int securityModel,
byte[] securityName,
int securityLevel,
PDU pdu,
boolean expectResponse,
PduHandleCallback callback) |
protected void |
TableUtils.TableRequest.sendRequest(PDU pdu,
Target target,
Integer startCol) |
| Constructor and Description |
|---|
RetrievalEvent(Object source,
Object userObject,
PDU report)
Creates a retrieval event with a report PDU.
|
TableEvent(Object source,
Object userObject,
PDU report)
Creates a table event with a report PDU.
|
TreeEvent(Object source,
Object userObject,
PDU report) |
Copyright © 2014 SNMP4J.org. All rights reserved.