Module org.snmp4j
Package org.snmp4j

Class MessageDispatcherImpl

    • Constructor Detail

      • MessageDispatcherImpl

        public MessageDispatcherImpl()
        Default constructor creates a message dispatcher without any associated message processing models.
    • Method Detail

      • addTransportMapping

        public void addTransportMapping​(TransportMapping<?> transport)
        Adds a transport mapping. When an outgoing message is processed where no specific transport mapping has been specified, then the message dispatcher will use the transport mapping that supports the supplied address class of the target.
        Specified by:
        addTransportMapping in interface MessageDispatcher
        Parameters:
        transport - a TransportMapping instance. If there is already another transport mapping registered that supports the same address class, then transport will be registered but not used for messages without specific transport mapping.
      • getNextRequestID

        public int getNextRequestID()
        Description copied from interface: MessageDispatcher
        Gets the next unique request ID. The returned ID is unique across the last 2^31-1 IDs generated by this message dispatcher.
        Specified by:
        getNextRequestID in interface MessageDispatcher
        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.
      • createPduHandle

        protected PduHandle createPduHandle()
      • sendMessage

        protected <A extends Address> void sendMessage​(TransportMapping<? super A> transport,
                                                       A destAddress,
                                                       byte[] message,
                                                       TransportStateReference tmStateReference,
                                                       long timeoutMillis,
                                                       int maxRetries)
                                                throws java.io.IOException
        Sends a message using the TransportMapping that has been assigned for the supplied address type.
        Type Parameters:
        A - an Address class that is the super class for the addresses supported by this transport mapping.
        Parameters:
        transport - the transport mapping to be used to send the message.
        destAddress - the transport address where to send the message. The destAddress must be compatible with the supplied transport.
        message - the SNMP message to send.
        tmStateReference - the transport state reference that holds transport state information for this message.
        timeoutMillis - maximum number of milli seconds the connection creation might take (if connection based).
        maxRetries - maximum retries during connection creation.
        Throws:
        java.io.IOException - if an I/O error occurred while sending the message or if there is no transport mapping defined for the supplied address type.
      • getTransport

        public <A extends AddressTransportMapping<? super A> getTransport​(A destAddress)
        Returns a transport mapping that can handle the supplied address.
        Specified by:
        getTransport in interface MessageDispatcher
        Type Parameters:
        A - the Address type to get a TransportMapping for.
        Parameters:
        destAddress - an Address instance.
        Returns:
        a TransportMapping instance that can be used to sent a SNMP message to destAddress or null if such a transport mapping does not exists.
        Since:
        1.6
      • dispatchMessage

        protected <A extends Address> void dispatchMessage​(TransportMapping<? super A> sourceTransport,
                                                           MessageProcessingModel mp,
                                                           A incomingAddress,
                                                           BERInputStream wholeMessage,
                                                           TransportStateReference tmStateReference)
                                                    throws java.io.IOException
        Actually decodes and dispatches an incoming SNMP message using the supplied message processing model.
        Type Parameters:
        A - the Address type.
        Parameters:
        sourceTransport - a TransportMapping that matches the incomingAddress type.
        mp - a MessageProcessingModel to process the message.
        incomingAddress - the Address from the entity that sent this message.
        wholeMessage - the BERInputStream containing the SNMP message.
        tmStateReference - the transport model state reference as defined by RFC 5590.
        Throws:
        java.io.IOException - if the message cannot be decoded.
      • processMessage

        public <A extends Address> void processMessage​(TransportMapping<? super A> sourceTransport,
                                                       A incomingAddress,
                                                       java.nio.ByteBuffer wholeMessage,
                                                       TransportStateReference tmStateReference)
        Description copied from interface: MessageDispatcher
        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 interface MessageDispatcher
        Specified by:
        processMessage in interface TransportListener
        Type Parameters:
        A - the Address type.
        Parameters:
        sourceTransport - a TransportMapping instance denoting the transport that received the message and that will be used to send any responses to this message. The sourceTransport has to support the incomingAddress's implementation class.
        incomingAddress - the Address from which the message has been received.
        wholeMessage - an ByteBuffer containing the received SNMP message.
        tmStateReference - the transport model state reference as defined by RFC 5590.
      • sendPdu

        public <A extends AddressPduHandle sendPdu​(TransportMapping<? super A> transport,
                                                     Target<A> target,
                                                     PDU pdu,
                                                     boolean expectResponse,
                                                     PduHandleCallback<PDU> pduHandleCallback)
                                              throws MessageException
        Description copied from interface: MessageDispatcher
        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 optional, if a PduHandleCallback is given, it returns also the PduHandle just before the request is sent through the the callback interface.
        Specified by:
        sendPdu in interface MessageDispatcher
        Type Parameters:
        A - the target Address type.
        Parameters:
        transport - the TransportMapping to be used to send the PDU. If transportMapping is null 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 Unit
        expectResponse - true if a response is expected and a state reference should be saved (if needed for the supplied message processing model).
        pduHandleCallback - an optional callback instance that is informed (if not null) 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.
      • checkOutgoingMsg

        protected void checkOutgoingMsg​(Address transportAddress,
                                        int messageProcessingModel,
                                        PDU pdu)
                                 throws MessageException
        Checks outgoing messages for consistency between PDU and target used.
        Parameters:
        transportAddress - the target address.
        messageProcessingModel - the message processing model to be used.
        pdu - the PDU to be sent.
        Throws:
        MessageException - if unrecoverable inconsistencies have been detected.
      • returnResponsePdu

        public <A extends Address> int returnResponsePdu​(int messageProcessingModel,
                                                         int securityModel,
                                                         byte[] securityName,
                                                         int securityLevel,
                                                         PDU pdu,
                                                         int maxSizeResponseScopedPDU,
                                                         StateReference<A> stateReference,
                                                         StatusInformation statusInformation)
                                                  throws MessageException
        Description copied from interface: MessageDispatcher
        Returns a response PDU to the sender of the corresponding request PDU.
        Specified by:
        returnResponsePdu in interface MessageDispatcher
        Type Parameters:
        A - the Address type.
        Parameters:
        messageProcessingModel - the message processing model, see MessageProcessingModel
        securityModel - the security model to use, see SecurityModel
        securityName - the security name
        securityLevel - the security level for the message to be returned, see SecurityLevel
        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.
      • releaseStateReference

        public void releaseStateReference​(int messageProcessingModel,
                                          PduHandle pduHandle)
        Description copied from interface: MessageDispatcher
        Release any state references associated with the supplied PduHandle in the specified message processing model.
        Specified by:
        releaseStateReference in interface MessageDispatcher
        Parameters:
        messageProcessingModel - a message processing model ID.
        pduHandle - the PduHandle that identifies a confirmed class message.
        See Also:
        MessageProcessingModel
      • fireProcessPdu

        protected void fireProcessPdu​(CommandResponderEvent<?> e)
        Fires a CommandResponderEvent. Listeners are called in order of their registration until a listener has processed the PDU successfully.
        Parameters:
        e - a CommandResponderEvent event.
      • removeCounterListener

        public CounterListener removeCounterListener​(CounterListener counterListener)
        Removes a CounterListener.
        Specified by:
        removeCounterListener in interface MessageDispatcher
        Parameters:
        counterListener - a previously added CounterListener.
        Returns:
        the CounterListener instance if it could be successfully removed, null otherwise.
      • addCounterListener

        public void addCounterListener​(CounterListener counterListener)
        Adds a CounterListener.
        Specified by:
        addCounterListener in interface MessageDispatcher
        Parameters:
        counterListener - a CounterListener that will be informed when a counter needs to incremented.
      • fireIncrementCounter

        protected void fireIncrementCounter​(CounterEvent event)
        Fires a counter incrementation event.
        Parameters:
        event - the CounterEvent containing the OID of the counter that needs to be incremented.
      • setCheckOutgoingMsg

        public void setCheckOutgoingMsg​(boolean checkOutgoingMsg)
        Enables or disables the consistency checks for outgoing messages. If the checks are enabled, then GETBULK messages sent to SNMPv1 targets will be converted to GETNEXT messages.

        In general, if an automatically conversion is not possible, an error is thrown when such a message is to be sent.

        The default is consistency checks enabled.

        Parameters:
        checkOutgoingMsg - if true outgoing messages are checked for consistency. Currently, only the PDU type will be checked against the used SNMP version. If false, no checks will be performed.
      • isCheckOutgoingMsg

        public boolean isCheckOutgoingMsg()
        Returns whether consistency checks for outgoing messages are activated.
        Returns:
        if true outgoing messages are checked for consistency. If false, no checks are performed.
      • addAuthenticationFailureListener

        public void addAuthenticationFailureListener​(AuthenticationFailureListener l)
        Adds a listener for authentication failure events caused by unauthenticated incoming messages.
        Parameters:
        l - the AuthenticationFailureListener to add.
        Since:
        1.5
      • removeAuthenticationFailureListener

        public void removeAuthenticationFailureListener​(AuthenticationFailureListener l)
        Removes an AuthenticationFailureListener.
        Parameters:
        l - the AuthenticationFailureListener to remove.
      • fireAuthenticationFailure

        protected void fireAuthenticationFailure​(AuthenticationFailureEvent<?> event)
        Fires an AuthenticationFailureEvent to all registered listeners.
        Parameters:
        event - the event to fire.
      • sendPdu

        public <A extends AddressPduHandle sendPdu​(TransportMapping<? super A> transportMapping,
                                                     Target<A> target,
                                                     PDU pdu,
                                                     boolean expectResponse)
                                              throws MessageException
        Description copied from interface: MessageDispatcher
        Sends a PDU to the supplied transport address.
        Specified by:
        sendPdu in interface MessageDispatcher
        Type Parameters:
        A - the Address type.
        Parameters:
        transportMapping - the TransportMapping to be used to send the PDU. If transportMapping is null 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 Unit
        expectResponse - 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.