org.snmp4j.agent.mo.snmp
Interface CoexistenceInfoProvider

All Known Implementing Classes:

SnmpCommunityMIB

public interface CoexistenceInfoProvider

A CoexistenceInfoProvider provides access to coexistence information.

Version:

1.2.1

Author:

Frank Fock

Method Summary

CoexistenceInfo[]	getCoexistenceInfo(org.snmp4j.smi.OctetString community) Gets the information needed for community based security protocols to coexistence with the SNMPv3 security model.
org.snmp4j.smi.OctetString	getCommunity(org.snmp4j.smi.OctetString securityName, org.snmp4j.smi.OctetString contextEngineID, org.snmp4j.smi.OctetString contextName) Returns the community associated with the supplied security name.
boolean	passesFilter(org.snmp4j.smi.Address address, CoexistenceInfo coexistenceInfo) Checks whether the supplied address passes the source address filtering provided for community based security models.

Method Detail

getCoexistenceInfo

CoexistenceInfo[] getCoexistenceInfo(org.snmp4j.smi.OctetString community)

Gets the information needed for community based security protocols to coexistence with the SNMPv3 security model.

Parameters:

community - a community OctetString that identifies the coexistence information required.

Returns:

the CoexistenceInfo instances with security name, context engine ID, context, and optionally a transport tag

getCommunity

org.snmp4j.smi.OctetString getCommunity(org.snmp4j.smi.OctetString securityName,
                                        org.snmp4j.smi.OctetString contextEngineID,
                                        org.snmp4j.smi.OctetString contextName)

Returns the community associated with the supplied security name.

Parameters:

securityName - the security name.

contextEngineID - the context engine ID of the remote target (when proxying) otherwise the local engine ID.

contextName - the context name (default is an empty string).

Returns:

OctetString the associated community string or null if such an association does not exists.

passesFilter

boolean passesFilter(org.snmp4j.smi.Address address,
                     CoexistenceInfo coexistenceInfo)

Checks whether the supplied address passes the source address filtering provided for community based security models.

Parameters:

address - the source Address of a SNMP message.

coexistenceInfo - a set of coexistence information (returned by getCoexistenceInfo(org.snmp4j.smi.OctetString)) that provides the transport tag used to identify allowed source addresses. On return, the maximum message size attribute of the coexistence info set will be set according to the values defined for the matched source address in the snmpTargetAddrExtTable.

Returns:

true if the address passes the filter, false otherwise.