Module org.snmp4j.agent
Package org.snmp4j.agent.mo

Class MOTableRowEvent<R extends MOTableRow>

java.lang.Object
java.util.EventObject
org.snmp4j.agent.mo.DeniableEventObject
org.snmp4j.agent.mo.MOTableRowEvent<R>
Type Parameters:
R - The MOTable row type of this event.
All Implemented Interfaces:
Serializable
public class MOTableRowEvent<R extends MOTableRow> extends DeniableEventObject
The MOTableRowEvent class describes the changes
Version:
3.3.0
Author:
Frank Fock
See Also:

  • Field Details

    • CHANGE

      public static final int CHANGE
      A single column of a row is changed.
      See Also:

    • CREATE

      public static final int CREATE
      A row is created.
      See Also:

    • ADD

      public static final int ADD
      A row is added.
      See Also:

    • DELETE

      public static final int DELETE
      A row is deleted.
      See Also:

    • UPDATED

      public static final int UPDATED
      This event type indicates that a complete row has been updated.
      See Also:

    • EXISTS

      public static final int EXISTS
      A row exists in the table at the moment when the corresponding MOTableRowListener has been added to the table. Processing this event type can be used to create dependent rows in augmenting or otherwise extending tables.
      Since:
      3.0
      See Also:

  • Constructor Details

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, int type)
      Creates a table row event based on table, row and type that cannot be canceled by the event listener.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      type - the event type.

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, int type, MOTableRowEvent.OriginType originType)
      Creates a table row event based on table, row and type that cannot be canceled by the event listener.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      type - the event type.
      originType - the origin type (MOTableRowEvent.OriginType.external or MOTableRowEvent.OriginType.internal) of this event.
      Since:
      3.3.0

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, int type, boolean deniable)
      Creates a table row event based on table, row and type that may be canceled by the event listener depending on the specified flag.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      type - the event type.
      deniable - indicates whether the event can be canceled through setting its denyReason member to a SNMP error status.
      Since:
      1.1

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, int type, MOTableRowEvent.OriginType originType, boolean deniable)
      Creates a table row event based on table, row and type that may be canceled by the event listener depending on the specified flag.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      type - the event type.
      originType - the origin type (MOTableRowEvent.OriginType.external or MOTableRowEvent.OriginType.internal) of this event.
      deniable - indicates whether the event can be canceled through setting its denyReason member to a SNMP error status.
      Since:
      3.3.0

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, MOTableRow preparedChanges, int type)
      Creates a table row event based on table, row, prepared changes, and type that cannot be canceled by the event listener.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      preparedChanges - a row instance containing the prepared changes for row.
      type - the event type.

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, MOTableRow preparedChanges, int type, boolean deniable, int numberOfConsecutiveEventsOfSameOrigin)
      Creates a table row event based on table, row, prepared changes, and type that cannot be canceled by the event listener. The originType is set to MOTableRowEvent.OriginType.internal because this event cannot be originated by external protocol operations.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      preparedChanges - a row instance containing the prepared changes for row.
      type - the event type.
      deniable - indicates whether the event can be canceled through setting its denyReason member to a SNMP error status.
      numberOfConsecutiveEventsOfSameOrigin - specifies the total number of events that will are triggered by the same origin at once, for example the number of rows in a table with event type EXISTS, when a listener is added to the table. The count is exclusive this event.
      Since:
      3.0

    • MOTableRowEvent

      public MOTableRowEvent(Object source, MOTable<R,? extends MOColumn,? extends MOTableModel<R>> table, R row, MOTableRow preparedChanges, int type, boolean deniable)
      Creates a table row event based on table, row, prepared changes, and type.
      Parameters:
      source - the event source.
      table - the table.
      row - the row associated with this event.
      preparedChanges - a row instance containing the prepared changes for row.
      type - the event type.
      deniable - indicates whether the event can be canceled through setting its denyReason member to a SNMP error status.
      Since:
      1.1

  • Method Details

    • getRow

      public R getRow()

    • getTable

      public MOTable<R,? extends MOColumn,? extends MOTableModel<R>> getTable()

    • getType

      public int getType()

    • getVetoStatus

      public int getVetoStatus()
      Returns the veto status that revokes the row operation or zero if the row operation is accepted by all listeners.
      Returns:
      a SNMP or sub-agent protocol error status or zero if the row operation is accepted.

    • getPreparedChanges

      public MOTableRow getPreparedChanges()

    • getVetoColumn

      public int getVetoColumn()

    • setVetoStatus

      public void setVetoStatus(int denyReason)
      Sets the veto status that revokes the row operation.
      Parameters:
      denyReason - a SNMP error status or a sub-agent protocol specific error status. In any case zero represents no error.

    • setVetoColumn

      public void setVetoColumn(int vetoColumn)
      Sets the column index on whose behalf the veto is issued.
      Parameters:
      vetoColumn - a column index.

    • getNumberOfConsecutiveEventsOfSameOrigin

      public int getNumberOfConsecutiveEventsOfSameOrigin()

    • isSendNextEventsOfSameOrigin

      public boolean isSendNextEventsOfSameOrigin()

    • setSendNextEventsOfSameOrigin

      public void setSendNextEventsOfSameOrigin(boolean sendNextEventsOfSameOrigin)

    • getOriginType

      public MOTableRowEvent.OriginType getOriginType()
      Gets the MOTableRowEvent.OriginType of this event.
      Returns:
      the origin type (MOTableRowEvent.OriginType.external or MOTableRowEvent.OriginType.internal) of this event.
      Since:
      3.3.0

    • toString

      public String toString()
      Overrides:
      toString in class EventObject