uk.co.westhawk.snmp.stack

Class AsnObject

java.lang.Object

uk.co.westhawk.snmp.stack.AsnObject

All Implemented Interfaces:

SnmpConstants

Direct Known Subclasses:

AsnInteger, AsnNull, AsnObjectId, AsnOctets, AsnPrimitive, AsnUnsInteger, AsnUnsInteger64

public abstract class AsnObject
extends java.lang.Object
implements SnmpConstants

This class represents the ASN.1 base class. SMIv1 RFC1155-SMI. SMIv2 SNMPv2-SMI.

 <ASN Object> = <type> <length> <ASN Object>
 or
 <ASN Object> = <type> <length> <value>
 

Version:

$Revision$ $Date$

Author:

Tim Panton

Field Summary

Fields

Modifier and Type	Field and Description
protected int	contentsLength The length of the actual contents.
static int	debug Indicates the level of debug printed.
protected int	headerLength The length of the header.
protected boolean	isCorrect Flag to signal the object is of a correct type.
protected int	startPos The starting position of the AsnObject in the SNMP sequence.
protected byte	type The type of object.

Fields inherited from interface uk.co.westhawk.snmp.stack.SnmpConstants

ASN_APPLICATION, ASN_BIT_STR, ASN_BIT8, ASN_BOOLEAN, ASN_CONSTRUCTOR, ASN_CONTEXT, ASN_EXTENSION_ID, ASN_INTEGER, ASN_LONG_LEN, ASN_NULL, ASN_OBJECT_ID, ASN_OCTET_STR, ASN_PRIMITIVE, ASN_PRIVATE, ASN_SEQUENCE, ASN_SET, ASN_UNIVERSAL, CONS_SEQ, COUNTER, COUNTER64, GAUGE, GET_REQ_MSG, GET_RPRT_MSG, GET_RSP_MSG, GETBULK_REQ_MSG, GETNEXT_REQ_MSG, INFORM_REQ_MSG, INTEGER, IPADDRESS, NSAP_ADDRESS, NULLOBJ, OBJID, OBSOLETED_RFC1442_UINTEGER32, OPAQUE, SET_REQ_MSG, SMI_V2_UINTEGER32, SNMP_ERR_AUTHORIZATIONERR, SNMP_ERR_BADVALUE, SNMP_ERR_COMMITFAILED, SNMP_ERR_DECODING_EXC, SNMP_ERR_DECODINGASN_EXC, SNMP_ERR_DECODINGPKTLNGTH_EXC, SNMP_ERR_GENERR, SNMP_ERR_INCONSISTENTNAME, SNMP_ERR_INCONSISTENTVALUE, SNMP_ERR_NOACCESS, SNMP_ERR_NOCREATION, SNMP_ERR_NOERROR, SNMP_ERR_NOSUCHNAME, SNMP_ERR_NOTWRITABLE, SNMP_ERR_READONLY, SNMP_ERR_RESOURCEUNAVAILABLE, SNMP_ERR_TOOBIG, SNMP_ERR_UNDOFAILED, SNMP_ERR_WRONGENCODING, SNMP_ERR_WRONGLENGTH, SNMP_ERR_WRONGTYPE, SNMP_ERR_WRONGVALUE, SNMP_TRAP_AUTHFAIL, SNMP_TRAP_COLDSTART, SNMP_TRAP_EGPNEIGHBORLOSS, SNMP_TRAP_ENTERPRISESPECIFIC, SNMP_TRAP_LINKDOWN, SNMP_TRAP_LINKUP, SNMP_TRAP_WARMSTART, SNMP_VAR_ENDOFMIBVIEW, SNMP_VAR_NOSUCHINSTANCE, SNMP_VAR_NOSUCHOBJECT, SNMP_VERSION_1, SNMP_VERSION_2c, SNMP_VERSION_3, STRING, TIMETICKS, TRP_REQ_MSG, TRPV2_REQ_MSG

Constructor Summary

Constructors

Constructor and Description
AsnObject()

Method Summary

Modifier and Type	Method and Description
byte	getRespType() Returns the type of this Asn object, such as ASN_INTEGER or IPADDRESS.
java.lang.String	getRespTypeString() Returns the object type as string, such as "ASN_INTEGER" or "IPADDRESS".
static void	setDebug(int newDebug) Sets the new, global level of debug information for the stack package.
abstract java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

debug

public static int debug

Indicates the level of debug printed. By default this is none (0).

See Also:

setDebug(int)

type

protected byte type

The type of object.

startPos

protected int startPos

The starting position of the AsnObject in the SNMP sequence. That is the position of the 'type' byte.

headerLength

protected int headerLength

The length of the header. That is the number of bytes of the 'type' and 'length' fields. Since there are multiple valid encodings for a given AsnObject, this length is not fixed!

contentsLength

protected int contentsLength

The length of the actual contents. That is the same as the value of the 'length' field.

isCorrect

protected boolean isCorrect

Flag to signal the object is of a correct type.

Constructor Detail

AsnObject

public AsnObject()

Method Detail

toString

public abstract java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

The string

setDebug

public static void setDebug(int newDebug)

Sets the new, global level of debug information for the stack package. The default value is zero, i.e. no debug info at all. All debug messages are printed to System.out.

The following messages will appear when debug is > (greater than):

• 0 - IOExceptions that won't be thrown to the user
• 1 - DecodingExceptions that won't be thrown to the user (received message with wrong SNMP version)
• 2 - DecodingExceptions when trying to decode traps
• 3 - processIncomingResponse errors: (corresponding Pdu cannot be found)
• 4 - Discovery of EngineId, Timeline
• 5 - Receiving traps, version/host do not correspond
• 6 - Pdu messages, sending etc
• 10 - Asn decoding of incoming messages
• 12 - Transmitter messages, Socket messages
• 15 - Not so important IOExceptions, like InterruptedIOException

Parameters:

newDebug - the new debug value

getRespType

public byte getRespType()

Returns the type of this Asn object, such as ASN_INTEGER or IPADDRESS. Note, the name of this method is deceiving; It has nothing (more) to do with a response.

Returns:

The AsnObject type.

See Also:

getRespTypeString(), SnmpConstants

getRespTypeString

public java.lang.String getRespTypeString()

Returns the object type as string, such as "ASN_INTEGER" or "IPADDRESS". Note, the name of this method is deceiving; It has nothing (more) to do with a response.

Returns:

The AsnObject type.

See Also:

getRespType(), SnmpConstants