public interface TextualConvention<V extends org.snmp4j.smi.Variable>
TextualConvention
interface defines the common properties
of SMI textual conventions needed to use them across different MIB modules
within an agent implementation.
A textual convention is characterized by its name and the MIB module name where it has been defined. With these attributes a TC registry is able to lookup TC implementations by name.
A MOFactory
can then use a TC name to lookup its implementation
and then use one of the two factory methods of each TC to create either
a scalar or columnar ManagedObject
instance.
If you need to use your own TC implementations (either replacing/extending
already provided ones or adding new ones) then register them to the
MOFactory
you are using.
Modifier and Type | Method and Description |
---|---|
MOColumn<V> |
createColumn(int columnID,
int syntax,
MOAccess access,
V defaultValue,
boolean mutableInService)
Creates a MOColumn instance of this TC specified by the column ID,
access, default value, and mutable flag.
|
V |
createInitialValue()
Creates an initial value for an object instance of this textual convention.
|
MOScalar<V> |
createScalar(org.snmp4j.smi.OID oid,
MOAccess access,
V value)
Creates a MOScalar instance of this TC specified by OID, access, and
optional value.
|
String |
getModuleName()
Returns the MIB module name that defined this textual convention.
|
String |
getName()
Returns the name of the textual convention as defined in the MIB module.
|
String getModuleName()
String getName()
MOScalar<V> createScalar(org.snmp4j.smi.OID oid, MOAccess access, V value)
oid
- the OID of the scalar isntance.access
- the access definition.value
- the Variable
instance containing the value of the
scalar. If value
is null
, the TC should create
an initial value with createInitialValue()
.MOColumn<V> createColumn(int columnID, int syntax, MOAccess access, V defaultValue, boolean mutableInService)
columnID
- the column id as defined in the MIB module (typically starting at one).syntax
- the SMI syntax supported by the column.access
- the access definition.defaultValue
- the default value or null
if there is no DEFVAL clause for
this column.mutableInService
- true
if this column may be modified while row is in
service.V createInitialValue()
Copyright © 2020 SNMP4J.org. All rights reserved.