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.security |
Provides classes and interfaces for authentication and privacy of SNMP(v3)
messages.
|
org.snmp4j.smi |
Provides classes for the representation of SMIv1/v2 data types (which also
includes some basic ASN.1 primitive data types).
|
org.snmp4j.tools.console | |
org.snmp4j.transport |
Provides transport protocol mappings for SNMP.
|
org.snmp4j.transport.tls | |
org.snmp4j.util |
Contains table retrieval utilities and multi-threading support classes as
well as miscellaneous utility classes.
|
Modifier and Type | Interface | Description |
---|---|---|
interface |
TransportMapping<A extends Address> |
The
TransportMapping defines the common interface for SNMP
transport mappings. |
Modifier and Type | Method | Description |
---|---|---|
Address |
AbstractTarget.getAddress() |
Gets the address of this target.
|
Address |
Target.getAddress() |
Gets the address of this target.
|
Address |
TransportStateReference.getAddress() |
|
Address |
CommandResponderEvent.getPeerAddress() |
Gets the transport address of the sending entity.
|
Modifier and Type | Method | Description |
---|---|---|
java.util.List<TransportMapping<? extends Address>> |
AbstractTarget.getPreferredTransports() |
|
java.util.List<TransportMapping<? extends Address>> |
Target.getPreferredTransports() |
Gets the prioritised list of transport mappings to be used for this
target.
|
java.lang.Class<? extends Address> |
TransportMapping.getSupportedAddressClass() |
Gets the
Address class that is supported by this transport mapping. |
java.util.Collection<TransportMapping<? extends Address>> |
MessageDispatcher.getTransportMappings() |
Gets the
Collection of transport mappings in this message
dispatcher. |
java.util.Collection<TransportMapping<? extends Address>> |
MessageDispatcherImpl.getTransportMappings() |
Gets a collection of all registered transport mappings.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
Snmp.addNotificationListener(Address listenAddress,
CommandResponder listener) |
Adds a notification listener to this Snmp instance.
|
boolean |
Snmp.addNotificationListener(TransportMapping transportMapping,
Address listenAddress,
CommandResponder listener) |
Adds a notification listener to this Snmp instance.
|
protected void |
MessageDispatcherImpl.checkOutgoingMsg(Address transportAddress,
int messageProcessingModel,
PDU pdu) |
Checks outgoing messages for consistency between PDU and target used.
|
byte[] |
Snmp.discoverAuthoritativeEngineID(Address address,
long timeout) |
Discovers the engine ID of the SNMPv3 entity denoted by the supplied
address.
|
protected void |
MessageDispatcherImpl.dispatchMessage(TransportMapping sourceTransport,
MessageProcessingModel mp,
Address incomingAddress,
BERInputStream wholeMessage,
TransportStateReference tmStateReference) |
Actually decodes and dispatches an incoming SNMP message using the supplied
message processing model.
|
TransportMapping |
Snmp.getNotificationListenerTM(Address listenAddress) |
Gets the transport mapping registered for the specified listen address.
|
TransportMapping |
MessageDispatcher.getTransport(Address destAddress) |
Returns a transport mapping that can handle the supplied address.
|
TransportMapping |
MessageDispatcherImpl.getTransport(Address destAddress) |
Returns a transport mapping that can handle the supplied address.
|
protected void |
Snmp.handleInternalResponse(PDU response,
PDU pdu,
Address target) |
|
void |
MessageDispatcher.processMessage(TransportMapping sourceTransport,
Address incomingAddress,
java.nio.ByteBuffer wholeMessage,
TransportStateReference tmStateReference) |
Process an incoming SNMP message.
|
void |
MessageDispatcherImpl.processMessage(TransportMapping sourceTransport,
Address incomingAddress,
java.nio.ByteBuffer wholeMessage,
TransportStateReference tmStateReference) |
|
void |
MessageDispatcherImpl.processMessage(TransportMapping sourceTransport,
Address incomingAddress,
BERInputStream wholeMessage,
TransportStateReference tmStateReference) |
|
boolean |
Snmp.removeNotificationListener(Address listenAddress) |
Removes (deletes) the notification listener for the specified transport
endpoint.
|
protected void |
MessageDispatcherImpl.sendMessage(TransportMapping transport,
Address destAddress,
byte[] message,
TransportStateReference tmStateReference,
long timeoutMillis,
int maxRetries) |
Sends a message using the
TransportMapping that has been
assigned for the supplied address type. |
void |
AbstractTarget.setAddress(Address address) |
Sets the address of the target.
|
void |
Target.setAddress(Address address) |
Sets the address of the target.
|
void |
CommandResponderEvent.setPeerAddress(Address peerAddress) |
Sets the transport address of the sending entity.
|
Modifier and Type | Method | Description |
---|---|---|
void |
MessageDispatcher.addTransportMapping(TransportMapping<? extends Address> transport) |
Adds a
TransportMapping to the dispatcher. |
void |
Snmp.addTransportMapping(TransportMapping<? extends Address> transportMapping) |
Adds a
TransportMapping to this SNMP session. |
TransportMapping |
MessageDispatcher.removeTransportMapping(TransportMapping<? extends Address> transport) |
Removes a previously added
TransportMapping from
the dispatcher. |
void |
Snmp.removeTransportMapping(TransportMapping<? extends Address> transportMapping) |
Removes the specified transport mapping from this SNMP session.
|
void |
AbstractTarget.setPreferredTransports(java.util.List<TransportMapping<? extends Address>> preferredTransports) |
Sets the prioritised list of transport mappings to be used for this
target.
|
Constructor | Description |
---|---|
AbstractTarget(Address address) |
Creates a SNMPv3 target with no retries and a timeout of one second.
|
AbstractTarget(Address address,
OctetString securityName) |
|
CertifiedTarget(Address address,
OctetString identity,
OctetString serverFingerprint,
OctetString clientFingerprint) |
|
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.
|
CommunityTarget(Address address,
OctetString community) |
Creates a fully specified community target.
|
SecureTarget(Address address,
OctetString securityName) |
Creates a SNMPv3 secure target with an address and security name.
|
TransportStateReference(TransportMapping transport,
Address address,
OctetString securityName,
SecurityLevel requestedSecurityLevel,
SecurityLevel transportSecurityLevel,
boolean sameSecurity,
java.lang.Object sessionID) |
|
TransportStateReference(TransportMapping transport,
Address address,
OctetString securityName,
SecurityLevel requestedSecurityLevel,
SecurityLevel transportSecurityLevel,
boolean sameSecurity,
java.lang.Object sessionID,
CertifiedIdentity certifiedIdentity) |
|
UserTarget(Address address,
OctetString securityName,
byte[] authoritativeEngineID) |
Creates a SNMPv3 USM target with security level noAuthNoPriv, one second
time-out without retries.
|
UserTarget(Address address,
OctetString securityName,
byte[] authoritativeEngineID,
int securityLevel) |
Creates a SNMPv3 USM target with the supplied security level, one second
time-out without retries.
|
Constructor | Description |
---|---|
Snmp(MessageDispatcher messageDispatcher,
TransportMapping<? extends Address> transportMapping) |
Creates a
Snmp instance by supplying a
MessageDispatcher and a TransportMapping . |
Snmp(TransportMapping<? extends Address> transportMapping) |
Creates a
Snmp instance that uses a
MessageDispatcherImpl with all supported message processing
models and the default security protols for dispatching. |
Modifier and Type | Method | Description |
---|---|---|
Address |
AuthenticationFailureEvent.getAddress() |
Returns the source address from which the message has been received.
|
Address |
SnmpEngineEvent.getEngineAddress() |
Returns the transport address of the engine.
|
Address |
ResponseEvent.getPeerAddress() |
Gets the transport address of the response sender.
|
Modifier and Type | Method | Description |
---|---|---|
protected void |
ResponseEvent.setPeerAddress(Address peerAddress) |
Constructor | Description |
---|---|
AuthenticationFailureEvent(TransportListener source,
Address sourceAddress,
TransportMapping transport,
int error,
BERInputStream message) |
Creates an authentication failure event.
|
ResponseEvent(java.lang.Object source,
Address peerAddress,
PDU request,
PDU response,
java.lang.Object userObject) |
Creates an
ResponseEvent instance. |
ResponseEvent(java.lang.Object source,
Address peerAddress,
PDU request,
PDU response,
java.lang.Object userObject,
java.lang.Exception error) |
Creates an
ResponseEvent instance with an exception object
indicating a message processing error. |
SnmpEngineEvent(MPv3 source,
int type,
OctetString engineID,
Address engineAddress) |
Modifier and Type | Method | Description |
---|---|---|
Address |
StateReference.getAddress() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map<Address,OctetString> |
MPv3.EngineIdCacheFactory.createEngineIdMap(EngineIdCacheSize maximumCapacity) |
Create a engine ID map with the given maximum capacity.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
MPv3.addEngineID(Address address,
OctetString engineID) |
Adds an engine ID (other than the local engine ID) to the internal storage.
|
protected OctetString |
MPv3.addEngineIdToCache(Address address,
OctetString engineID) |
Put the engine ID for the given address into the internal cache.
|
OctetString |
MPv3.getEngineID(Address address) |
Gets the engine ID associated with the supplied address from the local
storage and fires the corresponding
SnmpEngineEvent . |
int |
MessageProcessingModel.prepareDataElements(MessageDispatcher messageDispatcher,
Address transportAddress,
BERInputStream wholeMsg,
TransportStateReference tmStateReference,
Integer32 messageProcessingModel,
Integer32 securityModel,
OctetString securityName,
Integer32 securityLevel,
MutablePDU pdu,
PduHandle sendPduHandle,
Integer32 maxSizeResponseScopedPDU,
StatusInformation statusInformation,
MutableStateReference mutableStateReference) |
Prepare data elements from an incoming SNMP message as described in
RFC3412 §7.2.
|
int |
MPv1.prepareDataElements(MessageDispatcher messageDispatcher,
Address transportAddress,
BERInputStream wholeMsg,
TransportStateReference tmStateReference,
Integer32 messageProcessingModel,
Integer32 securityModel,
OctetString securityName,
Integer32 securityLevel,
MutablePDU pdu,
PduHandle sendPduHandle,
Integer32 maxSizeResponseScopedPDU,
StatusInformation statusInformation,
MutableStateReference mutableStateReference) |
|
int |
MPv2c.prepareDataElements(MessageDispatcher messageDispatcher,
Address transportAddress,
BERInputStream wholeMsg,
TransportStateReference tmStateReference,
Integer32 messageProcessingModel,
Integer32 securityModel,
OctetString securityName,
Integer32 securityLevel,
MutablePDU pdu,
PduHandle sendPduHandle,
Integer32 maxSizeResponseScopedPDU,
StatusInformation statusInformation,
MutableStateReference mutableStateReference) |
|
int |
MPv3.prepareDataElements(MessageDispatcher messageDispatcher,
Address transportAddress,
BERInputStream wholeMsg,
TransportStateReference tmStateReference,
Integer32 messageProcessingModel,
Integer32 securityModel,
OctetString securityName,
Integer32 securityLevel,
MutablePDU pdu,
PduHandle sendPduHandle,
Integer32 maxSizeResponseScopedPDU,
StatusInformation statusInformation,
MutableStateReference mutableStateReference) |
|
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,
TransportStateReference tmStateReference) |
Prepares an outgoing message as defined in RFC3412 §7.1.
|
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,
TransportStateReference tmStateReference) |
|
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,
TransportStateReference tmStateReference) |
|
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,
TransportStateReference tmStateReference) |
|
OctetString |
MPv3.removeEngineID(Address address) |
Removes an engine ID association from the local storage and fires the
corresponding
SnmpEngineEvent . |
void |
StateReference.setAddress(Address address) |
Constructor | Description |
---|---|
StateReference(int msgID,
int msgFlags,
int maxSizeResponseScopedPDU,
PduHandle pduHandle,
Address peerAddress,
TransportMapping peerTransport,
byte[] secEngineID,
SecurityModel secModel,
byte[] secName,
int secLevel,
byte[] contextEngineID,
byte[] contextName,
SecurityStateReference secStateReference,
int errorCode) |
Creates a state reference for SNMPv3 messages.
|
StateReference(PduHandle pduHandle,
Address peerAddress,
TransportMapping peerTransport,
SecurityModel secModel,
byte[] secName,
int errorCode) |
Creates a state reference for community based security models.
|
Modifier and Type | Method | Description |
---|---|---|
protected java.lang.String |
TSM.getTransportDomainPrefix(Address address) |
Modifier and Type | Class | Description |
---|---|---|
class |
DtlsAddress |
The
TlsAddress represents a TLS transport addresses as defined
by RFC 5953 SnmpTSLAddress textual convention. |
class |
GenericAddress |
The
GenericAddress implements the decorator and factory
design pattern to provide a generic address type. |
class |
IpAddress |
The
IpAddress class represents an IPv4 address SNMP variable. |
class |
SMIAddress |
A
SMIAddress is an address that is defined by the Structure
of Management Information (SMI) and can be thereby serialized through the
Basic Encoding Rules (BER) used by the SNMP protocol. |
class |
SshAddress |
The
SshAddress represents a SSH transport addresses as defined
by RFC 5592 SnmpSSHAddress textual convention. |
class |
TcpAddress |
The
TcpAddress represents TCP/IP transport addresses. |
class |
TlsAddress |
The
TlsAddress represents a TLS transport addresses as defined
by RFC 5953 SnmpTSLAddress textual convention. |
class |
TransportIpAddress |
The
TransportIpAddress is the abstract base class for all
transport addresses on top of IP network addresses. |
class |
UdpAddress |
The
UdpAddress represents UDP/IP transport addresses. |
Modifier and Type | Method | Description |
---|---|---|
Address |
GenericAddress.getAddress() |
|
static Address |
DtlsAddress.parse(java.lang.String address) |
|
static Address |
GenericAddress.parse(java.lang.String address) |
Parses a given transport protocol dependent address string into an
Address instance that is subsumed by this
GenericAddress object. |
static Address |
IpAddress.parse(java.lang.String address) |
Parses an IP address string and returns the corresponding
IpAddress instance. |
static Address |
TcpAddress.parse(java.lang.String address) |
|
static Address |
TlsAddress.parse(java.lang.String address) |
|
static Address |
TransportIpAddress.parse(java.lang.String address) |
|
static Address |
UdpAddress.parse(java.lang.String address) |
Modifier and Type | Method | Description |
---|---|---|
static java.lang.String |
GenericAddress.getTDomainPrefix(java.lang.Class<? extends Address> addressClass) |
Gets the transport domain prefix string (lowercase) for a supplied
Address class. |
Modifier and Type | Method | Description |
---|---|---|
Address |
SnmpRequest.getAddress() |
Modifier and Type | Method | Description |
---|---|---|
void |
SnmpRequest.setAddress(Address address) |
Modifier and Type | Class | Description |
---|---|---|
class |
AbstractServerSocket<A extends Address> |
The
AbstractServerSocket interface provides methods to manage the sockets of a connection oriented
transport mapping listening for incoming requests. |
class |
AbstractTransportMapping<A extends Address> |
The
AbstractTransportMapping provides an abstract
implementation for the message dispatcher list and the maximum inbound
message size. |
interface |
ConnectionOrientedTransportMapping<A extends Address> |
Transport mappings for connection oriented transport protocols have to
implement this interface.
|
Modifier and Type | Field | Description |
---|---|---|
protected java.util.Map<Address,S> |
TcpTransportMapping.sockets |
Modifier and Type | Method | Description |
---|---|---|
Address |
TransportStateEvent.getPeerAddress() |
Modifier and Type | Method | Description |
---|---|---|
TransportMapping<? extends Address> |
TransportMappings.createTransportMapping(Address transportAddress) |
Returns a
TransportMapping instance that is initialized with
the supplied transport address. |
abstract java.lang.Class<? extends Address> |
AbstractTransportMapping.getSupportedAddressClass() |
|
java.lang.Class<? extends Address> |
DTLSTM.getSupportedAddressClass() |
|
java.lang.Class<? extends Address> |
TcpTransportMapping.getSupportedAddressClass() |
|
java.lang.Class<? extends Address> |
TLSTM.getSupportedAddressClass() |
|
java.lang.Class<? extends Address> |
UdpTransportMapping.getSupportedAddressClass() |
Modifier and Type | Method | Description |
---|---|---|
TransportMapping<? extends Address> |
TransportMappings.createTransportMapping(Address transportAddress) |
Returns a
TransportMapping instance that is initialized with
the supplied transport address. |
protected void |
AbstractTransportMapping.fireProcessMessage(Address address,
java.nio.ByteBuffer buf,
TransportStateReference tmStateReference) |
|
void |
TransportListener.processMessage(TransportMapping sourceTransport,
Address incomingAddress,
java.nio.ByteBuffer wholeMessage,
TransportStateReference tmStateReference) |
Processes an incoming message.
|
void |
DefaultTcpTransportMapping.ServerThread.sendMessage(Address address,
byte[] message,
TransportStateReference tmStateReference) |
Modifier and Type | Method | Description |
---|---|---|
protected void |
TcpTransportMapping.closeSockets(java.util.Map<Address,S> sockets) |
Constructor | Description |
---|---|
TransportStateEvent(AbstractTransportMapping source,
Address peerAddress,
int newState,
java.io.IOException causingException) |
|
TransportStateEvent(AbstractTransportMapping source,
Address peerAddress,
int newState,
java.io.IOException causingException,
java.util.List<byte[]> discardedMessages) |
Modifier and Type | Method | Description |
---|---|---|
void |
DefaultTlsTmSecurityCallback.addLocalCertMapping(Address address,
java.lang.String certAlias) |
Map a target address to a local certificate alias.
|
java.lang.String |
DefaultTlsTmSecurityCallback.getLocalCertificateAlias(Address targetAddress) |
|
java.lang.String |
PropertiesTlsTmSecurityCallback.getLocalCertificateAlias(Address targetAddress) |
|
java.lang.String |
TlsTmSecurityCallback.getLocalCertificateAlias(Address targetAddress) |
Gets the local certificate alias to be used for the supplied
target address.
|
java.lang.String |
DefaultTlsTmSecurityCallback.removeLocalCertMapping(Address address) |
Remove the local certificate mapping for the given target address.
|
Modifier and Type | Method | Description |
---|---|---|
Address |
SnmpConfigurator.getBindAddress(java.util.Map settings) |
Modifier and Type | Method | Description |
---|---|---|
java.util.Collection<TransportMapping<? extends Address>> |
MultiThreadedMessageDispatcher.getTransportMappings() |
Modifier and Type | Method | Description |
---|---|---|
TransportMapping |
MultiThreadedMessageDispatcher.getTransport(Address destAddress) |
|
void |
MultiThreadedMessageDispatcher.processMessage(TransportMapping sourceTransport,
Address incomingAddress,
java.nio.ByteBuffer wholeMessage,
TransportStateReference tmStateReference) |
Modifier and Type | Method | Description |
---|---|---|
void |
MultiThreadedMessageDispatcher.addTransportMapping(TransportMapping<? extends Address> transport) |
|
TransportMapping |
MultiThreadedMessageDispatcher.removeTransportMapping(TransportMapping<? extends Address> transport) |
Copyright © 2018 SNMP4J.org. All rights reserved.