com.outbackinc.services.protocol.snmp
Class SnmpConstants

java.lang.Object
  |
  +--com.outbackinc.services.protocol.snmp.SnmpConstants

public class SnmpConstants

extends java.lang.Object

Contains the SNMP type and error constants used in the jSNMP APIs. The SNMP ASN.1 types are mapped to Java types via the SnmpVarBind APIs getType() and getValue() as follows:

ASN.1	SnmpConstants	Java
NULL	ASN_NULL	null
INTEGER and Integer32	ASN_INTEGER and ASN_INTEGER32	java.math.BigInteger
OCTET STRING	ASN_OCTSTR	byte[ ]
Opaque	ASN_OPAQUE	byte[ ]
IpAddress	ASN_IPADDRESS	java.lang.String
OBJECT IDENTIFIER	ASN_OID	java.lang.String
Counter and Counter32	ASN_COUNTER and ASN_COUNTER32	java.lang.Long
Gauge, Gauge32, and Unsigned32	ASN_GAUGE, ASN_GAUGE32, and ASN_UNSIGNED32	java.lang.Long
TimeTicks	ASN_TIMETICKS	java.lang.Long
Counter64	ASN_COUNTER64	java.math.BigInteger
UInteger32 (historic)	ASN_UINTEGER32	java.lang.Long

See Also:

SnmpVarBind

Field Summary

static byte	ASN_COUNTER SNMPv1 Counter
static byte	ASN_COUNTER32 SNMPv2 Counter32 (alias for ASN_COUNTER)
static byte	ASN_COUNTER64 SNMPv2 Counter64
static byte	ASN_ENDOFMIBVIEW SNMPv2 endOfMibView
static byte	ASN_GAUGE SNMPv1 Gauge
static byte	ASN_GAUGE32 SNMPv2 Gauge32 (alias for ASN_GAUGE)
static byte	ASN_INTEGER SNMPv1 INTEGER
static byte	ASN_INTEGER32 SNMPv2 Integer32 (alias for ASN_INTEGER)
static byte	ASN_IPADDRESS SNMPv1/2 IpAddress
static byte	ASN_NOSUCHINSTANCE SNMPv2 noSuchInstance
static byte	ASN_NOSUCHOBJECT SNMPv2 noSuchObject
static byte	ASN_NULL SNMPv1/2 NULL
static byte	ASN_OCTSTR SNMPv1/2 OCTET STRING
static byte	ASN_OID SNMPv1/2 OBJECT IDENTIFIER
static byte	ASN_OPAQUE SNMPv1/2 Opaque
static byte	ASN_TIMETICKS SNMPv1/2 TimeTicks
static byte	ASN_UINTEGER32 SNMPv2 UInteger32 (historic); use ASN_GAUGE32; see RFC1905 (http://www.ietf.org/rfc/rfc1905.txt)
static byte	ASN_UNSIGNED32 SNMPv2 Unsigned32 (alias for ASN_GAUGE32)
static int	SNMP_ERR_ATOMIC_SUCCESS Error returned from a modification order when although the individual order may have succeeded, an error in another in the group caused this to fail
static int	SNMP_ERR_ATOMIC_UNKNOWN Error returned from a modification order when a previous element of the group has failed.
static int	SNMP_ERR_AUTHCLEARED_PRIVSET SNMPv3 authentication cleared and privacy set
static int	SNMP_ERR_AUTHORIZATIONERROR SNMPv2 authorizationError
static int	SNMP_ERR_BADVALUE SNMPv1/2 badValue
static int	SNMP_ERR_COMM_CRASH Socket failure
static int	SNMP_ERR_COMMITFAILED SNMPv2 commitFailed
static int	SNMP_ERR_DECRYPTION_ERROR SNMPv3 decryption error
static int	SNMP_ERR_ENDOFMIBVIEW SNMPv2 endOfMibView exception
static int	SNMP_ERR_GENERAL SNMPv1/2 genErr
static int	SNMP_ERR_INCONSISTENTNAME SNMPv2 inconsistentName
static int	SNMP_ERR_INCONSISTENTVALUE SNMPv2 inconsistentValue
static int	SNMP_ERR_INVALID_ARGUMENT Invalid method argument
static int	SNMP_ERR_MESSAGE_PROCESSING SNMPv3 unable to process message
static int	SNMP_ERR_NOACCESS SNMPv2 noAccess
static int	SNMP_ERR_NOCREATION SNMPv2 noCreation
static int	SNMP_ERR_NONE SNMPv1/2 noError
static int	SNMP_ERR_NOSUCHINSTANCE SNMPv2 noSuchInstance exception
static int	SNMP_ERR_NOSUCHNAME SNMPv1/2 noSuchName
static int	SNMP_ERR_NOSUCHOBJECT SNMPv2 noSuchObject exception
static int	SNMP_ERR_NOT_IN_TIME_WINDOW SNMPv3 timeliness
static int	SNMP_ERR_NOTWRITABLE SNMPv2 notWritable
static int	SNMP_ERR_PROVIDING_AUTHPRIV SNMPv3 cannot provide authentication/privacy
static int	SNMP_ERR_READONLY SNMPv1/2 readOnly
static int	SNMP_ERR_RESOURCEUNAVAILABLE SNMPv2 resourceUnavailable
static int	SNMP_ERR_RESPONSE_SIZE_MISMATCH Deprecated. as of jSNMP v3.0
static int	SNMP_ERR_RESPONSENOTGENERATED SNMPv3 response not generated
static int	SNMP_ERR_SECURITY_EXCEPTION Security error
static int	SNMP_ERR_SERVICE_NOT_STARTED Service not started
static int	SNMP_ERR_TIMEOUT Request timeout
static int	SNMP_ERR_TOOBIG SNMPv1/2 tooBig
static int	SNMP_ERR_UNDOFAILED SNMPv2 undoFailed
static int	SNMP_ERR_UNKNOWN_ENGINE_ID SNMPv3 unknown engine ID
static int	SNMP_ERR_UNKNOWN_HOST Unable to resolve host
static int	SNMP_ERR_UNKNOWN_SECURITY_LEVEL SNMPv3 unknown security level
static int	SNMP_ERR_UNKNOWN_USER_NAME SNMPv3 unknown user name
static int	SNMP_ERR_UNSUPPORTED_TYPE Unknown request or data type
static int	SNMP_ERR_WRONG_DIGEST SNMPv3 incorrect digest
static int	SNMP_ERR_WRONGENCODING SNMPv2 wrongEncoding
static int	SNMP_ERR_WRONGLENGTH SNMPv2 wrongLength
static int	SNMP_ERR_WRONGTYPE SNMPv2 wrongType
static int	SNMP_ERR_WRONGVALUE SNMPv2 wrongValue
static byte	SNMP_GET SNMPv1/2 GetRequest
static byte	SNMP_GET_BULK SNMPv2 GetBulkRequest
static byte	SNMP_GET_NEXT SNMPv1/2 GetNextRequest
static byte	SNMP_GET_RESP SNMPv1/2 GetResponse
static byte	SNMP_INFORM SNMPv2 InformRequest
static byte	SNMP_REPORT SNMPv2 Report
static byte	SNMP_SET SNMPv1/2 SetRequest
static byte	SNMP_TRAP SNMPv1 Trap
static byte	SNMP_TRAPV2 SNMPv2 SNMPv2-Trap
static int	SNMP_VERSION_1 SNMP version 1
static int	SNMP_VERSION_2 SNMP version 2
static int	SNMP_VERSION_3 SNMP version 3
static java.lang.Integer	TRAP_AUTHENTICATION_FAILURE SNMPv1 authenticationFailure
static java.lang.Integer	TRAP_COLD_START SNMPv1 coldStart
static java.lang.Integer	TRAP_EGP_NEIGHBOR_LOSS SNMPv1 egpNeighborLoss
static java.lang.Integer	TRAP_LINK_DOWN SNMPv1 linkDown
static java.lang.Integer	TRAP_LINK_UP SNMPv1 linkUp
static java.lang.Integer	TRAP_WARM_START SNMPv1 warmStart

Method Summary

static java.lang.String

errorIDToString(int iErrorCode) Translate error codes into descriptive string equivalents.

Methods inherited from class java.lang.Object

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

Field Detail

ASN_INTEGER

public static final byte ASN_INTEGER

SNMPv1 INTEGER

ASN_OCTSTR

public static final byte ASN_OCTSTR

SNMPv1/2 OCTET STRING

ASN_NULL

public static final byte ASN_NULL

SNMPv1/2 NULL

ASN_OID

public static final byte ASN_OID

SNMPv1/2 OBJECT IDENTIFIER

ASN_IPADDRESS

public static final byte ASN_IPADDRESS

SNMPv1/2 IpAddress

ASN_COUNTER

public static final byte ASN_COUNTER

SNMPv1 Counter

ASN_GAUGE

public static final byte ASN_GAUGE

SNMPv1 Gauge

ASN_TIMETICKS

public static final byte ASN_TIMETICKS

SNMPv1/2 TimeTicks

ASN_OPAQUE

public static final byte ASN_OPAQUE

SNMPv1/2 Opaque

ASN_NOSUCHOBJECT

public static final byte ASN_NOSUCHOBJECT

SNMPv2 noSuchObject

ASN_NOSUCHINSTANCE

public static final byte ASN_NOSUCHINSTANCE

SNMPv2 noSuchInstance

ASN_ENDOFMIBVIEW

public static final byte ASN_ENDOFMIBVIEW

SNMPv2 endOfMibView

ASN_COUNTER32

public static final byte ASN_COUNTER32

SNMPv2 Counter32 (alias for ASN_COUNTER)

ASN_GAUGE32

public static final byte ASN_GAUGE32

SNMPv2 Gauge32 (alias for ASN_GAUGE)

ASN_UNSIGNED32

public static final byte ASN_UNSIGNED32

SNMPv2 Unsigned32 (alias for ASN_GAUGE32)

ASN_INTEGER32

public static final byte ASN_INTEGER32

SNMPv2 Integer32 (alias for ASN_INTEGER)

ASN_COUNTER64

public static final byte ASN_COUNTER64

SNMPv2 Counter64

ASN_UINTEGER32

public static final byte ASN_UINTEGER32

SNMPv2 UInteger32 (historic); use ASN_GAUGE32; see RFC1905 (http://www.ietf.org/rfc/rfc1905.txt)

SNMP_GET

public static final byte SNMP_GET

SNMPv1/2 GetRequest

SNMP_GET_NEXT

public static final byte SNMP_GET_NEXT

SNMPv1/2 GetNextRequest

SNMP_GET_RESP

public static final byte SNMP_GET_RESP

SNMPv1/2 GetResponse

SNMP_SET

public static final byte SNMP_SET

SNMPv1/2 SetRequest

SNMP_TRAP

public static final byte SNMP_TRAP

SNMPv1 Trap

SNMP_GET_BULK

public static final byte SNMP_GET_BULK

SNMPv2 GetBulkRequest

SNMP_INFORM

public static final byte SNMP_INFORM

SNMPv2 InformRequest

SNMP_TRAPV2

public static final byte SNMP_TRAPV2

SNMPv2 SNMPv2-Trap

SNMP_REPORT

public static final byte SNMP_REPORT

SNMPv2 Report

SNMP_ERR_NONE

public static final int SNMP_ERR_NONE

SNMPv1/2 noError

SNMP_ERR_TOOBIG

public static final int SNMP_ERR_TOOBIG

SNMPv1/2 tooBig

SNMP_ERR_NOSUCHNAME

public static final int SNMP_ERR_NOSUCHNAME

SNMPv1/2 noSuchName

SNMP_ERR_BADVALUE

public static final int SNMP_ERR_BADVALUE

SNMPv1/2 badValue

SNMP_ERR_READONLY

public static final int SNMP_ERR_READONLY

SNMPv1/2 readOnly

SNMP_ERR_GENERAL

public static final int SNMP_ERR_GENERAL

SNMPv1/2 genErr

SNMP_ERR_NOACCESS

public static final int SNMP_ERR_NOACCESS

SNMPv2 noAccess

SNMP_ERR_WRONGTYPE

public static final int SNMP_ERR_WRONGTYPE

SNMPv2 wrongType

SNMP_ERR_WRONGLENGTH

public static final int SNMP_ERR_WRONGLENGTH

SNMPv2 wrongLength

SNMP_ERR_WRONGENCODING

public static final int SNMP_ERR_WRONGENCODING

SNMPv2 wrongEncoding

SNMP_ERR_WRONGVALUE

public static final int SNMP_ERR_WRONGVALUE

SNMPv2 wrongValue

SNMP_ERR_NOCREATION

public static final int SNMP_ERR_NOCREATION

SNMPv2 noCreation

SNMP_ERR_INCONSISTENTVALUE

public static final int SNMP_ERR_INCONSISTENTVALUE

SNMPv2 inconsistentValue

SNMP_ERR_RESOURCEUNAVAILABLE

public static final int SNMP_ERR_RESOURCEUNAVAILABLE

SNMPv2 resourceUnavailable

SNMP_ERR_COMMITFAILED

public static final int SNMP_ERR_COMMITFAILED

SNMPv2 commitFailed

SNMP_ERR_UNDOFAILED

public static final int SNMP_ERR_UNDOFAILED

SNMPv2 undoFailed

SNMP_ERR_AUTHORIZATIONERROR

public static final int SNMP_ERR_AUTHORIZATIONERROR

SNMPv2 authorizationError

SNMP_ERR_NOTWRITABLE

public static final int SNMP_ERR_NOTWRITABLE

SNMPv2 notWritable

SNMP_ERR_INCONSISTENTNAME

public static final int SNMP_ERR_INCONSISTENTNAME

SNMPv2 inconsistentName

SNMP_ERR_TIMEOUT

public static final int SNMP_ERR_TIMEOUT

Request timeout

SNMP_ERR_RESPONSE_SIZE_MISMATCH

public static final int SNMP_ERR_RESPONSE_SIZE_MISMATCH

Deprecated. as of jSNMP v3.0

Request timeout

SNMP_ERR_COMM_CRASH

public static final int SNMP_ERR_COMM_CRASH

Socket failure

SNMP_ERR_UNSUPPORTED_TYPE

public static final int SNMP_ERR_UNSUPPORTED_TYPE

Unknown request or data type

SNMP_ERR_UNKNOWN_HOST

public static final int SNMP_ERR_UNKNOWN_HOST

Unable to resolve host

SNMP_ERR_INVALID_ARGUMENT

public static final int SNMP_ERR_INVALID_ARGUMENT

Invalid method argument

SNMP_ERR_SERVICE_NOT_STARTED

public static final int SNMP_ERR_SERVICE_NOT_STARTED

Service not started

SNMP_ERR_SECURITY_EXCEPTION

public static final int SNMP_ERR_SECURITY_EXCEPTION

Security error

SNMP_ERR_ATOMIC_SUCCESS

public static final int SNMP_ERR_ATOMIC_SUCCESS

Error returned from a modification order when although the individual order may have succeeded, an error in another in the group caused this to fail

SNMP_ERR_ATOMIC_UNKNOWN

public static final int SNMP_ERR_ATOMIC_UNKNOWN

Error returned from a modification order when a previous element of the group has failed. As such, this order was not set and the status is unknown

SNMP_ERR_NOSUCHOBJECT

public static final int SNMP_ERR_NOSUCHOBJECT

SNMPv2 noSuchObject exception

SNMP_ERR_NOSUCHINSTANCE

public static final int SNMP_ERR_NOSUCHINSTANCE

SNMPv2 noSuchInstance exception

SNMP_ERR_ENDOFMIBVIEW

public static final int SNMP_ERR_ENDOFMIBVIEW

SNMPv2 endOfMibView exception

SNMP_ERR_UNKNOWN_SECURITY_LEVEL

public static final int SNMP_ERR_UNKNOWN_SECURITY_LEVEL

SNMPv3 unknown security level

SNMP_ERR_NOT_IN_TIME_WINDOW

public static final int SNMP_ERR_NOT_IN_TIME_WINDOW

SNMPv3 timeliness

SNMP_ERR_UNKNOWN_USER_NAME

public static final int SNMP_ERR_UNKNOWN_USER_NAME

SNMPv3 unknown user name

SNMP_ERR_UNKNOWN_ENGINE_ID

public static final int SNMP_ERR_UNKNOWN_ENGINE_ID

SNMPv3 unknown engine ID

SNMP_ERR_WRONG_DIGEST

public static final int SNMP_ERR_WRONG_DIGEST

SNMPv3 incorrect digest

SNMP_ERR_DECRYPTION_ERROR

public static final int SNMP_ERR_DECRYPTION_ERROR

SNMPv3 decryption error

SNMP_ERR_RESPONSENOTGENERATED

public static final int SNMP_ERR_RESPONSENOTGENERATED

SNMPv3 response not generated

SNMP_ERR_AUTHCLEARED_PRIVSET

public static final int SNMP_ERR_AUTHCLEARED_PRIVSET

SNMPv3 authentication cleared and privacy set

SNMP_ERR_PROVIDING_AUTHPRIV

public static final int SNMP_ERR_PROVIDING_AUTHPRIV

SNMPv3 cannot provide authentication/privacy

SNMP_ERR_MESSAGE_PROCESSING

public static final int SNMP_ERR_MESSAGE_PROCESSING

SNMPv3 unable to process message

SNMP_VERSION_1

public static final int SNMP_VERSION_1

SNMP version 1

SNMP_VERSION_2

public static final int SNMP_VERSION_2

SNMP version 2

SNMP_VERSION_3

public static final int SNMP_VERSION_3

SNMP version 3

TRAP_COLD_START

public static final java.lang.Integer TRAP_COLD_START

SNMPv1 coldStart

TRAP_WARM_START

public static final java.lang.Integer TRAP_WARM_START

SNMPv1 warmStart

TRAP_LINK_DOWN

public static final java.lang.Integer TRAP_LINK_DOWN

SNMPv1 linkDown

TRAP_LINK_UP

public static final java.lang.Integer TRAP_LINK_UP

SNMPv1 linkUp

TRAP_AUTHENTICATION_FAILURE

public static final java.lang.Integer TRAP_AUTHENTICATION_FAILURE

SNMPv1 authenticationFailure

TRAP_EGP_NEIGHBOR_LOSS

public static final java.lang.Integer TRAP_EGP_NEIGHBOR_LOSS

SNMPv1 egpNeighborLoss

Method Detail

errorIDToString

public static final java.lang.String errorIDToString(int iErrorCode)

Translate error codes into descriptive string equivalents.

Parameters:

iErrorCode - error code (SNMP_ERR_TOOBIG, etc.)