-
- All Superinterfaces:
TransportListener
- All Known Implementing Classes:
MessageDispatcherImpl
,MultiThreadedMessageDispatcher
,SnmpCommand.SnmpCommandMessageDispatcher
public interface MessageDispatcher extends TransportListener
TheMessageDispatcher
interface defines common services of instances that process incoming SNMP messages and dispatch them to interestedCommandResponder
instances. It also provides a service to send out outgoing SNMP messages. AMessageDispatcher
needs at least oneTransportMapping
and at least oneMessageProcessingModel
in order to be able to process any messages.- Version:
- 3.2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description void
addCommandResponder(CommandResponder listener)
Adds aCommandResponder
instance to the message dispatcher.void
addCounterListener(CounterListener counterListener)
Adds aCounterListener
to the dispatcher.void
addMessageProcessingModel(MessageProcessingModel model)
Adds aMessageProcessingModel
to the dispatcher.void
addTransportMapping(TransportMapping<? extends Address> transport)
Adds aTransportMapping
to the dispatcher.MessageProcessingModel
getMessageProcessingModel(int messageProcessingModel)
Gets theMessageProcessingModel
for the supplied message processing model ID.int
getNextRequestID()
Gets the next unique request ID.<A extends Address>
TransportMapping<? super A>getTransport(A destAddress)
Deprecated.UsegetTransport(Address, TransportType)
instead to make sure that the returned mapping supports the intended SNMP application type usage (i.e.<A extends Address>
TransportMapping<? super A>getTransport(A destAddress, TransportType transportType)
Returns a transport mapping that can handle the supplied address.java.util.Collection<TransportMapping<? extends Address>>
getTransportMappings()
Gets theCollection
of transport mappings in this message dispatcher.<A extends Address>
voidprocessMessage(TransportMapping<? super A> sourceTransport, A incomingAddress, java.nio.ByteBuffer wholeMessage, TransportStateReference tmStateReference)
Process an incoming SNMP message.void
releaseStateReference(int messageProcessingModel, PduHandle pduHandle)
Release any state references associated with the suppliedPduHandle
in the specified message processing model.void
removeCommandResponder(CommandResponder listener)
Removes a previously addedCommandResponder
instance from the message dispatcher.CounterListener
removeCounterListener(CounterListener counterListener)
Removes a previously addedCounterListener
from the dispatcher.void
removeMessageProcessingModel(MessageProcessingModel model)
Removes a previously addedMessageProcessingModel
from the dispatcher.TransportMapping<? extends Address>
removeTransportMapping(TransportMapping<? extends Address> transport)
Removes a previously addedTransportMapping
from the dispatcher.<A extends Address>
intreturnResponsePdu(int messageProcessingModel, int securityModel, byte[] securityName, int securityLevel, PDU pdu, int maxSizeResponseScopedPDU, StateReference<A> stateReference, StatusInformation statusInformation)
Returns a response PDU to the sender of the corresponding request PDU.<A extends Address>
PduHandlesendPdu(Target<A> target, PDU pdu, boolean expectResponse)
Sends a PDU to the supplied transport address.<A extends Address>
PduHandlesendPdu(TransportMapping<? super A> transportMapping, Target<A> target, PDU pdu, boolean expectResponse)
Sends a PDU to the supplied transport address.<A extends Address>
PduHandlesendPdu(TransportMapping<? super A> transportMapping, Target<A> target, PDU pdu, boolean expectResponse, PduHandleCallback<PDU> callback)
Sends a PDU to the supplied transport address and returns thePduHandle
that uniquely identifies the request as response after the request has been sent and optional, if aPduHandleCallback
is given, it returns also thePduHandle
just before the request is sent through the the callback interface.default void
stop()
Stops this message dispatcher and free all resources (i.e.
-
-
-
Method Detail
-
getNextRequestID
int getNextRequestID()
Gets the next unique request ID. The returned ID is unique across the last 2^31-1 IDs generated by this message dispatcher.- Returns:
- an integer value in the range 1..2^31-1. The returned ID can be used to map responses to requests send through this message dispatcher.
- Since:
- 1.1
-
addMessageProcessingModel
void addMessageProcessingModel(MessageProcessingModel model)
Adds aMessageProcessingModel
to the dispatcher. In order to support a specific SNMP protocol version, the message dispatcher needs a message processing model to process messages before they can be dispatched.- Parameters:
model
- aMessageProcessingModel
instance.
-
removeMessageProcessingModel
void removeMessageProcessingModel(MessageProcessingModel model)
Removes a previously addedMessageProcessingModel
from the dispatcher.- Parameters:
model
- aMessageProcessingModel
instance.
-
getMessageProcessingModel
MessageProcessingModel getMessageProcessingModel(int messageProcessingModel)
Gets theMessageProcessingModel
for the supplied message processing model ID.- Parameters:
messageProcessingModel
- a message processing model ID (seeMessageProcessingModel.getID()
).- Returns:
- a MessageProcessingModel instance if the ID is known, otherwise
null
-
addTransportMapping
void addTransportMapping(TransportMapping<? extends Address> transport)
Adds aTransportMapping
to the dispatcher. The transport mapping is used to send and receive messages to/from the network.- Parameters:
transport
- aTransportMapping
instance.
-
removeTransportMapping
TransportMapping<? extends Address> removeTransportMapping(TransportMapping<? extends Address> transport)
Removes a previously addedTransportMapping
from the dispatcher.- Parameters:
transport
- aTransportMapping
instance.- Returns:
- the
TransportMapping
instance if it could be successfully removed,null
otherwise.
-
addCounterListener
void addCounterListener(CounterListener counterListener)
Adds aCounterListener
to the dispatcher. The counter listener is informed about errors during message dispatching.- Parameters:
counterListener
- aCounterListener
instance.- Since:
- 3.0
-
removeCounterListener
CounterListener removeCounterListener(CounterListener counterListener)
Removes a previously addedCounterListener
from the dispatcher.- Parameters:
counterListener
- aCounterListener
instance.- Returns:
- the
CounterListener
instance if it could be successfully removed,null
otherwise. - Since:
- 3.0
-
getTransportMappings
java.util.Collection<TransportMapping<? extends Address>> getTransportMappings()
Gets theCollection
of transport mappings in this message dispatcher.- Returns:
- a Collection with the registered transport mappings.
-
getTransport
@Deprecated <A extends Address> TransportMapping<? super A> getTransport(A destAddress)
Deprecated.UsegetTransport(Address, TransportType)
instead to make sure that the returned mapping supports the intended SNMP application type usage (i.e. command/notification generator or command receiver).Returns a transport mapping that can handle the supplied address.- Type Parameters:
A
- theAddress
type to get aTransportMapping
for.- Parameters:
destAddress
- an Address instance.- Returns:
- a
TransportMapping
instance that can be used to sent a SNMP message todestAddress
ornull
if such a transport mapping does not exists. - Since:
- 1.6
-
getTransport
<A extends Address> TransportMapping<? super A> getTransport(A destAddress, TransportType transportType)
Returns a transport mapping that can handle the supplied address.- Type Parameters:
A
- theAddress
type to get aTransportMapping
for.- Parameters:
destAddress
- an Address instance.transportType
- specifies the SNMP application type that will use the returned transport mapping.transportType
must be eitherTransportType.receiver
orTransportType.sender
. IfTransportType.any
is provided anIllegalArgumentException
will be thrown.- Returns:
- a
TransportMapping
instance that can be used to sent a SNMP message todestAddress
ornull
if such a transport mapping does not exists. - Since:
- 1.6
-
addCommandResponder
void addCommandResponder(CommandResponder listener)
Adds aCommandResponder
instance to the message dispatcher. Successfully processed SNMP messages will be presented to all command responder (in the order in which they have been added) until a responder uses theCommandResponderEvent.setProcessed(boolean processed)
to set the processed status of the event totrue
.- Parameters:
listener
- aCommandResponder
instance.
-
removeCommandResponder
void removeCommandResponder(CommandResponder listener)
Removes a previously addedCommandResponder
instance from the message dispatcher.- Parameters:
listener
- aCommandResponder
instance.
-
sendPdu
<A extends Address> PduHandle sendPdu(TransportMapping<? super A> transportMapping, Target<A> target, PDU pdu, boolean expectResponse) throws MessageException
Sends a PDU to the supplied transport address.- Type Parameters:
A
- theAddress
type.- Parameters:
transportMapping
- theTransportMapping
to be used to send the PDU. IftransportMapping
isnull
the message dispatcher will determine the appropriate transport mapping for the given transport address.target
- the target which identifies, transport address, message processing model, security model, security name and level.pdu
- the SNMP Protocol Data UnitexpectResponse
-true
if a response is expected and a state reference should be saved (if needed for the supplied message processing model).- Returns:
- an
PduHandle
that uniquely identifies this request. - Throws:
MessageException
- if sending of the PDU failed.
-
sendPdu
<A extends Address> PduHandle sendPdu(TransportMapping<? super A> transportMapping, Target<A> target, PDU pdu, boolean expectResponse, PduHandleCallback<PDU> callback) throws MessageException
Sends a PDU to the supplied transport address and returns thePduHandle
that uniquely identifies the request as response after the request has been sent and optional, if aPduHandleCallback
is given, it returns also thePduHandle
just before the request is sent through the the callback interface.- Type Parameters:
A
- the targetAddress
type.- Parameters:
transportMapping
- theTransportMapping
to be used to send the PDU. IftransportMapping
isnull
the message dispatcher will determine the appropriate transport mapping for the given transport address.target
- the target which identifies, transport address, message processing model, security model, security name and level.pdu
- the SNMP Protocol Data UnitexpectResponse
-true
if a response is expected and a state reference should be saved (if needed for the supplied message processing model).callback
- an optional callback instance that is informed (if notnull
) about the newly assigned PduHandle just before the message is sent out.- Returns:
- an
PduHandle
that uniquely identifies this request. - Throws:
MessageException
- if sending of the PDU failed.
-
sendPdu
<A extends Address> PduHandle sendPdu(Target<A> target, PDU pdu, boolean expectResponse) throws MessageException
Sends a PDU to the supplied transport address. This method behaves like a call tosendPdu(TransportMapping transportMapping, Target target, PDU pdu, boolean expectResponse)
withtransportMapping
set tonull
.- Type Parameters:
A
- the targetAddress
type.- Parameters:
target
- the target which identifies, transport address, message processing model, security model, security name and level.pdu
- the SNMP Protocol Data UnitexpectResponse
-true
if a response is expected and a state reference should be saved (if needed for the supplied message processing model).- Returns:
- an
PduHandle
that uniquely identifies this request. - Throws:
MessageException
- if sending of the PDU failed.
-
returnResponsePdu
<A extends Address> int returnResponsePdu(int messageProcessingModel, int securityModel, byte[] securityName, int securityLevel, PDU pdu, int maxSizeResponseScopedPDU, StateReference<A> stateReference, StatusInformation statusInformation) throws MessageException
Returns a response PDU to the sender of the corresponding request PDU.- Type Parameters:
A
- theAddress
type.- Parameters:
messageProcessingModel
- the message processing model, seeMessageProcessingModel
securityModel
- the security model to use, seeSecurityModel
securityName
- the security namesecurityLevel
- the security level for the message to be returned, seeSecurityLevel
pdu
- the protocol data unit (PDU
) to send.maxSizeResponseScopedPDU
- the maximum size agreed for the response scoped PDU.stateReference
- the state reference to be used.statusInformation
- the status information to be used.- Returns:
- an MP error status or
SnmpConstants.SNMP_MP_OK
if the operation was successful. - Throws:
MessageException
- if message processing fails with a fatal error.
-
processMessage
<A extends Address> void processMessage(TransportMapping<? super A> sourceTransport, A incomingAddress, java.nio.ByteBuffer wholeMessage, TransportStateReference tmStateReference)
Process an incoming SNMP message. The message is processed and dispatched according to the message's content, the message processing models, and the command responder available to the dispatcher.- Specified by:
processMessage
in interfaceTransportListener
- Type Parameters:
A
- theAddress
type.- Parameters:
sourceTransport
- aTransportMapping
instance denoting the transport that received the message and that will be used to send any responses to this message. ThesourceTransport
has to support theincomingAddress
's implementation class.incomingAddress
- theAddress
from which the message has been received.wholeMessage
- anByteBuffer
containing the received SNMP message.tmStateReference
- the transport model state reference as defined by RFC 5590.
-
releaseStateReference
void releaseStateReference(int messageProcessingModel, PduHandle pduHandle)
Release any state references associated with the suppliedPduHandle
in the specified message processing model.- Parameters:
messageProcessingModel
- a message processing model ID.pduHandle
- thePduHandle
that identifies a confirmed class message.- See Also:
MessageProcessingModel
-
stop
default void stop()
Stops this message dispatcher and free all resources (i.e. stop/join internal threads, etc.)- Since:
- 3.5.0
-
-