AdventNet: Class SnmpGroup

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.adventnet.snmp.snmp2
Class SnmpGroup

java.lang.Object
  |
  +--com.adventnet.snmp.snmp2.SnmpGroup

public class SnmpGroup
extends java.lang.Object

This class maintains the counter valus for SnmpGroup. The SnmpGroup counters are maintained for each SNMP entity. i.e for each local_addrs, local_port pair in the SnmpSession. Except for the counter variables snmpInBadCommunityNames, snmpInBadCommunityUses, snmpInTotalReqVars and snmpInTotalSetVars, all other variables are updated by the snmp stack. The api user will have to explicitly call the increment methods to update the above mentioned four variables. The api user need not instantiate this class. This class is instsntiated by the SnmpSession. Since the SnmpGroup is maintained for each local_addrs, local_port of the SnmpSession, the api user will have to get the corresponding SnmpGroup object. Each SnmpGroup object is maintained in a table, in the SnmpAPI. The SnmpAPI provides methods to get the particular SnmpGroup entry for local_addrs, local_port pair.

Method Summary

int GetSnmpEnableAuthenTraps()
          Gets the status of the snmpEnableAuthenTraps variable.

long getSnmpInASNParseErrs()
          Gets the snmpInASNParseErrs count.

long getSnmpInBadCommunityNames()
          Gets the snmpInBadCommunityNames count.

long getSnmpInBadCommunityUses()
          Gets the snmpInBadCommunityUses count.

long getSnmpInBadValues()
          Gets the snmpInBadValues count.

long getSnmpInBadVersions()
          Gets the snmpInBadVersions count.

long getSnmpInGenErrs()
          Gets the snmpInGenErrs count.

long getSnmpInGetNexts()
          Gets the snmpInGetNexts count.

long getSnmpInGetRequests()
          Gets the snmpInGetRequests count.

long getSnmpInGetResponses()
          Gets the snmpInGetResponses count.

long getSnmpInNoSuchNames()
          Gets the snmpInNoSuchNames count.

long getSnmpInPkts()
          Gets the snmpInPkts count.

long getSnmpInReadOnlys()
          Gets the snmpInReadOnlys count.

long getSnmpInSetRequests()
          Gets the snmpInSetRequests count.

long getSnmpInTooBigs()
          Gets the snmpInTooBigs count.

long getSnmpInTotalReqVars()
          Gets the snmpInTotalReqVars count.

long getSnmpInTotalSetVars()
          Gets the snmpInTotalSetVars count.

long getSnmpInTraps()
          Gets the snmpInTraps count.

static long getSnmpInvalidMsgs()
          Gets the snmpInvalidMsgs count.

long getSnmpOutBadValues()
          Gets the snmpOutBadValues count.

long getSnmpOutGenErrs()
          Gets the snmpOutGenErrs count.

long getSnmpOutGetNexts()
          Gets the snmpOutGetNexts count.

long getSnmpOutGetRequests()
          Gets the snmpOutGetRequests count.

long getSnmpOutGetResponses()
          Gets the snmpOutGetResponses count.

long getSnmpOutNoSuchNames()
          Gets the snmpOutNoSuchNames count.

long getSnmpOutPkts()
          Gets the snmpOutPkts count.

long getSnmpOutSetRequests()
          Gets the snmpOutSetRequests count.

long getSnmpOutTooBigs()
          Gets the snmpOutTooBigs count.

long getSnmpOutTraps()
          Gets the snmpOutTraps count.

long getSnmpProxyDrops()
          Gets the snmpSilentDrops count.

long getSnmpSilentDrops()
          Gets the snmpSilentDrops count.

long getSnmpUnavailableContexts()
          Gets the snmpUnavailableContexts count.

long getSnmpUnknownContexts()
          Gets the snmpUnknownContexts count.

static long getSnmpUnknownPDUHandlers()
          Gets the snmpUnknownPDUHandlers count.

static long getSnmpUnknownSecurityModels()
          Gets the snmpUnknownSecurityModels count.

void incrSnmpInBadCommunityNames()
          Increment the snmpInBadCommunityNames value by 1.

void incrSnmpInBadCommunityUses()
          Increment the snmpInBadCommunityUses value by 1.

void incrSnmpInBadVersions()
          Increment the snmpInBadVersions value by 1.

void incrSnmpInTotalReqVars()
          Increment the snmpInTotalReqVars count value by 1.

void incrSnmpInTotalSetVars()
          Increments the snmpInTotalSetVars count value by 1.

static void incrSnmpInvalidMsgs()
          Increments the snmpInvalidMsgs count by 1.

void incrSnmpProxyDrops()
          Increments the snmpSilentDrops count by one.

void incrSnmpSilentDrops()
          Increment the snmpSilentDrops count by one.

void incrSnmpUnavailableContexts()
          Increments the snmpUnavailableContexts count by one.

void incrSnmpUnknownContexts()
          Increments the snmpUnknownContexts count by one.

static void incrSnmpUnknownPDUHandlers()
          Increments the snmpUnknownPDUHandlers count by 1.

static void incrSnmpUnknownSecurityModels()
          Increments the snmpUnknownSecurityModels count by 1.

void SetSnmpEnableAuthenTraps(int status)
          Sets the status of the snmpEnableAuthenTraps variable to be enabled or disabled.

Methods inherited from class java.lang.Object

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

Method Detail

getSnmpInPkts

public long getSnmpInPkts()

Gets the snmpInPkts count. The snmpInPkts is the total number of Messages delivered to the SNMP entity from the transport service.

Returns:: The snmpInPkts count value.

getSnmpOutPkts

public long getSnmpOutPkts()

Gets the snmpOutPkts count. The snmpOutPkts is the total number of SNMP Messages which were passed from the SNMP entity to the transport service.

Returns:: The snmpOutPkts count value.

getSnmpUnknownSecurityModels

public static long getSnmpUnknownSecurityModels()

Gets the snmpUnknownSecurityModels count. SnmpUnknownSecurityModels is the total number of packets received by the SNMP engine which were dropped because they referenced a securityModel that was not known to or supported by the SNMP engine.

Returns:: The snmpUnknownSecurityModels count.

incrSnmpUnknownSecurityModels

public static void incrSnmpUnknownSecurityModels()

Increments the snmpUnknownSecurityModels count by 1. SnmpUnknownSecurityModels is the total number of packets received by the SNMP engine which were dropped because they referenced a securityModel that was not known to or supported by the SNMP engine.

getSnmpInvalidMsgs

public static long getSnmpInvalidMsgs()

Gets the snmpInvalidMsgs count. SnmpInvalidMsgs is the total number of packets received by the SNMP engine which were dropped because there were invalid or inconsistent components in the SNMP message.

Returns:: The snmpInvalidMsgs count.

incrSnmpInvalidMsgs

public static void incrSnmpInvalidMsgs()

Increments the snmpInvalidMsgs count by 1. SnmpInvalidMsgs is the total number of packets received by the SNMP engine which were dropped because there were invalid or inconsistent components in the SNMP message.

getSnmpUnknownPDUHandlers

public static long getSnmpUnknownPDUHandlers()

Gets the snmpUnknownPDUHandlers count. snmpUnknownPDUHandlers is the total number of packets received by the SNMP engine which were dropped because the PDU contained in the packet could not be passed to an application responsible for handling the pduType, e.g. no SNMP application had registered for the proper combination of the contextEngineID and the pduType.

Returns:: The snmpUnknownPDUHandlers count.

incrSnmpUnknownPDUHandlers

public static void incrSnmpUnknownPDUHandlers()

Increments the snmpUnknownPDUHandlers count by 1. snmpUnknownPDUHandlers is the total number of packets received by the SNMP engine which were dropped because the PDU contained in the packet could not be passed to an application responsible for handling the pduType, e.g. no SNMP application had registered for the proper combination of the contextEngineID and the pduType.

getSnmpInBadVersions

public long getSnmpInBadVersions()

Gets the snmpInBadVersions count. The snmpInBadVersions is the total number of SNMP Messages which were delivered to the SNMP entity and were for an unsupported SNMP version.

Returns:: The snmpInBadVersions count value.

incrSnmpInBadVersions

public void incrSnmpInBadVersions()

Increment the snmpInBadVersions value by 1. The snmpInBadVersions is the total number of SNMP Messages which were delivered to the SNMP entity and were for an unsupported SNMP version.

getSnmpInBadCommunityNames

public long getSnmpInBadCommunityNames()

Gets the snmpInBadCommunityNames count. The snmpInBadCommunityNames is the total number of SNMP Messages which were delivered to the SNMP entity and were for an unsupported SNMP version.

Returns:: The snmpInBadCommunityNames count value.

incrSnmpInBadCommunityNames

public void incrSnmpInBadCommunityNames()

Increment the snmpInBadCommunityNames value by 1. The snmpInBadCommunityNames is the total number of SNMP Messages which were delivered to the SNMP entity and were for an unsupported SNMP version.

getSnmpInBadCommunityUses

public long getSnmpInBadCommunityUses()

Gets the snmpInBadCommunityUses count. The snmpInBadCommunityUses is the total number of SNMP Messages delivered to the SNMP entity which represented an SNMP operation which was not allowed by the SNMP community named in the Message.

Returns:: The snmpInBadCommunityUses count value.

incrSnmpInBadCommunityUses

public void incrSnmpInBadCommunityUses()

Increment the snmpInBadCommunityUses value by 1. The snmpInBadCommunityUses is the total number of SNMP Messages delivered to the SNMP entity which represented an SNMP operation which was not allowed by the SNMPcommunity named in the Message.

getSnmpUnavailableContexts

public long getSnmpUnavailableContexts()

Gets the snmpUnavailableContexts count.

Returns:: The total number of packets received by the SNMP engine which were dropped because the context contained in the message was unavailable.

incrSnmpUnavailableContexts

public void incrSnmpUnavailableContexts()

Increments the snmpUnavailableContexts count by one. This should be invoked when the context contained in the message is not available and hence resulting in packet drop.

getSnmpUnknownContexts

public long getSnmpUnknownContexts()

Gets the snmpUnknownContexts count.

Returns:: The total number of packets received by the SNMP engine which were dropped because the context contained in the message was unknown.

incrSnmpUnknownContexts

public void incrSnmpUnknownContexts()

Increments the snmpUnknownContexts count by one. This should be invoked when the context contained in the message is unknown and hence resulting in packet drop.

getSnmpInASNParseErrs

public long getSnmpInASNParseErrs()

Gets the snmpInASNParseErrs count. The snmpInASNParseErrs is the total number of ASN.1 or BER errors encountered by the SNMP entity when decoding received SNMP Messages.

Returns:: The snmpInASNParseErrs count value.

getSnmpInTooBigs

public long getSnmpInTooBigs()

Gets the snmpInTooBigs count. The snmpInTooBigs is the total number of SNMP PDUs which were delivered to the SNMP entity and for which the value of the error-status field is `tooBig'.

Returns:: The snmpInTooBigs count value.

getSnmpInNoSuchNames

public long getSnmpInNoSuchNames()

Gets the snmpInNoSuchNames count. The snmpInNoSuchNames is the total number of SNMP PDUs which were delivered to the SNMP entity and for which the value of the error-status field is `noSuchName'.

Returns:: The snmpInNoSuchNames count value.

getSnmpInBadValues

public long getSnmpInBadValues()

Gets the snmpInBadValues count. The snmpInBadValues is the total number of SNMP PDUs which were delivered to the SNMP entity and for which the value of the error-status field is `badValue'.

Returns:: The snmpInBadValues count value.

getSnmpInReadOnlys

public long getSnmpInReadOnlys()

Gets the snmpInReadOnlys count. The snmpInReadOnlys is the total number valid SNMP PDUs which were delivered to the SNMP entity and for which the value of the error-status field is `readOnly'. It should be noted that it is a protocol error to generate an SNMP PDU which contains the value `readOnly' in the error-status field, as such this object is provided as a means of detecting incorrect implementations of the SNMP.

Returns:: The snmpInReadOnlys count value.

getSnmpInGenErrs

public long getSnmpInGenErrs()

Gets the snmpInGenErrs count. The snmpInGenErrs is the total number of SNMP PDUs which were delivered to the SNMP entity and for which the value of the error-status field is `genErr'.

Returns:: The snmpInGenErrs count value.

getSnmpInTotalReqVars

public long getSnmpInTotalReqVars()

Gets the snmpInTotalReqVars count. The snmpInTotalReqVars is the total number of MIB objects which have been retrieved successfully by the SNMP entity as the result of receiving valid SNMP Get-Request and Get-Next PDUs.

Returns:: The snmpInTotalReqVars count value.

incrSnmpInTotalReqVars

public void incrSnmpInTotalReqVars()

Increment the snmpInTotalReqVars count value by 1. The snmpInTotalReqVars is the total number of MIB objects which have been retrieved successfully by the SNMP entity as the result of receiving valid SNMP Get-Request and Get-Next PDUs.

getSnmpInTotalSetVars

public long getSnmpInTotalSetVars()

Gets the snmpInTotalSetVars count. The snmpInTotalSetVars is the total number of MIB objects which have been altered successfully by the SNMP entity as the result of receiving valid SNMP Set-Request PDUs.

Returns:: The snmpInTotalSetVars count value.

incrSnmpInTotalSetVars

public void incrSnmpInTotalSetVars()

Increments the snmpInTotalSetVars count value by 1. The snmpInTotalSetVars is the total number of MIB objects which have been altered successfully by the SNMP entity as the result of receiving valid SNMP Set-Request PDUs.

getSnmpInGetRequests

public long getSnmpInGetRequests()

Gets the snmpInGetRequests count. The snmpInGetRequests is the total number of SNMP Get-Request PDUs which have been accepted and processed by the SNMP entity.

Returns:: The snmpInGetRequests count value.

getSnmpInGetNexts

public long getSnmpInGetNexts()

Gets the snmpInGetNexts count. The snmpInGetNexts is the total number of SNMP Get-Next PDUs which have been accepted and processed by the SNMP entity.

Returns:: The snmpInGetNexts count value.

getSnmpInSetRequests

public long getSnmpInSetRequests()

Gets the snmpInSetRequests count. The snmpInSetRequests is the total number of SNMP Set-Request PDUs which have been accepted and processed by the SNMP entity.

Returns:: The snmpInSetRequests count value.

getSnmpInGetResponses

public long getSnmpInGetResponses()

Gets the snmpInGetResponses count. The snmpInGetResponses is the total number of SNMP Get-Response PDUs which have been accepted and processed by the SNMP entity.

Returns:: The snmpInGetResponses count value.

getSnmpInTraps

public long getSnmpInTraps()

Gets the snmpInTraps count. The snmpInTraps is the total number of SNMP Trap PDUs which have been accepted and processed by the SNMP entity.

Returns:: The snmpInTraps count value.

getSnmpOutTooBigs

public long getSnmpOutTooBigs()

Gets the snmpOutTooBigs count. The snmpOutTooBigs is the total number of SNMP PDUs which were generated by the SNMP entity and for which the value of the error-status field is `tooBig'.

Returns:: The snmpOutTooBigs count value.

getSnmpOutNoSuchNames

public long getSnmpOutNoSuchNames()

Gets the snmpOutNoSuchNames count. The snmpOutNoSuchNames is the total number of SNMP PDUs which were generated by the SNMP entity and for which the value of the error-status is `noSuchName'.

Returns:: The snmpOutNoSuchNames count value.

getSnmpOutBadValues

public long getSnmpOutBadValues()

Gets the snmpOutBadValues count. The is the total number of SNMP PDUs which were generated by the SNMP protocol entity and for which the value of the error-status field is `badValue'.

Returns:: The snmpOutBadValues count value.

getSnmpOutGenErrs

public long getSnmpOutGenErrs()

Gets the snmpOutGenErrs count. The snmpOutGenErrs is the total number of SNMP PDUs which were generated by the SNMP entity and for which the value of the error-status field is `genErr'.

Returns:: The snmpOutGenErrs count value.

getSnmpOutGetRequests

public long getSnmpOutGetRequests()

Gets the snmpOutGetRequests count. The snmpOutGetRequests is the total number of SNMP Get-Request PDUs which have been generated by the SNMP entity.

Returns:: The snmpOutGetRequests count value.

getSnmpOutGetNexts

public long getSnmpOutGetNexts()

Gets the snmpOutGetNexts count. The snmpOutGetNexts is the total number of SNMP Get-Next PDUs which have been generated by the SNMP entity.

Returns:: The snmpOutGetNexts count value.

getSnmpOutSetRequests

public long getSnmpOutSetRequests()

Gets the snmpOutSetRequests count. The snmpOutSetRequests is the total number of SNMP Set-Request PDUs which have been generated by the SNMP entity.

Returns:: The snmpOutSetRequests count value.

getSnmpOutGetResponses

public long getSnmpOutGetResponses()

Gets the snmpOutGetResponses count. The snmpOutGetResponses is the total number of SNMP Get-Response PDUs which have been generated by the SNMP entity.

Returns:: The snmpOutGetResponses count value.

getSnmpOutTraps

public long getSnmpOutTraps()

Gets the snmpOutTraps count. The snmpOutTraps is the total number of SNMP Trap PDUs which have been generated by the SNMP entity.

Returns:: The snmpOutTraps count value.

SetSnmpEnableAuthenTraps

public void SetSnmpEnableAuthenTraps(int status)

Sets the status of the snmpEnableAuthenTraps variable to be enabled or disabled. A value 1 indicates enabled and 2 indicates disabled. Any other value apart from these two will be treated as disabled. The default value is disabled. The snmpEnableAuthenTraps indicates whether the SNMP agent process is permitted to generate authentication-failure traps. The value of this object overrides any configuration information; as such, it provides a means whereby all authentication-failure traps may be disabled.

Parameters:: status - The int value(1 or 2) to be set.

GetSnmpEnableAuthenTraps

public int GetSnmpEnableAuthenTraps()

Gets the status of the snmpEnableAuthenTraps variable. The status value is either 1 or 2. A value 1 indicates enabled and 2 indicates disabled. The snmpEnableAuthenTraps indicates whether the SNMP agent process is permitted to generate authentication-failure traps. The value of this object overrides any configuration information; as such, it provides a means whereby all authentication-failure traps may be disabled.

Returns:: the status, enabled or disabled of the snmpEnableAuthenTraps.

getSnmpSilentDrops

public long getSnmpSilentDrops()

Gets the snmpSilentDrops count. The snmpSilentDrops is the total number of GetRequest-PDUs, GetNextRequest-PDUs, GetBulkRequest-PDUs, SetRequest-PDUs, and InformRequest-PDUs delivered to the SNMP entity which were silently dropped because the size of a reply containing an alternate Response-PDU with an empty variable-bindings field was greater than either a local constraint or the maximum message size associated with the originator of the request.

incrSnmpSilentDrops

public void incrSnmpSilentDrops()

Increment the snmpSilentDrops count by one. The snmpSilentDrops is the total number of GetRequest-PDUs, GetNextRequest-PDUs, GetBulkRequest-PDUs, SetRequest-PDUs, and InformRequest-PDUs delivered to the SNMP entity, which were silently dropped because the size of a reply containing an alternate Response-PDU with an empty variable-bindings field, was greater than either a local constraint or the maximum message size associated with the originator of the request.

getSnmpProxyDrops

public long getSnmpProxyDrops()

Gets the snmpSilentDrops count. The total number of GetRequest-PDUs, GetNextRequest-PDUs, GetBulkRequest-PDUs, SetRequest-PDUs, and InformRequest-PDUs delivered to the SNMP entity, which were silently dropped because the transmission of the (possibly translated) message to a proxy target failed in a manner, (other than a time-out) such that no Response-PDU could be returned.

incrSnmpProxyDrops

public void incrSnmpProxyDrops()

Increments the snmpSilentDrops count by one. The total number of GetRequest-PDUs, GetNextRequest-PDUs, GetBulkRequest-PDUs, SetRequest-PDUs, and InformRequest-PDUs delivered to the SNMP entity, which were silently dropped because the transmission of the (possibly translated) message to a proxy target failed in a manner (other than a time-out) such that no Response-PDU could be returned.