Package org.snmp4j.agent.mo
Class MOMutableColumn<V extends org.snmp4j.smi.Variable>
java.lang.Object
org.snmp4j.agent.mo.MOColumn<V>
org.snmp4j.agent.mo.MOMutableColumn<V>
- All Implemented Interfaces:
Comparable
- Direct Known Subclasses:
AutonomousType,DateAndTime,DisplayString,Enumerated,KeyChange,RowPointer,RowStatus,SnmpAdminString,SnmpTagList,SnmpTagValue,StorageType
The
MOMutableColumn class represents mutable columnar SMI
objects. It represents all instances of a table's column not only a
single instance (cell).
Objects represented by MOMutableColumn can be modified via SNMP,
thus MOColumn supports read-only, read-write, and read-create
maximum access.
- Version:
- 1.0
- Author:
- Frank Fock
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionMOMutableColumn(int columnID, int syntax) Creates a read-only column object with the given column and syntax.MOMutableColumn(int columnID, int syntax, MOAccess access) Creates a column object with the given column, syntax, and maximum access.MOMutableColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue) Creates a column object with the given column, syntax, and maximum access.MOMutableColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue, boolean mutableInService) Creates a column object with the given column, syntax, and maximum access. -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidcleanup(SubRequest subRequest, MOTableRow row, int column) voidcommit(SubRequest subRequest, MOTableRow row, MOTableRow changeSet, int column) org.snmp4j.smi.VariablebooleanReturnstrueif this column must be specified in a SET request which creates a row.booleanvoidprepare(SubRequest subRequest, MOTableRow row, MOTableRow changeSet, int column) voidvoidsetDefaultValue(org.snmp4j.smi.Variable defaultValue) voidsetMandatory(boolean mandatory) Sets a flag that determines if this column must be specified in a SET request which creates a row.voidsetMutableInService(boolean mutableInService) toString()voidundo(SubRequest subRequest, MOTableRow row, int column) intvalidate(org.snmp4j.smi.Variable newValue, org.snmp4j.smi.Variable oldValue) protected booleanvalidateSetRequest(SubRequest subRequest, MOTableRow row, int column) Methods inherited from class org.snmp4j.agent.mo.MOColumn
compareTo, get, getAccess, getColumnID, getRestoreValue, getStoreValue, getSyntax, getTable, getValue, isVolatile, setAccess, setColumnID, setSyntax, setTable
-
Constructor Details
-
MOMutableColumn
public MOMutableColumn(int columnID, int syntax) Creates a read-only column object with the given column and syntax.- Parameters:
columnID- the column ID which is ID the last sub-identifier of the corresponding OBJECT-TYPE definition.syntax- the syntax of the objects in this column. SeeSMIConstantsfor possible values.
-
MOMutableColumn
Creates a column object with the given column, syntax, and maximum access. SinceMOColumnonly supports read-only columns the only reasonable values foraccessare 'not-accessible' and 'read-only'. Generally this constructor should not be called directly.- Parameters:
columnID- the column ID which is ID the last sub-identifier of the corresponding OBJECT-TYPE definition.syntax- the syntax of the objects in this column. SeeSMIConstantsfor possible values.access- the maximum access of the column.
-
MOMutableColumn
public MOMutableColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue) Creates a column object with the given column, syntax, and maximum access. SinceMOColumnonly supports read-only columns the only reasonable values foraccessare 'not-accessible' and 'read-only'. Generally this constructor should not be called directly.- Parameters:
columnID- the column ID which is ID the last sub-indentifer of the corresponding OBJECT-TYPE definition.syntax- the syntax of the objects in this column. SeeSMIConstantsfor possible values.access- the maximum access of the column.defaultValue- the default value for new rows.
-
MOMutableColumn
public MOMutableColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue, boolean mutableInService) Creates a column object with the given column, syntax, and maximum access. SinceMOColumnonly supports read-only columns the only reasonable values foraccessare 'not-accessible' and 'read-only'. Generally this constructor should not be called directly.- Parameters:
columnID- the column ID which is ID the last sub-indentifer of the corresponding OBJECT-TYPE definition.syntax- the syntax of the objects in this column. SeeSMIConstantsfor possible values.access- the maximum access of the column.defaultValue- the default value for new rows.mutableInService- iftruethis column accepts value changes through SNMP (viaprepare(org.snmp4j.agent.request.SubRequest, MOTableRow, MOTableRow, int)andcommit(org.snmp4j.agent.request.SubRequest, MOTableRow, MOTableRow, int)while the rowsRowStatusobject is in stateRowStatus.active. Otherwise, such an operation will result in aPDU.inconsistentValueerror.
-
-
Method Details
-
addMOValueValidationListener
-
removeMOValueValidationListener
-
validate
public int validate(org.snmp4j.smi.Variable newValue, org.snmp4j.smi.Variable oldValue) -
validateSetRequest
-
prepare
-
commit
-
undo
-
cleanup
-
setDefaultValue
public void setDefaultValue(org.snmp4j.smi.Variable defaultValue) -
setMutableInService
public void setMutableInService(boolean mutableInService) -
getDefaultValue
public org.snmp4j.smi.Variable getDefaultValue() -
isMutableInService
public boolean isMutableInService() -
isMandatory
public boolean isMandatory()Returnstrueif this column must be specified in a SET request which creates a row.- Returns:
trueif this row has a maximum access of READ-CREATE and has anulldefault value,falseotherwise.
-
setMandatory
public void setMandatory(boolean mandatory) Sets a flag that determines if this column must be specified in a SET request which creates a row. The default istrue.- Parameters:
mandatory- iftrueand a row has a maximum access of READ-CREATE and has anulldefault value, then it must be provided in order to activate the row.- Since:
- 1.3.2
-
toString
-