com.tailf.dp.proto

Enum TransCBType

Object

Enum<TransCBType>

com.tailf.dp.proto.TransCBType

All Implemented Interfaces:

Serializable, Comparable<TransCBType>

public enum TransCBType
extends Enum<TransCBType>

Enumeration of Trans callback methods

This enumeration defines the different callbacks that can be registered for a transaction. There may be multiple sources of data for the device configuration. In order to orchestrate transactions with multiple sources of data, that participate in a transaction. Each northbound NETCONF operation will be an individual transaction. These transactions are typically very short lived. Transactions originating from the CLI or the Web UI have longer life. The transaction can be viewed as a conceptual state machine where the different phases of the transaction are different states and the invocations of the callback functions are state transitions. The following ASCII art depicts the state machine.

                          +-------+
                           | START |
                           +-------+
                               | init()
                               |
                               v
                  read()   +------+          finish()
                  ------>  | READ | --------------------> START
                           +------+
                             ^  |
              trans_unlock() |  | trans_lock()
                             |  v
                  read()  +----------+       finish()
                  ------> | VALIDATE | -----------------> START
                          +----------+
                               | write_start()
                               |
                               v
                  write()  +-------+          finish()
                  -------> | WRITE | -------------------> START
                           +-------+
                               | prepare()
                               |
                               v
                          +----------+   commit()   +-----------+
                          | PREPARED | -----------> | COMMITTED |
                          +----------+              +-----------+
                               | abort()                  |
                               |                          | finish()
                               v                          |
                           +---------+                    v
                           | ABORTED |                  START
                           +---------+
                               | finish()
                               |
                               v
                             START
 

kind of storages.

Conf.DB_CANDIDATE If the system has been configured so that the external database owns the candidate data share, we will have to execute candidate transactions here. Usually the system owns the candidate and in that case the external database will never see any DB_CANDIDATE transactions.

Conf.DB_RUNNING This is a transaction towards the actual running configuration of the device. All write operations in a DB_RUNNING transaction must be propagated to the individual subsystems that use this configuration data.

Conf.DB_STARTUP If the system has ben configured to support the NETCONF startup capability, this is a transaction towards the startup database.

Which type we have is indicated through the dbName field in the DpTrans object. A transaction, regardless of whether it originates from the NETCONF agent, the CLI or the Web UI, has several distinct phases:

Since:

3.2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Bit flag for the DpTransCallback.abort(DpTrans) method.
COMMIT Bit flag for the DpTransCallback.commit(DpTrans) method.
FINISH Bit flag for the DpTransCallback.finish(DpTrans) method.
INIT Bit flag for the DpTransCallback.init(DpTrans) method.
PREPARE Bit flag for the DpTransCallback.prepare(DpTrans) method.
TRANS_LOCK Bit flag for the DpTransCallback.transLock(DpTrans) method.
TRANS_UNLOCK Bit flag for the DpTransCallback.transUnlock(DpTrans) method.
WRITE_START Bit flag for the DpTransCallback.writeStart(DpTrans) method.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue() get integer value for enum
static TransCBType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransCBType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABORT

public static final TransCBType ABORT

Bit flag for the DpTransCallback.abort(DpTrans) method.

COMMIT

public static final TransCBType COMMIT

Bit flag for the DpTransCallback.commit(DpTrans) method.

FINISH

public static final TransCBType FINISH

Bit flag for the DpTransCallback.finish(DpTrans) method.

INIT

public static final TransCBType INIT

Bit flag for the DpTransCallback.init(DpTrans) method.

PREPARE

public static final TransCBType PREPARE

Bit flag for the DpTransCallback.prepare(DpTrans) method.

TRANS_LOCK

public static final TransCBType TRANS_LOCK

Bit flag for the DpTransCallback.transLock(DpTrans) method.

TRANS_UNLOCK

public static final TransCBType TRANS_UNLOCK

Bit flag for the DpTransCallback.transUnlock(DpTrans) method.

WRITE_START

public static final TransCBType WRITE_START

Bit flag for the DpTransCallback.writeStart(DpTrans) method.

Method Detail

getValue

public int getValue()

get integer value for enum

Returns:

int value

valueOf

public static TransCBType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static TransCBType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransCBType c : TransCBType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared