ipworksssnmp
Class SnmpagentGetRequestEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--ipworksssnmp.SnmpagentGetRequestEvent

All Implemented Interfaces:

java.io.Serializable

public class SnmpagentGetRequestEvent

extends java.util.EventObject

Fired when a GetRequest packet is received.

The list of variables in the SNMP packet, including optional values and types, is provided through the ObjId , ObjType , and ObjValue properties. The ObjCount property displays the number of variables. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

To send a response, the ErrorStatus parameter must be set to a valid SNMP status code (the default value is -1, in which case no response will be sent).

The following is a list of valid SNMP status code values:

0 (noError)

No error.

1 (tooBig)

The response cannot fit in a single SNMP message.

2 (noSuchName)

Variable does not exist.

3 (badValue)

Invalid value or syntax.

4 (readOnly)

Variable is read-only.

5 (genError)

Other error (SNMPv1).

6 (noAccess)

Access denied.

7 (wrongType)

Wrong object type.

8 (wrongLength)

Wrong length.

9 (wrongEncoding)

Wrong encoding.

10 (wrongValue)

Wrong value.

11 (noCreation)

No creation.

12 (inconsistentValue)

Inconsistent value.

13 (resourceUnavailable)

Resource unavailable.

14 (commitFailed)

Commit failed.

15 (undoFailed)

Undo failed.

16 (authorizationError)

Authorization error.

17 (notWritable)

Variable is not writable.

18 (inconsistentName)

Inconsistent name.

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

See Also:

Snmpagent, Snmpagent.GetRequestEvent, Serialized Form

Field Summary

java.lang.String	community
java.lang.String	errorDescription
int	errorIndex
int	errorStatus
int	requestId
int	securityLevel
int	SNMPVersion
java.lang.String	sourceAddress
int	sourcePort
java.lang.String	user

Fields inherited from class java.util.EventObject

source

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

requestId

public int requestId

SNMPVersion

public int SNMPVersion

community

public java.lang.String community

user

public java.lang.String user

securityLevel

public int securityLevel

sourceAddress

public java.lang.String sourceAddress

sourcePort

public int sourcePort

errorIndex

public int errorIndex

errorStatus

public int errorStatus

errorDescription

public java.lang.String errorDescription