Uses of Interface
org.snmp4j.smi.Address
Package
Description
Provides classes and interfaces for creating, sending, and receiving SNMP
messages.
Provides classes and interfaces for SNMP4J event processing.
Provides classes and interfaces for the SNMP message processing.
Provides classes and interfaces for authentication and privacy of SNMP(v3)
messages.
Provides classes for the representation of SMIv1/v2 data types (which also
includes some basic ASN.1 primitive data types).
Provides transport protocol mappings for SNMP.
Contains table retrieval utilities and multi-threading support classes as
well as miscellaneous utility classes.
-
Uses of Address in org.snmp4j
Modifier and TypeInterfaceDescriptioninterface
TransportMapping<A extends Address>
TheTransportMapping
defines the common interface for SNMP transport mappings.Modifier and TypeMethodDescriptionAbstractTarget.getAddress()
Gets the address of this target.Target.getAddress()
Gets the address of this target.TransportStateReference.getAddress()
CommandResponderEvent.getPeerAddress()
Gets the transport address of the sending entity.Modifier and TypeMethodDescriptionList<TransportMapping<? extends Address>>
AbstractTarget.getPreferredTransports()
List<TransportMapping<? extends Address>>
Target.getPreferredTransports()
Gets the prioritised list of transport mappings to be used for this target.TransportMapping.getSupportedAddressClass()
Gets theAddress
class that is supported by this transport mapping.Modifier and TypeMethodDescriptionboolean
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.Snmp.getCachedContextEngineId
(Address targetAddress) Get a cached RFC 5343 context engine ID for the specified address.Snmp.getNotificationListenerTM
(Address listenAddress) Gets the transport mapping registered for the specified listen address.MessageDispatcher.getTransport
(Address destAddress) Returns a transport mapping that can handle the supplied address.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, ByteBuffer wholeMessage, TransportStateReference tmStateReference) Process an incoming SNMP message.void
MessageDispatcherImpl.processMessage
(TransportMapping sourceTransport, Address incomingAddress, ByteBuffer wholeMessage, TransportStateReference tmStateReference) void
MessageDispatcherImpl.processMessage
(TransportMapping sourceTransport, Address incomingAddress, BERInputStream wholeMessage, TransportStateReference tmStateReference) Snmp.removeCachedContextEngineId
(Address target) Remove a cached RFC 5343 context engine ID for the specified address and return it.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) Sends a message using theTransportMapping
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 TypeMethodDescriptionvoid
MessageDispatcher.addTransportMapping
(TransportMapping<? extends Address> transport) Adds aTransportMapping
to the dispatcher.void
Snmp.addTransportMapping
(TransportMapping<? extends Address> transportMapping) Adds aTransportMapping
to this SNMP session.MessageDispatcher.removeTransportMapping
(TransportMapping<? extends Address> transport) Removes a previously addedTransportMapping
from the dispatcher.void
Snmp.removeTransportMapping
(TransportMapping<? extends Address> transportMapping) Removes the specified transport mapping from this SNMP session.void
AbstractTarget.setPreferredTransports
(List<TransportMapping<? extends Address>> preferredTransports) Sets the prioritised list of transport mappings to be used for this target.ModifierConstructorDescriptionprotected
AbstractTarget
(Address address) Creates a SNMPv3 target with no retries and a timeout of one second.protected
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.protected
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, Object sessionID) TransportStateReference
(TransportMapping transport, Address address, OctetString securityName, SecurityLevel requestedSecurityLevel, SecurityLevel transportSecurityLevel, boolean sameSecurity, 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.ModifierConstructorDescriptionSnmp
(MessageDispatcher messageDispatcher, TransportMapping<? extends Address> transportMapping) Creates aSnmp
instance by supplying aMessageDispatcher
and aTransportMapping
.Snmp
(TransportMapping<? extends Address> transportMapping) Creates aSnmp
instance that uses aMessageDispatcherImpl
with all supported message processing models and the default security protols for dispatching. -
Uses of Address in org.snmp4j.event
Modifier and TypeMethodDescriptionAuthenticationFailureEvent.getAddress()
Returns the source address from which the message has been received.SnmpEngineEvent.getEngineAddress()
Returns the transport address of the engine.ResponseEvent.getPeerAddress()
Gets the transport address of the response sender.Modifier and TypeMethodDescriptionprotected final void
ResponseEvent.setPeerAddress
(Address peerAddress) ModifierConstructorDescriptionAuthenticationFailureEvent
(TransportListener source, Address sourceAddress, TransportMapping transport, int error, BERInputStream message) Creates an authentication failure event.Creates anResponseEvent
instance.ResponseEvent
(Object source, Address peerAddress, PDU request, PDU response, Object userObject, Exception error) Creates anResponseEvent
instance with an exception object indicating a message processing error.SnmpEngineEvent
(MPv3 source, int type, OctetString engineID, Address engineAddress) -
Uses of Address in org.snmp4j.mp
Modifier and TypeClassDescriptionprotected static class
MPv3.CacheEntry<A extends Address>
TheCacheEntry
class holds state reference information for the MPv3 message processing model for a single message.class
StateReference<A extends Address>
TheStateReference
class represents state information associated with SNMP messages.Modifier and TypeMethodDescriptionMPv3.EngineIdCacheFactory.createEngineIdMap
(EngineIdCacheSize maximumCapacity) Create a engine ID map with the given maximum capacity.Modifier and TypeMethodDescriptionboolean
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.MPv3.getEngineID
(Address address) Gets the engine ID associated with the supplied address from the local storage and fires the correspondingSnmpEngineEvent
.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) MPv3.removeEngineID
(Address address) Removes an engine ID association from the local storage and fires the correspondingSnmpEngineEvent
. -
Uses of Address in org.snmp4j.security
-
Uses of Address in org.snmp4j.smi
Modifier and TypeClassDescriptionclass
TheGenericAddress
implements the decorator and factory design pattern to provide a generic address type.class
TheIpAddress
class represents an IPv4 address SNMP variable.class
ASMIAddress
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
TheSshAddress
represents a SSH transport addresses as defined by RFC 5592 SnmpSSHAddress textual convention.class
TheTcpAddress
represents TCP/IP transport addresses.class
TheSshAddress
represents a SSH transport addresses as defined by RFC 5953 SnmpTSLAddress textual convention.class
TheTransportIpAddress
is the abstract base class for all transport addresses on top of IP network addresses.class
TheUdpAddress
represents UDP/IP transport addresses.Modifier and TypeMethodDescriptionGenericAddress.getAddress()
static Address
Parses a given transport protocol dependent address string into anAddress
instance that is subsumed by thisGenericAddress
object.static Address
Parses an IP address string and returns the correspondingIpAddress
instance.static Address
static Address
static Address
static Address
Modifier and TypeMethodDescriptionstatic String
GenericAddress.getTDomainPrefix
(Class<? extends Address> addressClass) Gets the transport domain prefix string (lowercase) for a suppliedAddress
class. -
Uses of Address in org.snmp4j.tools.console
-
Uses of Address in org.snmp4j.transport
Modifier and TypeClassDescriptionclass
AbstractTransportMapping<A extends Address>
TheAbstractTransportMapping
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 TypeFieldDescriptionDefaultTcpTransportMapping.sockets
TcpTransportMapping.suspendedAddresses
Modifier and TypeMethodDescriptionTransportMapping<? extends Address>
TransportMappings.createTransportMapping
(Address transportAddress) Returns aTransportMapping
instance that is initialized with the supplied transport address.AbstractTransportMapping.getSupportedAddressClass()
DefaultSshTransportMapping.getSupportedAddressClass()
DummyTransport.DummyTransportResponder.getSupportedAddressClass()
DummyTransport.getSupportedAddressClass()
TcpTransportMapping.getSupportedAddressClass()
TLSTM.getSupportedAddressClass()
UdpTransportMapping.getSupportedAddressClass()
Modifier and TypeMethodDescriptionprotected void
DefaultTcpTransportMapping.ServerThread.connectSocketToSendMessage
(Address address, byte[] message, SocketChannel socketChannel, org.snmp4j.transport.DefaultTcpTransportMapping.SocketEntry entry, Map<Address, org.snmp4j.transport.DefaultTcpTransportMapping.SocketEntry> sockets) TransportMapping<? extends Address>
TransportMappings.createTransportMapping
(Address transportAddress) Returns aTransportMapping
instance that is initialized with the supplied transport address.protected void
AbstractTransportMapping.fireProcessMessage
(Address address, ByteBuffer buf, TransportStateReference tmStateReference) void
TransportListener.processMessage
(TransportMapping sourceTransport, Address incomingAddress, ByteBuffer wholeMessage, TransportStateReference tmStateReference) Processes an incoming message.void
DefaultTcpTransportMapping.ServerThread.sendMessage
(Address address, byte[] message, TransportStateReference tmStateReference) Modifier and TypeMethodDescriptionprotected void
DefaultTcpTransportMapping.ServerThread.connectSocketToSendMessage
(Address address, byte[] message, SocketChannel socketChannel, org.snmp4j.transport.DefaultTcpTransportMapping.SocketEntry entry, Map<Address, org.snmp4j.transport.DefaultTcpTransportMapping.SocketEntry> sockets) ModifierConstructorDescriptionTransportStateEvent
(TcpTransportMapping source, Address peerAddress, int newState, IOException causingException) TransportStateEvent
(TcpTransportMapping source, Address peerAddress, int newState, IOException causingException, List<byte[]> discardedMessages) -
Uses of Address in org.snmp4j.transport.tls
Modifier and TypeMethodDescriptionvoid
DefaultTlsTmSecurityCallback.addLocalCertMapping
(Address address, String certAlias) Map a target address to a local certificate alias.DefaultTlsTmSecurityCallback.getLocalCertificateAlias
(Address targetAddress) PropertiesTlsTmSecurityCallback.getLocalCertificateAlias
(Address targetAddress) TlsTmSecurityCallback.getLocalCertificateAlias
(Address targetAddress) Gets the local certificate alias to be used for the supplied target address.TlsTmSecurityCallbackProxy.getLocalCertificateAlias
(Address targetAddress) DefaultTlsTmSecurityCallback.removeLocalCertMapping
(Address address) Remove the local certificate mapping for the given target address.ModifierConstructorDescriptionTlsX509CertifiedTarget
(Address address, OctetString identity, OctetString serverFingerprint, OctetString clientFingerprint, TlsTmSecurityCallback<X509Certificate> tlsTmSecurityCallback) -
Uses of Address in org.snmp4j.util
Modifier and TypeMethodDescriptionSnmpConfigurator.getBindAddress
(Map<String, List<Object>> settings) Modifier and TypeMethodDescriptionMultiThreadedMessageDispatcher.getTransport
(Address destAddress) void
MultiThreadedMessageDispatcher.processMessage
(TransportMapping sourceTransport, Address incomingAddress, ByteBuffer wholeMessage, TransportStateReference tmStateReference) Modifier and TypeMethodDescriptionvoid
MultiThreadedMessageDispatcher.addTransportMapping
(TransportMapping<? extends Address> transport) MultiThreadedMessageDispatcher.removeTransportMapping
(TransportMapping<? extends Address> transport)