Package io.permazen.cli

Interface Session.TransactionalAction

All Superinterfaces:

Session.Action

All Known Subinterfaces:

AbstractKVCommand.KVAction, Session.RetryableTransactionalAction, Session.TransactionalActionWithOptions

All Known Implementing Classes:

AbstractTransactionRaftCommand.RaftTransactionAction

Enclosing class:

Session

public static interface Session.TransactionalAction
extends Session.Action

Extension of Session.Action that indicates the action requires an open transaction.

A new transaction will be created if necessary before this action is executed. If a transaction already exists, it will be (re)used.

Method Summary

Modifier and Type	Method	Description
default TransactionConfig	getTransactionConfig(Session session)	Get the configuration for the new Core API transaction.
default SessionMode	getTransactionMode(Session session)	Get the SessionMode corresponding to the transaction that should be opened.

Methods inherited from interface io.permazen.cli.Session.Action

run

Method Details

getTransactionMode

default SessionMode getTransactionMode(Session session)

Get the SessionMode corresponding to the transaction that should be opened.

This must be at or below the mode of the given session.

The implementation in Session.TransactionalAction returns session.Session.getMode()().

Parameters:

session - current session

Returns:

transaction mode

Throws:

IllegalArgumentException - if session is null

getTransactionConfig

default TransactionConfig getTransactionConfig(Session session)

Get the configuration for the new Core API transaction.

This method is only invoked when the getTransactionMode(io.permazen.cli.Session) returns SessionMode.CORE_API. Note if this Session.Action also implements Session.TransactionalActionWithOptions, then a non-null return value from Session.TransactionalActionWithOptions.getTransactionOptions() replaces the options configured in the TransactionConfig returned here, if any.

The implementation in Session.TransactionalAction returns session.Session.newTransactionConfig()().

Parameters:

session - current session

Returns:

Core API transaction config

Throws:

IllegalArgumentException - if session is null