public class SnmpCommunityMIB extends Object implements MOGroup, CoexistenceInfoProvider
Modifier and Type | Class and Description |
---|---|
class |
SnmpCommunityMIB.SnmpCommunityEntryRow |
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
SnmpCommunityMIB(SnmpTargetMIB targetMIB) |
Modifier and Type | Method and Description |
---|---|
void |
addSnmpCommunityEntry(org.snmp4j.smi.OctetString indexName,
org.snmp4j.smi.OctetString community,
org.snmp4j.smi.OctetString securityName,
org.snmp4j.smi.OctetString contextEngineID,
org.snmp4j.smi.OctetString contextName,
org.snmp4j.smi.OctetString communityTransportTag,
int storageType)
Adds an entry to the SnmpCommunityTable and a corresponding coexistence information entry in the internal
cache.
|
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<SnmpCommunityMIB.SnmpCommunityEntryRow,MOColumn,MOMutableTableModel<SnmpCommunityMIB.SnmpCommunityEntryRow>> |
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.
|
boolean |
removeSnmpCommuntiyEntry(org.snmp4j.smi.OctetString indexName)
Removes a community entry from the SnmpCommunityTable and also removes the corresponding coexistence
information from the cache.
|
void |
setBaseTableSnmpTargetAddrEntry(MOTable<SnmpTargetMIB.SnmpTargetAddrEntryRow,? extends MOColumn,? extends MOTableModel<SnmpTargetMIB.SnmpTargetAddrEntryRow>> 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.
|
public static final org.snmp4j.smi.OID oidSnmpCommunityEntry
public static final int colSnmpCommunityName
public static final int colSnmpCommunitySecurityName
public static final int colSnmpCommunityContextEngineID
public static final int colSnmpCommunityContextName
public static final int colSnmpCommunityTransportTag
public static final int colSnmpCommunityStorageType
public static final int colSnmpCommunityStatus
public static final int idxSnmpCommunityName
public static final int idxSnmpCommunitySecurityName
public static final int idxSnmpCommunityContextEngineID
public static final int idxSnmpCommunityContextName
public static final int idxSnmpCommunityTransportTag
public static final int idxSnmpCommunityStorageType
public static final int idxSnmpCommunityStatus
public static final org.snmp4j.smi.OID oidSnmpTargetAddrExtEntry
public static final int colSnmpTargetAddrTMask
public static final int colSnmpTargetAddrMMS
public static final int idxSnmpTargetAddrTMask
public static final int idxSnmpTargetAddrMMS
public SnmpCommunityMIB(SnmpTargetMIB targetMIB)
public MOTable<SnmpCommunityMIB.SnmpCommunityEntryRow,MOColumn,MOMutableTableModel<SnmpCommunityMIB.SnmpCommunityEntryRow>> getSnmpCommunityEntry()
public MOTable getSnmpTargetAddrExtEntry()
public void setBaseTableSnmpTargetAddrEntry(MOTable<SnmpTargetMIB.SnmpTargetAddrEntryRow,? extends MOColumn,? extends MOTableModel<SnmpTargetMIB.SnmpTargetAddrEntryRow>> baseTable)
public void registerMOs(MOServer server, org.snmp4j.smi.OctetString context) throws DuplicateRegistrationException
MOGroup
registerMOs
in interface MOGroup
server
- the MOServer
where to register the managed objects.context
- the context to use (may be null
if no specific context
is selected).DuplicateRegistrationException
- if a managed object's scope (i.e. lower bound) is already registered
at the server.public void unregisterMOs(MOServer server, org.snmp4j.smi.OctetString context)
MOGroup
unregisterMOs
in interface MOGroup
server
- the MOServer
where to unregister the managed objects.context
- the context to use (may be null
if no specific context
is selected).public CoexistenceInfo[] getCoexistenceInfo(org.snmp4j.smi.OctetString community)
CoexistenceInfoProvider
getCoexistenceInfo
in interface CoexistenceInfoProvider
community
- a community OctetString that identifies the coexistence information
required.public boolean passesFilter(org.snmp4j.smi.Address address, CoexistenceInfo coexistenceInfo)
passesFilter
in interface CoexistenceInfoProvider
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.public void setSourceAddressFiltering(boolean sourceAddressFiltering)
sourceAddressFiltering
- if true
source address filtering is enabled, otherwise
it is disabled.public boolean isSourceAddressFiltering()
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
.true
if source address filtering is enabled,
false
otherwise.public org.snmp4j.smi.OctetString getCommunity(org.snmp4j.smi.OctetString securityName, org.snmp4j.smi.OctetString contextEngineID, org.snmp4j.smi.OctetString contextName)
CoexistenceInfoProvider
getCommunity
in interface CoexistenceInfoProvider
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).null
if such an
association does not exists.public void addSnmpCommunityEntry(org.snmp4j.smi.OctetString indexName, org.snmp4j.smi.OctetString community, org.snmp4j.smi.OctetString securityName, org.snmp4j.smi.OctetString contextEngineID, org.snmp4j.smi.OctetString contextName, org.snmp4j.smi.OctetString communityTransportTag, int storageType)
indexName
- the ID of the entry (max. 32 bytes long).community
- the community string for which a row in this table represents a configuration.securityName
- A human readable string representing the corresponding value of snmpCommunityName in a Security Model
independent format.contextEngineID
- The contextEngineID indicating the location of the context in which management information is accessed
when using the community string specified by the corresponding instance of snmpCommunityName.contextName
- The context in which management information is accessed when using the community string specified by the
corresponding instance of snmpCommunityName.communityTransportTag
- This object specifies a set of transport endpoints from which a command responder application will accept
management requests. If a management request containing this community is received on a transport endpoint
other than the transport endpoints identified by this object, the request is deemed unauthentic.
The transports identified by this object are specified in the snmpTargetAddrTable. Entries in that table
whose snmpTargetAddrTagList contains this tag value are identified.
If the value of this object has zero-length, transport endpoints are not checked when authenticating messages
containing this community string.storageType
- The storage type for this conceptual row in the snmpCommunityTable. Conceptual rows having the value
'permanent' need not allow write-access to any columnar object in the row.public boolean removeSnmpCommuntiyEntry(org.snmp4j.smi.OctetString indexName)
indexName
- the ID of the entry.true
if the row has been found and removed, false
otherwise.Copyright © 2017 SNMP4J.org. All rights reserved.