LinkedMOFactory
DefaultMOFactory
, MOFactoryAdapter
, SimMOFactory
public interface MOFactory
MOFactory
interface provides factory methods for creating
all types of managed objects known by SNMP4J-Agent. By using this factory
instead of creating the managed objects and related objects directly,
one can easily install a sort of aspect oriented layer into the managed
object instrumentation.Modifier and Type | Method | Description |
---|---|---|
void |
addTextualConvention(TextualConvention tc) |
Adds a textual convention to this factory which can then be used by the
factory to create appropriate value constraints for columnar and scalar
managed objects.
|
default MOAccess |
createAccess(int moAccess) |
Creates an MOAccess instance from an access specification constant that is
the result of a bitwise OR of any of the constants defined by
MOAccess . |
default <V extends org.snmp4j.smi.Variable> |
createColumn(int columnID,
int syntax,
MOAccess access) |
Creates a columnar object by supplying column ID, syntax, and maximum
access.
|
default <V extends org.snmp4j.smi.Variable> |
createColumn(int columnID,
int syntax,
MOAccess access,
java.lang.String tcModuleName,
java.lang.String textualConvention) |
Creates a columnar object by supplying column ID, syntax, and maximum
access.
|
default <V extends org.snmp4j.smi.Variable> |
createColumn(int columnID,
int syntax,
MOAccess access,
V defaultValue,
boolean mutableInService) |
Creates a columnar object by supplying column ID, syntax, and maximum
access.
|
default <V extends org.snmp4j.smi.Variable> |
createColumn(int columnID,
int syntax,
MOAccess access,
V defaultValue,
boolean mutableInService,
java.lang.String tcModuleName,
java.lang.String textualConvention) |
Creates a columnar object by supplying column ID, syntax, and maximum
access.
|
default MOTableIndex |
createIndex(MOTableSubIndex[] subIndexes,
boolean impliedLength) |
Creates an index definition from the supplied sub-index definitions without
index validation.
|
default MOTableIndex |
createIndex(MOTableSubIndex[] subIndexes,
boolean impliedLength,
MOTableIndexValidator validator) |
Creates an index definition from the supplied sub-index definitions with
index validation according to the supplied validator.
|
default <V extends org.snmp4j.smi.Variable> |
createScalar(org.snmp4j.smi.OID id,
MOAccess access,
V value) |
Creates a scalar object from a OID, maximum access, and value.
|
default <V extends org.snmp4j.smi.Variable> |
createScalar(org.snmp4j.smi.OID id,
MOAccess access,
V value,
java.lang.String tcModuleName,
java.lang.String textualConvention) |
Creates a scalar object from a OID, maximum access, and value.
|
default MOTableSubIndex |
createSubIndex(org.snmp4j.smi.OID oid,
int smiSyntax) |
Creates a sub-index definition.
|
default MOTableSubIndex |
createSubIndex(org.snmp4j.smi.OID oid,
int smiSyntax,
int minLength,
int maxLength) |
Creates a sub-index definition.
|
default <R extends MOTableRow,M extends MOTableModel<R>> |
createTable(org.snmp4j.smi.OID oid,
MOTableIndex indexDef,
MOColumn[] columns) |
Creates a MOTable instance for the supplied OID, index definition, and
columns with the
DefaultMOMutableTableModel as table model. |
default <R extends MOTableRow,M extends MOTableModel<R>> |
createTable(org.snmp4j.smi.OID oid,
MOTableIndex indexDef,
MOColumn[] columns,
M model) |
Creates a MOTable instance for the supplied OID, index definition,
columns, and table model.
|
default <R extends MOTableRow,M extends MOTableModel<? extends R>> |
createTableModel(org.snmp4j.smi.OID tableOID,
MOTableIndex indexDef,
MOColumn[] columns) |
Creates a table model (by default a
DefaultMOMutableTableModel ). |
default <BaseRow extends MOTableRow,DependentRow extends MOTableRow> |
createTableRelation(MOTable<BaseRow,? extends MOColumn,? extends MOTableModel<BaseRow>> baseTable,
MOTable<DependentRow,? extends MOColumn,? extends MOTableModel<DependentRow>> dependentTable) |
Creates a relation between two tables.
|
default SysUpTime |
getSysUpTime(org.snmp4j.smi.OctetString context) |
Gets a reference to the systems up-time object for the specified context.
|
<V extends org.snmp4j.smi.Variable> |
getTextualConvention(java.lang.String moduleName,
java.lang.String name) |
Gets the textual convention described by the TC's name and the MIB module
name of the MIB module specifying the TC.
|
void |
removeTextualConvention(TextualConvention tc) |
Removes the supplied textual convention from the supported TCs by this
ManagedObject factory.
|
void addTextualConvention(TextualConvention tc)
tc
- a TextualConvention instance.void removeTextualConvention(TextualConvention tc)
tc
- a TextualConvention instance.<V extends org.snmp4j.smi.Variable> TextualConvention<V> getTextualConvention(java.lang.String moduleName, java.lang.String name)
V
- the Variable
type that is the base type of the returned textual convention.moduleName
- the name of the MIB module that defines the TC.name
- the object name of the TC.TextualConvention
that matches the given values, or
null
if such a TC is not registered with this factory.default MOAccess createAccess(int moAccess)
MOAccess
.moAccess
- any bitwise OR combined constant from MOAccess
.default <R extends MOTableRow,M extends MOTableModel<R>> MOTable<R,MOColumn,M> createTable(org.snmp4j.smi.OID oid, MOTableIndex indexDef, MOColumn[] columns)
DefaultMOMutableTableModel
as table model.R
- the MOTableRow
type of the table to return.M
- the MOTableModel
type of the table to return.oid
- the OID of the table entry (thus table OID + ".1").indexDef
- the index defintion of the table.columns
- the columns for the new table as an array of MOColumn
instances.default <R extends MOTableRow,M extends MOTableModel<R>> MOTable<R,MOColumn,M> createTable(org.snmp4j.smi.OID oid, MOTableIndex indexDef, MOColumn[] columns, M model)
R
- the MOTableRow
type of the table to return.M
- the MOTableModel
type of the table to return.oid
- the OID of the table entry (thus table OID + ".1").indexDef
- the index defintion of the table.columns
- the columns for the new table as an array of MOColumn
instances.model
- the table model to use for the table.default MOTableIndex createIndex(MOTableSubIndex[] subIndexes, boolean impliedLength)
subIndexes
- an array of MOTableSubIndex
instances defining the sub-
index values of this index.impliedLength
- indicates whether the last variable length sub-index value has an
implied length or not (default is false).MOTableIndex
instance.default MOTableIndex createIndex(MOTableSubIndex[] subIndexes, boolean impliedLength, MOTableIndexValidator validator)
subIndexes
- an array of MOTableSubIndex
instances defining the sub-
index values of this index.impliedLength
- indicates whether the last variable length sub-index value has an
implied length or not (default is false).validator
- an index validator to check index values.MOTableIndex
instance.default MOTableSubIndex createSubIndex(org.snmp4j.smi.OID oid, int smiSyntax)
oid
- the object identifier of the OBJECT-TYPE that defines this sub-index
or null
if that information is not available. An non
null
is required for AgentX shared tables.smiSyntax
- the SMI syntax as defined by SMIConstants
.MOTableSubIndex
instance.default MOTableSubIndex createSubIndex(org.snmp4j.smi.OID oid, int smiSyntax, int minLength, int maxLength)
oid
- the object identifier of the OBJECT-TYPE that defines this sub-index
or null
if that information is not available. An non
null
is required for AgentX shared tables.smiSyntax
- the SMI syntax as defined by SMIConstants
.minLength
- the minimum length in sub-identifiers (without length sub-id) of the
sub-index.maxLength
- the maximum length in sub-identifiers (without length sub-id) of the
sub-index.MOTableSubIndex
instance.default <V extends org.snmp4j.smi.Variable> MOColumn<V> createColumn(int columnID, int syntax, MOAccess access)
V
- the Variable
type of the column to return.columnID
- the column ID of the column. The column ID is the last sub-identifier
of a column definition. It is NOT the index of the column.syntax
- the SMI syntax of the column as defined by SMIConstants
.access
- the maximum access supported by this column.MOColumn
instance.default <V extends org.snmp4j.smi.Variable> MOColumn<V> createColumn(int columnID, int syntax, MOAccess access, java.lang.String tcModuleName, java.lang.String textualConvention)
V
- the Variable
type of the column to return.columnID
- the column ID of the column. The column ID is the last sub-identifier
of a column definition. It is NOT the index of the column.syntax
- the (effective) SMI syntax of the column as defined by
SMIConstants
.access
- the maximum access supported by this column.tcModuleName
- the MIB module name that defines the textual conventions.textualConvention
- the object name of the textual convention on which this column is based.MOColumn
instance.default <V extends org.snmp4j.smi.Variable> MOColumn<V> createColumn(int columnID, int syntax, MOAccess access, V defaultValue, boolean mutableInService)
V
- the Variable
type of the column to return.columnID
- the column ID of the column. The column ID is the last sub-identifier
of a column definition. It is NOT the index of the column.syntax
- the (effective) SMI syntax of the column as defined by
SMIConstants
.access
- the maximum access supported by this column.defaultValue
- the default value defined by the DEFVAL clause for this column.mutableInService
- if true
this object may be changed while it is active
(inService), otherwise such an attempt will be rejected with a
inconsistentValue error.MOColumn
instance.default <V extends org.snmp4j.smi.Variable> MOColumn<V> createColumn(int columnID, int syntax, MOAccess access, V defaultValue, boolean mutableInService, java.lang.String tcModuleName, java.lang.String textualConvention)
V
- the Variable
type of the column to return.columnID
- the column ID of the column. The column ID is the last sub-identifier
of a column definition. It is NOT the index of the column.syntax
- the (effective) SMI syntax of the column as defined by
SMIConstants
.access
- the maximum access supported by this column.defaultValue
- the default value defined by the DEFVAL clause for this column.mutableInService
- if true
this object may be changed while it is active
(inService), otherwise such an attempt will be rejected with a
inconsistentValue error.tcModuleName
- the MIB module name that defines the textual conventions.textualConvention
- the object name of the textual convention on which this column is based.MOColumn
instance.default <R extends MOTableRow,M extends MOTableModel<? extends R>> M createTableModel(org.snmp4j.smi.OID tableOID, MOTableIndex indexDef, MOColumn[] columns)
DefaultMOMutableTableModel
).R
- the MOTableRow
type of the table model to return.M
- the MOTableModel
type of the table model to return.tableOID
- the table's OID for which this model is created.indexDef
- the index definition for the table.columns
- the columns defined for the table.MOTableModel
instance.default <V extends org.snmp4j.smi.Variable> MOScalar<V> createScalar(org.snmp4j.smi.OID id, MOAccess access, V value)
V
- the Variable
type of the scalar to return.id
- the OID of the scalar (including the .0 suffix).access
- the maximum access supported by this scalar.value
- the (initial) value of the scalar.MOScalar
instance.default <V extends org.snmp4j.smi.Variable> MOScalar<V> createScalar(org.snmp4j.smi.OID id, MOAccess access, V value, java.lang.String tcModuleName, java.lang.String textualConvention)
V
- the Variable
type of the scalar to return.id
- the OID of the scalar (including the .0 suffix).access
- the maximum access supported by this scalar.value
- the (initial) value of the scalar.tcModuleName
- the MIB module name that defines the textual conventions.textualConvention
- the object name of the textual convention on which this scalar is based.MOScalar
instance.default <BaseRow extends MOTableRow,DependentRow extends MOTableRow> MOTableRelation<BaseRow,DependentRow> createTableRelation(MOTable<BaseRow,? extends MOColumn,? extends MOTableModel<BaseRow>> baseTable, MOTable<DependentRow,? extends MOColumn,? extends MOTableModel<DependentRow>> dependentTable)
BaseRow
- the base row type of the table relation.DependentRow
- the dependent row type of the table relation.baseTable
- the base table.dependentTable
- the dependent or augmenting table.MOTableRelation
instance relating the supplied tables.default SysUpTime getSysUpTime(org.snmp4j.smi.OctetString context)
context
- the SNMPv3 context for which the up-time object should be returned. If the context is null, the up-time
of the default context is returned.SysUpTime
implementation.Copyright © 2018 SNMP4J.org. All rights reserved.