Package | Description |
---|---|
com.tailf.dp |
Data provider API package, for implementation of callbacks for validations, actions, transformation etc.
|
com.tailf.dp.annotations |
Annotations and proxy helper classes for callbacks.
|
com.tailf.dp.services |
Service callback specific context and utilities.
|
com.tailf.navu |
NAVU (Navigation Utilities) is an API which provides increased
accessibility to the ConfD/NCS populated data model tree:
NAVU-Tree.
|
com.tailf.navu.traversal |
Utility package for traversing the NAVU tree (or a subset thereof)
using the NAVU API.
|
com.tailf.ncs |
NCS Java machine management and control of Services, Neds,
callbacks and Applications
|
com.tailf.ncs.template |
Modifier and Type | Method and Description |
---|---|
Properties |
DpNanoServiceCallback.create(NanoServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque,
Properties componentProperties)
Nano Create callback method.
|
Properties |
DpServiceCallback.create(ServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque)
Create callback method.
|
Properties |
DpNanoServiceCallback.delete(NanoServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque,
Properties componentProperties)
Nano Delete callback method.
|
Properties |
DpServiceCallback.preLockCreate(ServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque)
Deprecated.
use
DpServiceCallback.create(ServiceContext context,
NavuNode service, NavuNode root, Properties opaque)
This method is called when a service instance committed due to a create
or update event in the same way as the create() callback. The difference
being that this method is called outside of the transaction lock of the
current transaction making it parallel to other pre_lock_create() service
calls.
Care must be taken by the programmer so that the preLockCreate() is
designed in a thread safe manner.
This method returns a opaque as a Properties object that can be null.
If not null it is stored persistently by Ncs.
This object is then delivered as argument to new calls of the create
method for this service (fastmap algorithm).
This way the user can store and later modify persistent data outside
the service model that might be needed. |
Modifier and Type | Method and Description |
---|---|
Properties |
NanoServiceCallbackProxy.create(NanoServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque,
Properties componentProperties) |
Properties |
ServiceCallbackProxy.create(ServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque) |
Properties |
NanoServiceCallbackProxy.delete(NanoServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque,
Properties componentProperties) |
Properties |
ServiceCallbackProxy.delete(ServiceContext context,
NavuNode root,
Properties opaque) |
Properties |
ServiceCallbackProxy.preLockCreate(ServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque) |
Properties |
ServiceCallbackProxy.update(ServiceContext context,
NavuNode service,
NavuNode root,
Properties opaque) |
Modifier and Type | Method and Description |
---|---|
NavuNode |
ServiceContext.getRootNode()
Returns the path root as a NavuNode with the
NavuContext attached to the ongoing Maapi transaction.
|
NavuNode |
ServiceContext.getServiceNode()
Returns the current service path as a NavuNode with the
NavuContext attached to the ongoing Maapi transaction.
|
NavuNode |
NanoServiceContext.getStateNode() |
Modifier and Type | Method and Description |
---|---|
static void |
ServiceLog.debug(NavuNode service,
String msg,
ConfIdentityRef type)
Write service log entry with level debug.
|
static void |
ServiceLog.error(NavuNode service,
String msg,
ConfIdentityRef type)
Write service log entry with level error.
|
static void |
ServiceLog.info(NavuNode service,
String msg,
ConfIdentityRef type)
Write service log entry with level info.
|
static void |
ServiceLog.trace(NavuNode service,
String msg,
ConfIdentityRef type)
Write service log entry with level trace.
|
static void |
ServiceLog.warn(NavuNode service,
String msg,
ConfIdentityRef type)
Write service log entry with level warn.
|
Modifier and Type | Class and Description |
---|---|
class |
NavuAction
This class represents a action modeled in the data model.
|
class |
NavuContainer
NavuContainer is a representation of the yang
construct container,module and list-entry. |
class |
NavuLeaf
The
NavuLeaf class corresponds to the
YANG leaf and leaf-list node types. |
class |
NavuLeafList
NavuLeafList is a representation of the YANG leaf-list. |
class |
NavuList
NavuList is a representation of the YANG list node. |
class |
NavuListEntry
A
NavuList holds this representation of a entry as its
children or entry set. |
Modifier and Type | Method and Description |
---|---|
NavuNode |
NavuChange.get(int index)
Returns a node at a certain position.
|
NavuNode |
NavuContainer.get(String nodeName)
Returns a subordinate node with the name
nodeName . |
NavuNode |
NavuAction.getNavuNode(ConfPath path) |
NavuNode |
NavuNode.getNavuNode(ConfPath path)
Retrieve a NavuNode based on the given absolute or relative
path.
|
NavuNode |
NavuXPathContext.getNode()
Get current NavuNode
|
static NavuNode |
KeyPath2NavuNode.getNode(ConfObject[] kp,
NavuContext ctx) |
static NavuNode |
KeyPath2NavuNode.getNode(ConfPath path,
NavuContext ctx) |
NavuNode |
NavuAction.getParent() |
NavuNode |
NavuLeaf.getParent() |
NavuNode |
NavuList.getParent() |
NavuNode |
NavuNode.getParent()
Returns the parent of the node.
|
NavuNode |
NavuAction.setChange(List<ConfObject> kp,
DiffIterateOperFlag op,
ConfValue oldValue,
NavuContext delContext)
Sets the change type on a node.
|
NavuNode |
NavuContainer.setChange(List<ConfObject> path,
DiffIterateOperFlag op,
ConfValue oldValue,
NavuContext delContext) |
NavuNode |
NavuLeaf.setChange(List<ConfObject> kp,
DiffIterateOperFlag op,
ConfValue oldValue,
NavuContext delContext) |
NavuNode |
NavuList.setChange(List<ConfObject> path,
DiffIterateOperFlag op,
ConfValue oldValue,
NavuContext delContext) |
Modifier and Type | Method and Description |
---|---|
Collection<NavuNode> |
IllegalParentNavuNodeException.children() |
Collection<NavuNode> |
NavuAction.children()
Return the children of this node.
|
Collection<NavuNode> |
NavuContainer.children()
Returns a collection containing the children of this container.
|
Collection<NavuNode> |
NavuList.children()
Returns all elements contained by the list node.
|
Collection<NavuNode> |
NavuNode.children()
Returns a collection containing the children of this node.
|
Collection<NavuNode> |
NoSuchNavuNodeException.children() |
List<NavuNode> |
NavuLeaf.deref()
Derefs a leafref and returns the referenced objects
|
Set<Map.Entry<String,NavuNode>> |
NavuContainer.entrySet()
Returns a set of value-pairs.
|
List<NavuNode> |
NavuAction.getChanges() |
List<NavuNode> |
NavuNode.getChanges()
Deprecated.
|
List<NavuNode> |
NavuAction.getChanges(boolean emitSubtree) |
List<NavuNode> |
NavuNode.getChanges(boolean emitSubTree)
Deprecated.
|
List<NavuNode> |
NavuAction.getChanges(boolean emitSubtree,
DiffIterateOperFlag... forOps) |
List<NavuNode> |
NavuNode.getChanges(boolean emitSubTree,
DiffIterateOperFlag... forOps)
Deprecated.
|
List<NavuNode> |
NavuAction.getChanges(NavuContext delcontext) |
List<NavuNode> |
NavuNode.getChanges(NavuContext delContext)
Return the descendant
NavuNode 's
(including this element) that has been affected by
changes to the MAAPI transaction. |
List<NavuNode> |
NavuAction.getChanges(NavuContext delcontext,
boolean emitSubtree) |
List<NavuNode> |
NavuNode.getChanges(NavuContext delContext,
boolean emitSubTree)
Return the descendant
NavuNode including this
NavuNode that has been affected by the
current MAAPI transaction. |
List<NavuNode> |
NavuAction.getChanges(NavuContext delContext,
boolean emitSubtree,
DiffIterateOperFlag... forOps) |
List<NavuNode> |
NavuNode.getChanges(NavuContext delContext,
boolean emitSubTree,
DiffIterateOperFlag... forOps)
Return the descendant
NavuNode including this
NavuNode that has been affected by the
current MAAPI transaction. |
List<NavuNode> |
NavuContainer.getSelectCaseAsNavuNode(String choice)
Returns a collection of the top-level node elements of
the currently selected case of the specified
choice . |
Iterator<NavuNode> |
NavuChange.iterator() |
Collection<NavuNode> |
NavuAction.select(ConfObject[] query) |
Collection<NavuNode> |
NavuContainer.select(ConfObject[] kp) |
Collection<NavuNode> |
NavuLeaf.select(ConfObject[] query) |
Collection<NavuNode> |
NavuList.select(ConfObject[] kp) |
abstract Collection<NavuNode> |
NavuNode.select(ConfObject[] query) |
Collection<NavuNode> |
NavuAction.select(List<String> query)
Not supported returns only an empty Collection
|
Collection<NavuNode> |
NavuContainer.select(List<String> path) |
Collection<NavuNode> |
NavuLeaf.select(List<String> path) |
Collection<NavuNode> |
NavuList.select(List<String> path) |
abstract Collection<NavuNode> |
NavuNode.select(List<String> query) |
Collection<NavuNode> |
NavuAction.select(String query)
Not supported returns only an empty Collection
|
Collection<NavuNode> |
NavuContainer.select(String path) |
Collection<NavuNode> |
NavuLeaf.select(String path) |
Collection<NavuNode> |
NavuList.select(String path) |
abstract Collection<NavuNode> |
NavuNode.select(String query) |
List<NavuNode> |
NavuChange.subList(int startIndex,
int stopindex) |
List<NavuNode> |
NavuAction.xPathSelect(String xPath) |
List<NavuNode> |
NavuNode.xPathSelect(String query)
Evaluates the XPath path expression
query and returns
the resulting node set as list of NavuNode 's. |
Modifier and Type | Method and Description |
---|---|
boolean |
NavuChange.add(NavuNode e)
Adds a node.
|
boolean |
NavuChange.contains(NavuNode node)
Checks if a node is already contained by the change.
|
boolean |
NavuContainer.containsNode(NavuNode node)
Checks if the given node is a direct child of this container according
to the schema.
|
static NoSuchNavuNodeException |
NoSuchNavuNodeException.mk(NavuNode node,
String errKey) |
static NoSuchNavuNodeException |
NoSuchNavuNodeException.mk(NavuNode node,
String errKey,
EnumSet<com.tailf.navu.Verbosity> verbosity) |
static NoSuchNavuNodeException |
NoSuchNavuNodeException.mk(NavuNode node,
String childType,
String errKey) |
static NoSuchNavuNodeException |
NoSuchNavuNodeException.mk(NavuNode node,
String childType,
String errKey,
EnumSet<com.tailf.navu.Verbosity> verbosity) |
void |
PreparedXMLStatement.set(NavuNode node)
Deprecated.
|
void |
PreparedXMLStatement.setValues(NavuNode node)
Similar to
PreparedXMLStatement.setValues(NavuContext) but uses the context of
the supplied node. |
void |
PreparedXMLStatement.sharedSetValues(NavuNode node)
Variant of
PreparedXMLStatement.setValues(NavuNode) with FastMap support. |
void |
NavuAction.valueUpdateInd(NavuNode child) |
void |
NavuContainer.valueUpdateInd(NavuNode child)
An indication received from a child node.
|
void |
NavuLeaf.valueUpdateInd(NavuNode child) |
void |
NavuList.valueUpdateInd(NavuNode child) |
Constructor and Description |
---|
NavuCursor(CdbSession cdbSession,
NavuNode node,
String fmt,
Object... arguments)
Constructor to be used when in CDB mode.
|
PreparedXMLStatement(ConfXMLParam[] params,
Map<Integer,Object[]> paramInfoMap,
NavuNode node) |
Modifier and Type | Method and Description |
---|---|
static Iterator<NavuNode> |
NavuTreeTraversal.iterator(NavuContext ctx)
Retrieve an iterator to traverse the entire NAVU tree.
|
static Iterator<NavuNode> |
NavuTreeTraversal.iterator(NavuNode startNode)
Retrieve an iterator to traverse part of a NAVU tree.
|
Modifier and Type | Method and Description |
---|---|
void |
TraversalFilter.currentNode(NavuNode node) |
static Iterator<NavuNode> |
NavuTreeTraversal.iterator(NavuNode startNode)
Retrieve an iterator to traverse part of a NAVU tree.
|
void |
NavuTreeTraversal.printChain(NavuNode node) |
Set<String> |
NavuTraversalBfsMean.traverse(NavuNode root,
List<TraversalFilter> filters) |
Set<String> |
NavuTraversalDfsMean.traverse(NavuNode root,
List<TraversalFilter> filters) |
Set<String> |
NavuTraversalMean.traverse(NavuNode root,
List<TraversalFilter> filter) |
Constructor and Description |
---|
PlanComponent(NavuNode service,
String name,
String componentType)
Creation of a plan component.
|
PlanComponent(NavuNode service,
String name,
String componentType,
ConfObjectRef serviceReference) |
Modifier and Type | Method and Description |
---|---|
void |
Template.apply(NavuNode root,
TemplateVariables variables)
Apply a template in the specified context
|