- All Known Implementing Classes:
MPv3
public interface MPv3ScopedPDUExtractor
Interface defining the mechanism to extract the ScopedPDU from an SNMPv3 message.
The extraction process involves dissecting the whole SNMP message, applying security models,
and converting the necessary components into a ScopedPDU.
- Since:
- 3.9.0
-
Method Summary
Modifier and TypeMethodDescriptionint
extractScopedPDU
(BERInputStream wholeMsg, SecurityModel secModel, TransportStateReference tmStateReference, MPv3.HeaderData header, Integer32 securityLevel, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, OctetString securityName, OctetString securityEngineID, Integer32 snmpVersion, SecurityParameters secParameters, BEROutputStream scopedPDU, SecurityStateReference secStateReference) Use security model to extract the scoped PDU from the wholeMsg and return state information.
-
Method Details
-
extractScopedPDU
int extractScopedPDU(BERInputStream wholeMsg, SecurityModel secModel, TransportStateReference tmStateReference, MPv3.HeaderData header, Integer32 securityLevel, Integer32 maxSizeResponseScopedPDU, StatusInformation statusInformation, OctetString securityName, OctetString securityEngineID, Integer32 snmpVersion, SecurityParameters secParameters, BEROutputStream scopedPDU, SecurityStateReference secStateReference) throws IOException Use security model to extract the scoped PDU from the wholeMsg and return state information.- Parameters:
wholeMsg
- the incoming SNMP message with position at the beginning of the scoped PDU.secModel
- the security model to be used.tmStateReference
- the already collected transport model state reference.header
- provides the message length data from the already read message header.securityLevel
- the target security level.maxSizeResponseScopedPDU
- returns the maximum size of the response PDU allowed for this security model.statusInformation
- returns the status informationsecurityName
- returns the extracted security name used to authenticate/encrypt the message.securityEngineID
- returns the security engine IDsnmpVersion
- returns the SNMP versionsecParameters
- returns the security parameters.scopedPDU
- returns the scoped PDU.secStateReference
- returns security state reference.- Returns:
- the status of the operation.
See
SecurityModel.processIncomingMsg(int, int, SecurityParameters, SecurityModel, int, BERInputStream, TransportStateReference, OctetString, OctetString, BEROutputStream, Integer32, SecurityStateReference, StatusInformation)
- Throws:
IOException
- on fatal encoding errors.- Since:
- 3.9.0
-