Package org.snmp4j.agent.agentx.subagent

Class DefaultAgentXSharedMOTable<R extends org.snmp4j.agent.mo.MOTableRow,C extends org.snmp4j.agent.mo.MOColumn,M extends org.snmp4j.agent.mo.MOTableModel<R>>

java.lang.Object
org.snmp4j.agent.mo.DefaultMOTable<R,C,M>
org.snmp4j.agent.agentx.subagent.DefaultAgentXSharedMOTable<R,C,M>
All Implemented Interfaces:
AgentXSharedMOTable<R,C,M>, AgentXSharedMutableMOTable<R,C,M>, org.snmp4j.agent.ManagedObject<org.snmp4j.agent.request.SubRequest<?>>, org.snmp4j.agent.ManagedObjectValueAccess<org.snmp4j.agent.request.SubRequest<?>>, org.snmp4j.agent.mo.ChangeableManagedObject<org.snmp4j.agent.request.SubRequest<?>>, org.snmp4j.agent.mo.GenericManagedObject, org.snmp4j.agent.mo.MOTable<R,C,M>, org.snmp4j.agent.MOScope, org.snmp4j.agent.RandomAccessManagedObject<org.snmp4j.agent.request.SubRequest<?>>, org.snmp4j.agent.RegisteredManagedObject<org.snmp4j.agent.request.SubRequest<?>>, org.snmp4j.agent.SerializableManagedObject<org.snmp4j.agent.request.SubRequest<?>>
public class DefaultAgentXSharedMOTable<R extends org.snmp4j.agent.mo.MOTableRow,C extends org.snmp4j.agent.mo.MOColumn,M extends org.snmp4j.agent.mo.MOTableModel<R>> extends org.snmp4j.agent.mo.DefaultMOTable<R,C,M> implements AgentXSharedMutableMOTable<R,C,M>
The DefaultAgentXSharedMOTable class is a default implementation for a shared table. It supports dynamic (while AgentX session is up) row creation and deletion.
Version:
2.1
Author:
Frank Fock

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.snmp4j.agent.mo.DefaultMOTable

    org.snmp4j.agent.mo.DefaultMOTable.ChangeSet

  • Field Summary

    Fields inherited from class org.snmp4j.agent.mo.DefaultMOTable

    moChangeListeners, model, moTableRowListeners, newRows, pendingChanges, rowModificationControlColumns

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultAgentXSharedMOTable(org.snmp4j.smi.OID oid, org.snmp4j.agent.mo.MOTableIndex indexDef, C[] columns)
    Creates a new shared table with the specified "Entry" OID, INDEX, columns, and a DefaultMOMutableTableModel as table model.
    DefaultAgentXSharedMOTable(org.snmp4j.smi.OID oid, org.snmp4j.agent.mo.MOTableIndex indexDef, C[] columns, M model)
    Creates a new shared table with the specified "Entry" OID, INDEX, columns, and a DefaultMOMutableTableModel as table model.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    changeRowIndex(org.snmp4j.smi.OID oldIndex, org.snmp4j.smi.OID newIndex)
    Change the row index of a row in this shared table and trigger index allocation updates indirectly by firing a new MOTableRowEvent.UPDATED event.
    AgentXSharedMOTableSupport<R,?>
    getAgentXSharedMOTableSupport()
    Returns the shared table support object this shared table uses.
    byte
    getOverrideIndexAllocationMode()
    Gets the index allocation mode that overrides the allocation mode inherited from the shared table support for index allocation operations for this shared table.
    byte
    getOverridePriority()
    Gets the index priority that overrides the priority inherited from the shared table support for index allocation operations for this shared table.
    void
    setAgentXSharedMOTableSupport(AgentXSharedMOTableSupport<R,?> sharedTableSupport)
    Sets the shared table support that this shared table should be use to (de)register rows and (de)allocate indexes while this shared table is part of an connected AgentX session.
    void
    setOverrideIndexAllocationMode(byte overrideIndexAllocationMode)
    Sets the index allocation mode that overrides the allocation mode inherited from the shared table support for index allocation operations for this shared table.
    void
    setOverridePriority(byte overridePriority)
    Sets the registration priority that overrides the priority inherited from the shared table support object (if not equal zero).

    Methods inherited from class org.snmp4j.agent.mo.DefaultMOTable

    addMOChangeListener, addMOTableRowListener, addNewRow, addPendingChanges, addRow, addRowInternal, cleanup, commit, covers, createRow, createRow, createRowInternal, exportInstance, find, findCell, fireAfterMOChange, fireAfterPrepareMOChange, fireBeforeMOChange, fireBeforePrepareMOChange, fireRowChanged, fireRowExistsEvent, get, getCellInfo, getCellOID, getChangesFromRequest, getColumn, getColumnCount, getColumnIndex, getColumns, getDefaultValues, getDependentTableRow, getID, getIndexDef, getIndexPart, getInstanceSubID, getLowerBound, getModel, getNewRows, getOID, getPendingChangeSet, getPersistentValues, getRowModificationControlColumns, getRowPreview, getScope, getUpperBound, getValue, getValue, getValue, getValue, hasNewRows, importInstance, instanceCount, instanceIterator, isChangeSetComplete, isConfigurable, isCovered, isLowerIncluded, isOverlapping, isUpperIncluded, isVolatile, isVolatile, load, loadRow, next, prepare, removeAll, removeAnyStorageType, removeAnyStorageType, removeMOChangeListener, removeMOTableRowListener, removeRow, restoreRawDataForHiddenColumns, save, setConfigurable, setModel, setValue, setVolatile, toString, undo, update, update

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.snmp4j.agent.mo.ChangeableManagedObject

    addMOChangeListener, removeMOChangeListener

    Methods inherited from interface org.snmp4j.agent.ManagedObject

    cleanup, commit, get, getScope, next, prepare, undo

    Methods inherited from interface org.snmp4j.agent.ManagedObjectValueAccess

    setValue

    Methods inherited from interface org.snmp4j.agent.mo.MOTable

    addMOTableRowListener, addNewRow, addRow, createRow, createRow, find, getCellInfo, getColumn, getColumnCount, getColumnIndex, getColumns, getDefaultValues, getIndexDef, getIndexPart, getModel, getOID, getValue, getValue, removeMOTableRowListener, removeRow

  • Constructor Details

    • DefaultAgentXSharedMOTable

      public DefaultAgentXSharedMOTable(org.snmp4j.smi.OID oid, org.snmp4j.agent.mo.MOTableIndex indexDef, C[] columns)
      Creates a new shared table with the specified "Entry" OID, INDEX, columns, and a DefaultMOMutableTableModel as table model.
      Parameters:
      oid - the OID of the SNMP table's Entry object. If the table is ifTable (1.3.6.1.2.1.2.2) then the OID to provide is 1.3.6.1.2.1.2.2.1 which is the ifEntry OID. By SMI rule, you can simply append ".1" to the table OID.
      indexDef - the index definition of the table based on the INDEX clause of the table MIB definition.
      columns - the column definitions which may also include non-accessible columns.

    • DefaultAgentXSharedMOTable

      public DefaultAgentXSharedMOTable(org.snmp4j.smi.OID oid, org.snmp4j.agent.mo.MOTableIndex indexDef, C[] columns, M model)
      Creates a new shared table with the specified "Entry" OID, INDEX, columns, and a DefaultMOMutableTableModel as table model.
      Parameters:
      oid - the OID of the SNMP table's Entry object. If the table is ifTable (1.3.6.1.2.1.2.2) then the OID to provide is 1.3.6.1.2.1.2.2.1 which is the ifEntry OID. By SMI rule, you can simply append ".1" to the table OID.
      indexDef - the index definition of the table based on the INDEX clause of the table MIB definition.
      columns - the column definitions which may also include non-accessible columns.
      model - the table model to be used by the shared table.

  • Method Details

    • getAgentXSharedMOTableSupport

      public AgentXSharedMOTableSupport<R,?> getAgentXSharedMOTableSupport()
      Description copied from interface: AgentXSharedMutableMOTable
      Returns the shared table support object this shared table uses.
      Specified by:
      getAgentXSharedMOTableSupport in interface AgentXSharedMutableMOTable<R extends org.snmp4j.agent.mo.MOTableRow,C extends org.snmp4j.agent.mo.MOColumn,M extends org.snmp4j.agent.mo.MOTableModel<R>>
      Returns:
      an AgentXSharedMOTableSupport instance or null if this table has not been initialized for AgentX yet.

    • setAgentXSharedMOTableSupport

      public void setAgentXSharedMOTableSupport(AgentXSharedMOTableSupport<R,?> sharedTableSupport)
      Description copied from interface: AgentXSharedMutableMOTable
      Sets the shared table support that this shared table should be use to (de)register rows and (de)allocate indexes while this shared table is part of an connected AgentX session. The shared table determines whether the AgentX session is established by inspecting the AgentXSession instance returned by this shared tabe support. If either the shared table support instance is null or AgentXSession.isClosed() returns true the AgentX session is considered to be disconnected (not established).
      Specified by:
      setAgentXSharedMOTableSupport in interface AgentXSharedMutableMOTable<R extends org.snmp4j.agent.mo.MOTableRow,C extends org.snmp4j.agent.mo.MOColumn,M extends org.snmp4j.agent.mo.MOTableModel<R>>
      Parameters:
      sharedTableSupport - an AgentXSharedMOTableSupport instance to be used to (de)allocate indexes and (de)register rows at the AgentX master agent.

    • getOverrideIndexAllocationMode

      public byte getOverrideIndexAllocationMode()
      Gets the index allocation mode that overrides the allocation mode inherited from the shared table support for index allocation operations for this shared table.
      Returns:
      0 if there is no overriding and the overridden mode otherwise.

    • getOverridePriority

      public byte getOverridePriority()
      Gets the index priority that overrides the priority inherited from the shared table support for index allocation operations for this shared table.
      Returns:
      0 if there is no overriding and the overridden priority otherwise.

    • setOverrideIndexAllocationMode

      public void setOverrideIndexAllocationMode(byte overrideIndexAllocationMode)
      Sets the index allocation mode that overrides the allocation mode inherited from the shared table support for index allocation operations for this shared table.
      Parameters:
      overrideIndexAllocationMode - an index allocation mode as defined by AgentXSharedMOTableSupport or zero to use the default priority.

    • setOverridePriority

      public void setOverridePriority(byte overridePriority)
      Sets the registration priority that overrides the priority inherited from the shared table support object (if not equal zero).
      Parameters:
      overridePriority - a value between 1 and 255 (-1 respectively - its a byte) or zero which indicates that the default priority should be used.

    • changeRowIndex

      public boolean changeRowIndex(org.snmp4j.smi.OID oldIndex, org.snmp4j.smi.OID newIndex)
      Change the row index of a row in this shared table and trigger index allocation updates indirectly by firing a new MOTableRowEvent.UPDATED event.
      Specified by:
      changeRowIndex in interface AgentXSharedMutableMOTable<R extends org.snmp4j.agent.mo.MOTableRow,C extends org.snmp4j.agent.mo.MOColumn,M extends org.snmp4j.agent.mo.MOTableModel<R>>
      Parameters:
      oldIndex - the old index of the row to change.
      newIndex - the new index of the row.
      Returns:
      true if the row index has been changed, false otherwise.