Class EnumeratedScalar<V extends org.snmp4j.smi.Variable>

java.lang.Object

org.snmp4j.agent.mo.MOScalar<V>

org.snmp4j.agent.mo.snmp.EnumeratedScalar<V>

All Implemented Interfaces:

ManagedObject<SubRequest<?>>, ManagedObjectValueAccess<SubRequest<?>>, ChangeableManagedObject<SubRequest<?>>, GenericManagedObject, MOScope, RandomAccessManagedObject<SubRequest<?>>, RegisteredManagedObject<SubRequest<?>>, SerializableManagedObject<SubRequest<?>>

Direct Known Subclasses:

AgentppSimulationMib.AgentppSimMode, Snmp4jConfigMib.Snmp4jCfgReset, Snmp4jConfigMib.Snmp4jCfgSecSrcAddrValidation

public class EnumeratedScalar<V extends org.snmp4j.smi.Variable>
extends MOScalar<V>

The EnumeratedScalar class represents enumerated SMI INTEGER (=Integer32) or an OCTET STRING with enumerated named bits for scalar objects. The latter represents the SMI construct BITS.

Version:

3.1.0

Author:

Frank Fock

Field Summary

Fields inherited from class MOScalar

access, oid, value

Constructor Summary

Constructors

Constructor	Description
EnumeratedScalar(org.snmp4j.smi.OID oid, MOAccess access, V value)	Creates an enumerated Integer32 or BITS (OctetString) scalar with specifying a set of possible values.
EnumeratedScalar(org.snmp4j.smi.OID oid, MOAccess access, V value, int[] allowedValues)	Creates an enumerated scalar with specifying a set of possible values.

Method Summary

Modifier and Type	Method	Description
int	isValueOK(SubRequest<?> request)	Checks whether the new value contained in the supplied sub-request is a valid value for this object.
protected void	setConstraint(EnumerationConstraint constraint)

Methods inherited from class MOScalar

addMOChangeListener, addMOValueValidationListener, changeValue, checkRequestScope, cleanup, commit, covers, exportInstance, find, fireAfterMOChange, fireAfterPrepareMOChange, fireBeforeMOChange, fireBeforePrepareMOChange, fireValidate, get, getAccess, getID, getLowerBound, getOid, getScope, getSingleInstanceScope, getSyntax, getUpperBound, getValue, getValue, importInstance, instanceCount, instanceIterator, isConfigurable, isCovered, isLowerIncluded, isOverlapping, isUpperIncluded, isVolatile, load, next, prepare, removeMOChangeListener, removeMOValueValidationListener, save, setValue, setValue, setVolatile, toString, toStringDetails, undo

Methods inherited from class Object

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

Methods inherited from interface ManagedObject

find, next

Methods inherited from interface MOScope

isEmpty

Methods inherited from interface RandomAccessManagedObject

getInstanceSubID, isVolatile

Constructor Details

EnumeratedScalar

public EnumeratedScalar(org.snmp4j.smi.OID oid,
 MOAccess access,
 V value)

Creates an enumerated Integer32 or BITS (OctetString) scalar with specifying a set of possible values. To constraint the possible values assignable to this object, you will have to set the corresponding EnumerationConstraint with setConstraint(EnumerationConstraint) or use an appropriate value validation listener.

Parameters:

oid - the instance oid (with ".0" suffix) of the scalar.

access - the maximum access for this column.

value - the initial value.

EnumeratedScalar

public EnumeratedScalar(org.snmp4j.smi.OID oid,
 MOAccess access,
 V value,
 int[] allowedValues)

Creates an enumerated scalar with specifying a set of possible values.

Parameters:

oid - the instance oid (with ".0" suffix) of the scalar.

access - the maximum access for this column.

value - the initial value.

allowedValues - an array of possible values for this object.

Method Details

isValueOK

public int isValueOK(SubRequest<?> request)

Description copied from class: MOScalar

Checks whether the new value contained in the supplied sub-request is a valid value for this object. The checks are performed by firing a MOValueValidationEvent the registered listeners.

Overrides:

isValueOK in class MOScalar<V extends org.snmp4j.smi.Variable>

Parameters:

request - the SubRequest with the new value.

Returns:

SnmpConstants.SNMP_ERROR_SUCCESS if the new value is OK, any other appropriate SNMPv2/v3 error status if not.

setConstraint

protected void setConstraint(EnumerationConstraint constraint)