org.snmp4j.agent.mo.snmp
Class SnmpCommunityMIB

java.lang.Object
  org.snmp4j.agent.mo.snmp.SnmpCommunityMIB

All Implemented Interfaces:

CoexistenceInfoProvider, MOGroup

public class SnmpCommunityMIB
extends java.lang.Object
implements MOGroup, CoexistenceInfoProvider

Field Summary

static int	colSnmpCommunityContextEngineID
static int	colSnmpCommunityContextName
static int	colSnmpCommunityName
static int	colSnmpCommunitySecurityName
static int	colSnmpCommunityStatus
static int	colSnmpCommunityStorageType
static int	colSnmpCommunityTransportTag
static int	colSnmpTargetAddrMMS
static int	colSnmpTargetAddrTMask
static int	idxSnmpCommunityContextEngineID
static int	idxSnmpCommunityContextName
static int	idxSnmpCommunityName
static int	idxSnmpCommunitySecurityName
static int	idxSnmpCommunityStatus
static int	idxSnmpCommunityStorageType
static int	idxSnmpCommunityTransportTag
static int	idxSnmpTargetAddrMMS
static int	idxSnmpTargetAddrTMask
static org.snmp4j.smi.OID	oidSnmpCommunityEntry
static org.snmp4j.smi.OID	oidSnmpTargetAddrExtEntry

Constructor Summary

SnmpCommunityMIB(SnmpTargetMIB targetMIB)

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.
MOTable	getSnmpCommunityEntry()
MOTable	getSnmpTargetAddrExtEntry()
boolean	isSourceAddressFiltering() Returns true if source address filtering is enabled.
boolean	passesFilter(org.snmp4j.smi.Address address, CoexistenceInfo coexistenceInfo) Checks whether the supplied address passes the source address filter configured for the supplied transport tag.
void	registerMOs(MOServer server, org.snmp4j.smi.OctetString context) Registers the managed objects of this group with the server for the supplied context.
void	setBaseTableSnmpTargetAddrEntry(MOTable baseTable)
void	setSourceAddressFiltering(boolean sourceAddressFiltering) Enables or disables source address filtering for incoming SNMPv1 or SNMPv2c packets.
void	unregisterMOs(MOServer server, org.snmp4j.smi.OctetString context) Unregisters the managed objects of this group from the supplied server and from the supplied context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

oidSnmpCommunityEntry

public static final org.snmp4j.smi.OID oidSnmpCommunityEntry

colSnmpCommunityName

public static final int colSnmpCommunityName

See Also:

Constant Field Values

colSnmpCommunitySecurityName

public static final int colSnmpCommunitySecurityName

See Also:

Constant Field Values

colSnmpCommunityContextEngineID

public static final int colSnmpCommunityContextEngineID

See Also:

Constant Field Values

colSnmpCommunityContextName

public static final int colSnmpCommunityContextName

See Also:

Constant Field Values

colSnmpCommunityTransportTag

public static final int colSnmpCommunityTransportTag

See Also:

Constant Field Values

colSnmpCommunityStorageType

public static final int colSnmpCommunityStorageType

See Also:

Constant Field Values

colSnmpCommunityStatus

public static final int colSnmpCommunityStatus

See Also:

Constant Field Values

idxSnmpCommunityName

public static final int idxSnmpCommunityName

See Also:

Constant Field Values

idxSnmpCommunitySecurityName

public static final int idxSnmpCommunitySecurityName

See Also:

Constant Field Values

idxSnmpCommunityContextEngineID

public static final int idxSnmpCommunityContextEngineID

See Also:

Constant Field Values

idxSnmpCommunityContextName

public static final int idxSnmpCommunityContextName

See Also:

Constant Field Values

idxSnmpCommunityTransportTag

public static final int idxSnmpCommunityTransportTag

See Also:

Constant Field Values

idxSnmpCommunityStorageType

public static final int idxSnmpCommunityStorageType

See Also:

Constant Field Values

idxSnmpCommunityStatus

public static final int idxSnmpCommunityStatus

See Also:

Constant Field Values

oidSnmpTargetAddrExtEntry

public static final org.snmp4j.smi.OID oidSnmpTargetAddrExtEntry

colSnmpTargetAddrTMask

public static final int colSnmpTargetAddrTMask

See Also:

Constant Field Values

colSnmpTargetAddrMMS

public static final int colSnmpTargetAddrMMS

See Also:

Constant Field Values

idxSnmpTargetAddrTMask

public static final int idxSnmpTargetAddrTMask

See Also:

Constant Field Values

idxSnmpTargetAddrMMS

public static final int idxSnmpTargetAddrMMS

See Also:

Constant Field Values

Constructor Detail

SnmpCommunityMIB

public SnmpCommunityMIB(SnmpTargetMIB targetMIB)

Method Detail

getSnmpCommunityEntry

public MOTable getSnmpCommunityEntry()

getSnmpTargetAddrExtEntry

public MOTable getSnmpTargetAddrExtEntry()

setBaseTableSnmpTargetAddrEntry

public void setBaseTableSnmpTargetAddrEntry(MOTable baseTable)

registerMOs

public void registerMOs(MOServer server,
                        org.snmp4j.smi.OctetString context)
                 throws DuplicateRegistrationException

Description copied from interface: MOGroup

Registers the managed objects of this group with the server for the supplied context.

Specified by:

registerMOs in interface MOGroup

Parameters:

server - the MOServer where to register the managed objects.

context - the context to use (may be null if no specific context is selected).

Throws:

DuplicateRegistrationException - if a managed object's scope (i.e. lower bound) is already registered at the server.

unregisterMOs

public void unregisterMOs(MOServer server,
                          org.snmp4j.smi.OctetString context)

Description copied from interface: MOGroup

Unregisters the managed objects of this group from the supplied server and from the supplied context.

Specified by:

unregisterMOs in interface MOGroup

Parameters:

server - the MOServer where to unregister the managed objects.

context - the context to use (may be null if no specific context is selected).

getCoexistenceInfo

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

Description copied from interface: CoexistenceInfoProvider

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

Specified by:

getCoexistenceInfo in interface CoexistenceInfoProvider

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

passesFilter

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

Checks whether the supplied address passes the source address filter configured for the supplied transport tag. The tag identifies a set of addresses configured in the snmpTargetAddrTable which is extended by the snmpTargetAddrExtTable. The transport address mask allows entries in the snmpTargetAddrTable to define a set of addresses instead of just a single address.

Specified by:

passesFilter in interface CoexistenceInfoProvider

Parameters:

address - the address of the incoming packet to check.

coexistenceInfo - a set of coexistence information that provides the transport tag that is 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:

boolean

setSourceAddressFiltering

public void setSourceAddressFiltering(boolean sourceAddressFiltering)

Enables or disables source address filtering for incoming SNMPv1 or SNMPv2c packets. By default source address filtering is disabled! If enabled, only messages received for community based security models are processed, that match an address in the snmpTargetAddressTable with the transport tag associated with the community used.

Parameters:

sourceAddressFiltering - if true source address filtering is enabled, otherwise it is disabled.

isSourceAddressFiltering

public boolean isSourceAddressFiltering()

Returns true if source address filtering is enabled. In that case a call to passesFilter(org.snmp4j.smi.Address, org.snmp4j.agent.mo.snmp.CoexistenceInfo) will always return true.

Returns:

true if source address filtering is enabled, false otherwise.

getCommunity

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

Description copied from interface: CoexistenceInfoProvider

Returns the community associated with the supplied security name.

Specified by:

getCommunity in interface CoexistenceInfoProvider

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.