-
- All Superinterfaces:
TransportListener
- All Known Implementing Classes:
MessageDispatcherImpl,MultiThreadedMessageDispatcher,SnmpCommand.SnmpCommandMessageDispatcher
public interface MessageDispatcher extends TransportListener
TheMessageDispatcherinterface defines common services of instances that process incoming SNMP messages and dispatch them to interestedCommandResponderinstances. It also provides a service to send out outgoing SNMP messages. AMessageDispatcherneeds at least oneTransportMappingand at least oneMessageProcessingModelin order to be able to process any messages.- Version:
- 3.2.0
- Author:
- Frank Fock
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidaddCommandResponder(CommandResponder listener)Adds aCommandResponderinstance to the message dispatcher.voidaddCounterListener(CounterListener counterListener)Adds aCounterListenerto the dispatcher.voidaddMessageProcessingModel(MessageProcessingModel model)Adds aMessageProcessingModelto the dispatcher.voidaddTransportMapping(TransportMapping<? extends Address> transport)Adds aTransportMappingto the dispatcher.MessageProcessingModelgetMessageProcessingModel(int messageProcessingModel)Gets theMessageProcessingModelfor the supplied message processing model ID.intgetNextRequestID()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 theCollectionof 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.voidreleaseStateReference(int messageProcessingModel, PduHandle pduHandle)Release any state references associated with the suppliedPduHandlein the specified message processing model.voidremoveCommandResponder(CommandResponder listener)Removes a previously addedCommandResponderinstance from the message dispatcher.CounterListenerremoveCounterListener(CounterListener counterListener)Removes a previously addedCounterListenerfrom the dispatcher.voidremoveMessageProcessingModel(MessageProcessingModel model)Removes a previously addedMessageProcessingModelfrom the dispatcher.TransportMapping<? extends Address>removeTransportMapping(TransportMapping<? extends Address> transport)Removes a previously addedTransportMappingfrom 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 thePduHandlethat uniquely identifies the request as response after the request has been sent and optional, if aPduHandleCallbackis given, it returns also thePduHandlejust before the request is sent through the the callback interface.
-
-
-
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 aMessageProcessingModelto 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- aMessageProcessingModelinstance.
-
removeMessageProcessingModel
void removeMessageProcessingModel(MessageProcessingModel model)
Removes a previously addedMessageProcessingModelfrom the dispatcher.- Parameters:
model- aMessageProcessingModelinstance.
-
getMessageProcessingModel
MessageProcessingModel getMessageProcessingModel(int messageProcessingModel)
Gets theMessageProcessingModelfor 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 aTransportMappingto the dispatcher. The transport mapping is used to send and receive messages to/from the network.- Parameters:
transport- aTransportMappinginstance.
-
removeTransportMapping
TransportMapping<? extends Address> removeTransportMapping(TransportMapping<? extends Address> transport)
Removes a previously addedTransportMappingfrom the dispatcher.- Parameters:
transport- aTransportMappinginstance.- Returns:
- the
TransportMappinginstance if it could be successfully removed,nullotherwise.
-
addCounterListener
void addCounterListener(CounterListener counterListener)
Adds aCounterListenerto the dispatcher. The counter listener is informed about errors during message dispatching.- Parameters:
counterListener- aCounterListenerinstance.- Since:
- 3.0
-
removeCounterListener
CounterListener removeCounterListener(CounterListener counterListener)
Removes a previously addedCounterListenerfrom the dispatcher.- Parameters:
counterListener- aCounterListenerinstance.- Returns:
- the
CounterListenerinstance if it could be successfully removed,nullotherwise. - Since:
- 3.0
-
getTransportMappings
java.util.Collection<TransportMapping<? extends Address>> getTransportMappings()
Gets theCollectionof 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- theAddresstype to get aTransportMappingfor.- Parameters:
destAddress- an Address instance.- Returns:
- a
TransportMappinginstance that can be used to sent a SNMP message todestAddressornullif 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- theAddresstype to get aTransportMappingfor.- Parameters:
destAddress- an Address instance.transportType- specifies the SNMP application type that will use the returned transport mapping.transportTypemust be eitherTransportType.receiverorTransportType.sender. IfTransportType.anyis provided anIllegalArgumentExceptionwill be thrown.- Returns:
- a
TransportMappinginstance that can be used to sent a SNMP message todestAddressornullif such a transport mapping does not exists. - Since:
- 1.6
-
addCommandResponder
void addCommandResponder(CommandResponder listener)
Adds aCommandResponderinstance 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- aCommandResponderinstance.
-
removeCommandResponder
void removeCommandResponder(CommandResponder listener)
Removes a previously addedCommandResponderinstance from the message dispatcher.- Parameters:
listener- aCommandResponderinstance.
-
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- theAddresstype.- Parameters:
transportMapping- theTransportMappingto be used to send the PDU. IftransportMappingisnullthe 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-trueif a response is expected and a state reference should be saved (if needed for the supplied message processing model).- Returns:
- an
PduHandlethat 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 thePduHandlethat uniquely identifies the request as response after the request has been sent and optional, if aPduHandleCallbackis given, it returns also thePduHandlejust before the request is sent through the the callback interface.- Type Parameters:
A- the targetAddresstype.- Parameters:
transportMapping- theTransportMappingto be used to send the PDU. IftransportMappingisnullthe 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-trueif 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
PduHandlethat 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)withtransportMappingset tonull.- Type Parameters:
A- the targetAddresstype.- Parameters:
target- the target which identifies, transport address, message processing model, security model, security name and level.pdu- the SNMP Protocol Data UnitexpectResponse-trueif a response is expected and a state reference should be saved (if needed for the supplied message processing model).- Returns:
- an
PduHandlethat 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- theAddresstype.- Parameters:
messageProcessingModel- the message processing model, seeMessageProcessingModelsecurityModel- the security model to use, seeSecurityModelsecurityName- the security namesecurityLevel- the security level for the message to be returned, seeSecurityLevelpdu- 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_OKif 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:
processMessagein interfaceTransportListener- Type Parameters:
A- theAddresstype.- Parameters:
sourceTransport- aTransportMappinginstance denoting the transport that received the message and that will be used to send any responses to this message. ThesourceTransporthas to support theincomingAddress's implementation class.incomingAddress- theAddressfrom which the message has been received.wholeMessage- anByteBuffercontaining 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 suppliedPduHandlein the specified message processing model.- Parameters:
messageProcessingModel- a message processing model ID.pduHandle- thePduHandlethat identifies a confirmed class message.- See Also:
MessageProcessingModel
-
-