Module org.snmp4j.agent

Package org.snmp4j.agent.mo

Interface MOMutableRow2PC<SR extends SubRequest<?>>

All Superinterfaces:

MOMutableTableRow, MOTableRow

All Known Implementing Classes:

DefaultMOMutableRow2PC, NotificationLogMib.NlmConfigLogEntryRow, NotificationLogMib.NlmLogEntryRow, NotificationLogMib.NlmLogVariableEntryRow, NotificationLogMib.NlmStatsLogEntryRow, Snmp4jConfigMib.Snmp4jCfgStorageEntryRow, Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRow, Snmp4jLogMib.Snmp4jLogConsoleHandlerEntryRow, Snmp4jLogMib.Snmp4jLogFileHandlerEntryRow, Snmp4jLogMib.Snmp4jLogHandlerEntryRow, Snmp4jLogMib.Snmp4jLogLoggerEntryRow, Snmp4jLogMib.Snmp4jLogLoggerRow, Snmp4jLogMib.Snmp4jLogLoggerToHandlerEntryRow, Snmp4jProxyMib.Snmp4jProxyEntryRow, SnmpCommunityMIB.SnmpCommunityEntryRow, SnmpCommunityMIB.SnmpTargetAddrExtEntryRow, SnmpProxyMIB.SnmpProxyRow, SnmpTargetMIB.SnmpTargetAddrEntryRow, SnmpTlsTmMib.SnmpTlstmAddrEntryRow, SnmpTlsTmMib.SnmpTlstmCertToTSNEntryRow, SnmpTlsTmMib.SnmpTlstmParamsEntryRow, SnmpUsmDhObjectsMib.UsmDHKickstartEntryRow, SnmpUsmDhObjectsMib.UsmDHUserKeyEntryRow, UsmMIB.UsmTableRow

public interface MOMutableRow2PC<SR extends SubRequest<?>>
extends MOMutableTableRow

The MOMutableRow2PC interface adds support for 2-Phase-Commit to mutable table rows.

Version:

3.1.0

Author:

Frank Fock

Method Summary

Modifier and Type	Method	Description
void	cleanup(SR subRequest, int column)	Cleanups resources holds for changes to a single column.
void	cleanupRow(SR request, DefaultMOTable.ChangeSet changeSet)	Cleans up resources for a row.
void	commit(SR subRequest, MOTableRow changeSet, int column)	Commits changes to single column.
void	commitRow(SR subRequest, MOTableRow changeSet)	Commits a row as described by the supplied change set.
void	prepare(SR subRequest, MOTableRow changeSet, int column)	Prepares changing a single column.
void	prepareRow(SR subRequest, MOTableRow changeSet)	Prepares a row for changes described by the supplied change set.
void	undo(SR subRequest, int column)	Undos the changes to a single column.
void	undoRow(SR subRequest, DefaultMOTable.ChangeSet changeSet)	Undoes changes to a row.

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

setBaseRow, setValue

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

getBaseRow, getIndex, getValue, size

Method Detail

prepareRow

void prepareRow(SR subRequest,
                MOTableRow changeSet)

Prepares a row for changes described by the supplied change set. If the modification cannot be successfully prepared, the error status of the supplied subRequest should be set to the appropriate error status value.

This method is called only once per modified row.

Parameters:

subRequest - the sub-request that triggered the row change and that can be used to deny the commit phase by setting its error status.

changeSet - a MOTableRow instance that represents the state of the row if all changes have been applied successfully.

prepare

void prepare(SR subRequest,
             MOTableRow changeSet,
             int column)

Prepares changing a single column.

Parameters:

subRequest - the sub-request that corresponds to the column change. This object can be used to deny the commit phase by setting its error status.

changeSet - a MOTableRow instance that represents the state of the row if all changes have been applied successfully.

column - the column index of the column to be changed.

commit

void commit(SR subRequest,
            MOTableRow changeSet,
            int column)

Commits changes to single column.

Parameters:

subRequest - the sub-request that corresponds to the column change. This object can be used to deny the commit phase and triggering the undo phase by setting its error status.

changeSet - a MOTableRow instance that represents the state of the row if all changes have been applied successfully.

column - the column index of the column to be changed.

commitRow

void commitRow(SR subRequest,
               MOTableRow changeSet)

Commits a row as described by the supplied change set. If the modification cannot be successfully committed, the error status of the supplied subRequest should be set to commitFailed. Setting this error should be avoided under any circumstances.

This method is called only once per modified row.

Parameters:

subRequest - the sub-request that triggered the row change and that can be used to trigger the undo phase by setting its error status.

changeSet - a MOTableRow instance that represents the state of the row if all changes have been applied successfully.

cleanup

void cleanup(SR subRequest,
             int column)

Cleanups resources holds for changes to a single column.

Parameters:

subRequest - the sub-request that corresponds to the column change.

column - the column index of the changed column.

cleanupRow

void cleanupRow(SR request,
                DefaultMOTable.ChangeSet changeSet)

Cleans up resources for a row.

This method is called only once per modified row.

Parameters:

request - the sub-request that triggered the row change.

changeSet - a MOTableRow instance that represents the state of the row if all changes have been applied successfully.

undo

void undo(SR subRequest,
          int column)

Undos the changes to a single column.

Parameters:

subRequest - the sub-request that corresponds to the column change.

column - the column index of the changed column.

undoRow

void undoRow(SR subRequest,
             DefaultMOTable.ChangeSet changeSet)

Undoes changes to a row.

This method is called only once per modified row.

Parameters:

subRequest - the sub-request that triggered the row change.

changeSet - a MOTableRow instance that represents the state of the row if all changes have been applied successfully.