com.tailf.navu

Interface NavuCdbSubscriptionContext

All Known Subinterfaces:

NavuCdbSubscriptionConfigContext, NavuCdbSubscriptionOperContext, NavuCdbSubscriptionTwoPhaseContext

Deprecated.

@Deprecated
public interface NavuCdbSubscriptionContext

This interface specifies the interface for retrieving information for a CDB change entry on a change set.

The library implements this interface and supplies implementations to the iteration methods NavuCdbConfigDiffIterate.iterate(NavuCdbSubscriptionConfigContext), NavuCdbOperDiffIterate.iterate(NavuCdbSubscriptionOperContext) for configuration CDB changes and for CDB operational changes.

Each instance of this interface implementation is associated with a change set.

The getNode() returns the current NavuNode that could be used to navigate further in the data tree.

The subScriptionPoint() returns an integer that represents the point in the tree for which the notification occurred.

Sub interfaces specified specific methods for config and operational CDB data. NavuCdbConfigDiffIterate.iterate(NavuCdbSubscriptionConfigContext) for configuration data changes and NavuCdbOperDiffIterate.iterate(NavuCdbSubscriptionOperContext) for operational data changes.

Method Summary

Methods

Modifier and Type	Method and Description
ConfObject	getCLIStr() Deprecated.
ConfCLIToken[]	getCLITokens() Deprecated.
ConfObject	getNewValue() Deprecated. Retrieves the value of the affected node (if available).
NavuNode	getNode() Deprecated. Returns the NavuNode that represents the current node in the iteration.
CdbNotificationType	getNotifType() Deprecated. Return the current notification for this subscription change set.
DiffIterateOperFlag	getOperFlag() Deprecated. Returns a flag (or change flag) that indicates what change in the current iteration has been made on the current node getNode() for this change entry.
EnumSet<CdbSubscriptionFlagType>	getSubscriptionFlags() Deprecated. Return the current CdbSubscriptionFlagType flags for this subscription change set.
void	iterContinue() Deprecated. Ignores the children to the node (if any), and continues with the node's siblings.
void	iterRecurse() Deprecated. Continue with all children of the node (if any).
void	iterStop() Deprecated. Stop the iteration of the current change set.
ConfObject[]	keyPath() Deprecated. Returns the keypath that represents the current node in the iteration.
NavuContainer	root() Deprecated. Return the NavuContainer that represents the module for the current node.
Integer	subScriptionPoint() Deprecated. Returns the subscription point for this current notification (or change set).

Method Detail

getCLIStr

ConfObject getCLIStr()

Deprecated.

getCLITokens

ConfCLIToken[] getCLITokens()

Deprecated.

getNewValue

ConfObject getNewValue()

Deprecated.

Retrieves the value of the affected node (if available).

The new value is available only for leaf nodes.

Returns:

The value corresponding the keyPath() if the node represents a leaf node

getNode

NavuNode getNode()

Deprecated.

Returns the NavuNode that represents the current node in the iteration.

Convenient method for retrieving the NavuNode as the affected nodes representation.

Change flag which is retrieved though getOperFlag() is also available though NavuNode.getChangeFlag()

For a deleted node this method retrieves a NavuNode that has been deleted from PRE_COMMIT_RUNNING datastore.

Returns:

NavuNode that corresponds for the current iteration

getNotifType

CdbNotificationType getNotifType()

Deprecated.

Return the current notification for this subscription change set.

Returns:

notification associated with this current iteration

getOperFlag

DiffIterateOperFlag getOperFlag()

Deprecated.

Returns a flag (or change flag) that indicates what change in the current iteration has been made on the current node getNode() for this change entry.

Returns:

Operation flag associated with this current iteration

getSubscriptionFlags

EnumSet<CdbSubscriptionFlagType> getSubscriptionFlags()

Deprecated.

Return the current CdbSubscriptionFlagType flags for this subscription change set.

Returns:

EnumSet flags for this iteration

iterContinue

void iterContinue()

Deprecated.

Ignores the children to the node (if any), and continues with the node's siblings.

Before ending a iteration this method which ignores the children and continue with its sibling, should be called.

iterRecurse

void iterRecurse()

Deprecated.

Continue with all children of the node (if any).

Before ending a iteration this method which recurse the children should be called before ending a iteration.

iterStop

void iterStop()

Deprecated.

Stop the iteration of the current change set.

Before ending a iteration this method should be called before ending a iteration.

keyPath

ConfObject[] keyPath()

Deprecated.

Returns the keypath that represents the current node in the iteration.

To inspect which keypath is affected by current iteration regardless of the DiffIterateOperFlag this method retrieves a ConfObject array representation of a path.

The array returned contains either a ConfKey or ConfTag and it is reverted. Meaning that the root container is at the position array.length-1 and the affected node in the configuration (or CDB-oper stats) data tree is at position array[0].

A keypath representation is always returned regardless of the DiffIterateOperFlag.

A more convenient method is getNode() Which is returns the NavuNode as the affected node.

Returns:

Array of ConfObject as a keypath representation of a path

root

NavuContainer root()

Deprecated.

Return the NavuContainer that represents the module for the current node.

Returns:

NavuContainer that represents the module of the corresponding node in the iteration

subScriptionPoint

Integer subScriptionPoint()

Deprecated.

Returns the subscription point for this current notification (or change set).

Returns:

subscription point for the current change set