Module org.snmp4j

Interface SecurityStateReference

  • All Known Implementing Classes:
    TsmSecurityStateReference, UsmSecurityStateReference

    public interface SecurityStateReference
    The SecurityStateReference interface is an empty marker interface for security model dependent state references.
    Version:
    3.4.0
    Author:
    Frank Fock
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default boolean applyTargetSecurityInformation​(Target<?> target)
      After a SecurityStateReference has been created for on outgoing message, this method might be called by the MPv3 to apply security information contained in the target object to the security state information.
      boolean isCachedForResponseProcessing()
      Returns the isCachedForResponseProcessing flag indicating whether this security state reference has been cached for response processing which means it can be used later for response or report processing rather than for requests or notifications (traps).
      void setCachedForResponseProcessing​(boolean isCachedForResponseProcessing)
      Sets the isCachedForResponseProcessing flag to indicate whether this security state reference has been cached for response processing which means it will be used later for response or report processing rather than for requests or notifications (traps).
    • Method Detail

      • applyTargetSecurityInformation

        default boolean applyTargetSecurityInformation​(Target<?> target)
        After a SecurityStateReference has been created for on outgoing message, this method might be called by the MPv3 to apply security information contained in the target object to the security state information. By default, this method does nothing and defers the security state information initialization the the corresponding SecurityModel and returns false.
        Parameters:
        target - a Target subclass instance with security information.
        Returns:
        true if the security information of the supplied target could be applied and false otherwise.
      • setCachedForResponseProcessing

        void setCachedForResponseProcessing​(boolean isCachedForResponseProcessing)
        Sets the isCachedForResponseProcessing flag to indicate whether this security state reference has been cached for response processing which means it will be used later for response or report processing rather than for requests or notifications (traps).
        Parameters:
        isCachedForResponseProcessing - if true, this security state reference has been cached for response processing.
        Since:
        3.4.0
      • isCachedForResponseProcessing

        boolean isCachedForResponseProcessing()
        Returns the isCachedForResponseProcessing flag indicating whether this security state reference has been cached for response processing which means it can be used later for response or report processing rather than for requests or notifications (traps).
        Returns:
        if true, this security state reference has been cached for response processing.