org.snmp4j.agent.mo.snmp
Class EnumeratedScalar

java.lang.Object
  org.snmp4j.agent.mo.MOScalar
      org.snmp4j.agent.mo.snmp.EnumeratedScalar

All Implemented Interfaces:

ManagedObject, ManagedObjectValueAccess, MOScope, RegisteredManagedObject, SerializableManagedObject

Direct Known Subclasses:

AgentppSimulationMib.AgentppSimMode, Snmp4jConfigMib.Snmp4jCfgSecSrcAddrValidation

public class EnumeratedScalar
extends MOScalar

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:

1.2

Author:

Frank Fock

Constructor Summary

EnumeratedScalar(org.snmp4j.smi.OID oid, MOAccess access, org.snmp4j.smi.Integer32 value)
Creates an enumerated INTEGER scalar with specifying a set of possible values.

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

EnumeratedScalar(org.snmp4j.smi.OID oid, MOAccess access, org.snmp4j.smi.OctetString value)
Creates a BITS scalar with specifying a set of possible bit values.

EnumeratedScalar(org.snmp4j.smi.OID oid, MOAccess access, org.snmp4j.smi.OctetString value, int[] allowedValues)
Creates a BITS scalar with specifying a set of possible bit values.

Method Summary

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 org.snmp4j.agent.mo.MOScalar

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumeratedScalar

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

Creates an enumerated INTEGER scalar with specifying a set of possible values. To constraint the possible values assignable to this object, you will have to set the corrsponding EnumerationConstraint with setConstraint(org.snmp4j.agent.mo.snmp.smi.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,
                        org.snmp4j.smi.Integer32 value,
                        int[] allowedValues)

Creates an enumerated INTEGER 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.

EnumeratedScalar

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

Creates a BITS scalar with specifying a set of possible bit values. To constraint the possible values assignable to this object, you will have to set the corrsponding EnumerationConstraint with setConstraint(org.snmp4j.agent.mo.snmp.smi.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.

Since:

1.2

EnumeratedScalar

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

Creates a BITS scalar with specifying a set of possible bit 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.

Since:

1.2

Method Detail

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

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)