Uses of Class
com.tailf.navu.NavuException
Package
Description
NAVU (Navigation Utilities) is an API which provides increased
accessibility to the ConfD/NCS populated data model tree:
NAVU-Tree.
Utility package for traversing the NAVU tree (or a subset thereof)
using the NAVU API.
NCS Java machine management and control of Services, Neds,
callbacks and Applications
The Alarm Manager consumer package provides support for subscription to
alarms in the NCS Alarm list.
The Alarm Manager producer package provides support for injection of
alarms into the NCS Alarm list.
-
Uses of NavuException in com.tailf.navu
Modifier and TypeClassDescriptionclass
class
class
class
Modifier and TypeMethodDescriptionReturns a reference to a subordinateaction
with the hash valuekey
.Returns a reference to a subordinateaction
with the namekey
.void
NavuContext.applyClearTrans()
This method applies any changes in this transaction (Commit) usingMaapi.applyTrans(int, boolean)
.void
NavuContext.applyReplaceTrans()
This method applies (commit) and finish the transaction usingMaapi.applyTrans(int, boolean)
andMaapi.finishTrans(int)
.void
NavuContext.attachRunningTrans
(int th) Attach an existing transaction towards theConf.DB_RUNNING
database to be used in the context.NavuAction.call()
Issues an action with empty parametersNavuAction.call
(ConfXMLParam[] params) Issues an action call with given parametersIssues an action call with given parameterIllegalParentNavuNodeException.children()
NavuAction.children()
Return the children of this node.NavuContainer.children()
Returns a collection containing the children of this container.NavuList.children()
Returns all elements contained by the list node.NavuNode.children()
Returns a collection containing the children of this node.NoSuchNavuNodeException.children()
Returns a reference to a subordinatechoice
with the namename
.int
NavuContext.clearTrans()
Clears the internal transaction defined byNavuContext.startRunningTrans(int)
orNavuContext.startOperationalTrans(int)
The previous transaction id if any is returned but left unattended.NavuContainer.container
(ConfNamespace ns, String containerName) Returns a reference to a subordinatecontainer
with the namecontainerName
, belonging to the namespacens
.Returns a reference to a subordinatecontainer
with the hash valuekey
.Returns a reference to a subordinatecontainer
with the namekey
.Deprecated.NavuNode.container
(ConfNamespace ns, String containerName) Returns a reference to a subordinatecontainer
with the namecontainerName
, belonging to the namespacens
.Returns a reference to a subordinatecontainer
with the hash valuekey
.Returns a reference to a subordinatecontainer
with the namekey
.Deprecated.boolean
NavuContainer.containsNode
(NavuNode node) Checks if the given node is a direct child of this container according to the schema.boolean
NavuContainer.containsNode
(String nodeName) Checks if there is a child node in the schema with given name.boolean
NavuLeafList.containsNode
(ConfValue elem) Returns true if and only if thisNavuLeafList
contains this element.boolean
NavuLeafList.containsNode
(String elemStr) Returns true if and only if thisNavuLeafList
contains this element.boolean
NavuList.containsNode
(ConfKey key) Returns true if and only if thisNavuList
contains aNavuListEntry
whereNavuListEntry.getKey()
equals
the specifiedkey
.boolean
NavuList.containsNode
(String keyStr) Returnstrue
if thisNavuList
contains a mapping for the specified string representation of a key.boolean
NavuList.containsNode
(String[] keyArr) Returnstrue
if thisNavuList
contains a mapping for the specified string representation of a key.NavuContainer.create()
Creates an optional container.void
NavuLeaf.create()
Create an empty leaf node.void
Creates leaf-list entry.void
Creates leaf-list entry.Create and return a new list element in thisNavuList
.NavuList.create
(ConfObject key) Convenience variant ofNavuList.create(ConfKey)
accepting aConfObject
as the (single element) key.Convenience variant ofNavuList.create(ConfKey)
accepting a string as the (single element) key.Convenience variant ofNavuList.create(ConfKey)
accepting a string array as the key.NavuContainer.delete()
Deletes an optional container.NavuLeaf.delete()
Deletes a leaf.void
Deletes an entry from the leaf-list.void
Deletes an entry from the leaf-list.void
Deletes an element from the list.void
Deletes an element from the list.void
Deletes an element from the list.NavuListEntry.delete()
Deletes this entry from the NavuList it contains returns this NavuListEntry as NavuContainer.void
NavuList.deleteAll()
Deletes all element from the list.NavuLeaf.deref()
Derefs a leafref and returns the referenced objectsvoid
NavuContext.detachRunningTrans()
For an context with an attached transaction usingNavuContext.attachRunningTrans(int)
this method will detach the transaction from the NavuContext maapi instanceReturns a list element according to the given key.Returns a list element according to the given key.Returns a list element according to the given array of keys.NavuLeafList.elements()
Returns a copy of elements contained by the leaf-list node.NavuList.elements()
Returns a shallow copy of all elements contained by the list node.NavuAction.encodeValues()
NavuContainer.encodeValues()
NavuLeaf.encodeValues()
NavuList.encodeValues()
abstract List<ConfXMLParam>
NavuNode.encodeValues()
Encodes the sub-tree including the currentNavuNode
as the topmostNavuNode
as aConfXMLParam
array.NavuAction.encodeXML()
NavuContainer.encodeXML()
NavuLeaf.encodeXML()
NavuList.encodeXML()
abstract List<ConfXMLParam>
NavuNode.encodeXML()
Encodes the sub-tree including the currentNavuNode
as the topmostNavuNode
as aConfXMLParam
array.NavuContainer.entrySet()
Returns a set of value-pairs.NavuList.entrySet()
Returns a set of entries with element key and element.boolean
NavuAction.exists()
boolean
NavuContainer.exists()
Verifies the existence of container.boolean
NavuLeaf.exists()
Tests for the existence of the leaf node.boolean
NavuList.exists()
Tests for the existence of the List node in the instance tree.abstract boolean
NavuNode.exists()
Generic exists test for Navu navigational elementsNavuContainer.findChanges
(NavuContext delContext, Integer[] criteria) Analyzes what changes has been done within this transaction.NavuContainer.findChanges
(Integer[] criteria) Deprecated.void
NavuContext.finishClearTrans()
Finishes current trans usingMaapi.finishTrans(int)
and clears the trans from this NavuContext.Returns a subordinate node with the namenodeName
.NavuAction.getChanges()
NavuAction.getChanges
(boolean emitSubtree) NavuAction.getChanges
(boolean emitSubtree, DiffIterateOperFlag... forOps) NavuAction.getChanges
(NavuContext delcontext) NavuAction.getChanges
(NavuContext delcontext, boolean emitSubtree) NavuAction.getChanges
(NavuContext delContext, boolean emitSubtree, DiffIterateOperFlag... forOps) NavuNode.getChanges()
Deprecated.NavuNode.getChanges
(boolean emitSubTree) Deprecated.NavuNode.getChanges
(boolean emitSubTree, DiffIterateOperFlag... forOps) Deprecated.NavuNode.getChanges
(NavuContext delContext) Return the descendantNavuNode
's (including this element) that has been affected by changes to theMAAPI
transaction.NavuNode.getChanges
(NavuContext delContext, boolean emitSubTree) Return the descendantNavuNode
including thisNavuNode
that has been affected by the current MAAPI transaction.NavuNode.getChanges
(NavuContext delContext, boolean emitSubTree, DiffIterateOperFlag... forOps) Return the descendantNavuNode
including thisNavuNode
that has been affected by the current MAAPI transaction.NavuAction.getNavuNode
(ConfPath path) NavuNode.getNavuNode
(ConfPath path) Retrieve a NavuNode based on the given absolute or relativepath
.NavuContainer.getSelectCaseAsNavuChoice
(String choice) Returns a collection of the "toplevel" choice elements of the a current selected case.NavuContainer.getSelectCaseAsNavuNode
(String choice) Returns a collection of the top-level node elements of the currently selected case of the specifiedchoice
.NavuContainer.getSelectedCase
(String choice) Returns the selected cases of a given choice.int
NavuContainer.getUserSession()
Get the current Maapi user session if this container context uses Maapi.NavuAction.getValues
(ConfXMLParam[] param) Invokes or call an action defined in the data model (seetailf_yang_extensions(5)
).Invokes or call an action defined in the data model (seetailf_yang_extensions(5)
).NavuNode.getValues
(ConfXMLParam[] params) Read an arbitrary set of sub-elements from thisNavuNode
.Read an arbitrary set of sub-elements of a container or list entry.Deprecated.boolean
NavuLeaf.idrefDerivedOrSelf
(ConfIdentityRef base) Inserts an element into a list using Maapi.insert().boolean
NavuContainer.isEmpty()
Checks if the container has any members.boolean
NavuLeafList.isEmpty()
Checks if there are any elements in the leaf-list.boolean
NavuList.isEmpty()
Checks if there are any elements in the list.NavuContainer.keySet()
Returns a set of nodeNames.NavuList.keySet()
Returns a Set containing all of the keys for this list.NavuContainer.leaf
(ConfNamespace ns, String leafName) Returns a reference to a subordinateleaf
with the nameleafName
, belonging to the namespacens
.Returns a reference to a subordinateleaf
with the hash valuekey
.Returns a reference to a subordinateleaf
with the namekey
.Deprecated.NavuNode.leaf
(ConfNamespace ns, String leafName) Returns a reference to a subordinateleaf
with the nameleafName
, belonging to the namespacens
.Returns a reference to a subordinateleaf
with the hash valuekey
.Returns a reference to a subordinateleaf
with the namekey
.Deprecated.NavuContainer.leafList
(ConfNamespace ns, String leafListName) Returns a reference to a subordinateleaf-list
with the nameleafListName
, belonging to the namespacens
.Returns a reference to a subordinateleaf-list
with the hash valuekey
.Returns a reference to a subordinateleaf-list
with the namekey
.Deprecated.NavuNode.leafList
(ConfNamespace ns, String leafListName) Returns a reference to a subordinateleaf-list
with the nameleafListName
, belonging to the namespacens
.Returns a reference to a subordinateleaf-list
with the hash valuekey
.Returns a reference to a subordinateleaf-list
with the namekey
.Deprecated.NavuContainer.list
(ConfNamespace ns, String listName) Returns a reference to a subordinatelist
with the namelistName
, belonging to the namespacens
.Returns a reference to a subordinatelist
with the hash valuekey
.Returns a reference to a subordinatelist
with the namekey
.Deprecated.NavuNode.list
(ConfNamespace ns, String listName) Returns a reference to a subordinatelist
with the namelistName
, belonging to the namespacens
.Returns a reference to a subordinatelist
with the hash valuekey
.Returns a reference to a subordinatelist
with the namekey
.Deprecated.void
NavuLeafList.move
(ConfValue elem, NavuLeafList.WhereTo whereTo, ConfValue to) Move a leaf-list element to a new position.void
NavuLeafList.move
(String elemStr, NavuLeafList.WhereTo whereTo, String toStr) Move a leaf-list element to a new position.void
NavuList.move
(ConfKey key, NavuList.WhereTo whereTo, ConfKey to) Move a list element to a new position in the list.void
NavuList.move
(String keyStr, NavuList.WhereTo whereTo, String toStr) Move a list element to a new position in the list.NavuParser.parse()
Parses the xml and produces ConfXMLParam[]NavuNode.prepareXMLCall
(String xml) Creates a parameterized configuration xml in the style of aNavuNode.setValues(String)
argument.NavuContainer.safeCreate()
Creates an optional container.void
NavuLeaf.safeCreate()
Create an empty leaf node, silently succeeding if the leaf already existsvoid
NavuLeafList.safeCreate
(ConfValue elem) The variant ofcreate
that succeeds even if the object already exists.void
NavuLeafList.safeCreate
(String elemStr) The variant ofcreate
that succeeds even if the object already exists.NavuList.safeCreate
(ConfKey key) Variant ofNavuList.create(ConfKey)
that succeeds even if the key already exists.NavuList.safeCreate
(ConfObject key) Variant ofNavuList.create(ConfObject)
that succeeds even if the key already exists.NavuList.safeCreate
(String keyStr) Variant ofNavuList.create(String)
that succeeds even if the key already exists.NavuList.safeCreate
(String[] keyArr) Variant ofNavuList.create(String[])
that succeeds even if the key already exists.NavuAction.select
(ConfObject[] query) Not supported returns only an empty CollectionNot supported returns only an empty CollectionNavuContainer.select
(ConfObject[] kp) NavuList.select
(ConfObject[] kp) abstract Collection<NavuNode>
NavuNode.select
(ConfObject[] query) abstract Collection<NavuNode>
abstract Collection<NavuNode>
void
Deprecated.void
Sets the value of the leaf node.void
Sets the value and tries to perform an update.void
Deprecated.void
PreparedXMLStatement.set()
Deprecated.void
PreparedXMLStatement.set
(NavuContext context) Deprecated.void
Deprecated.NavuAction.setChange
(List<ConfObject> kp, DiffIterateOperFlag op, ConfValue oldValue, NavuContext delContext) Sets the change type on a node.NavuContainer.setChange
(List<ConfObject> path, DiffIterateOperFlag op, ConfValue oldValue, NavuContext delContext) NavuLeaf.setChange
(List<ConfObject> kp, DiffIterateOperFlag op, ConfValue oldValue, NavuContext delContext) NavuList.setChange
(List<ConfObject> path, DiffIterateOperFlag op, ConfValue oldValue, NavuContext delContext) NavuContainer.setOperationalDataCase
(String choiceStr, String caseStr) Deprecated.void
NavuContainer.setOperDataCase
(String choiceStr, String caseStr) Set a case with the namecaseStr
for a choicechoiceStr
for Cdb when writing operational data.void
This method is almost identical toNavuLeaf.set(String)
with the exception that the value should be wrapped inside XML tag.void
NavuNode.setValues
(ConfXMLParam[] params) Set arbitrary sub-elements of a container or list entry.void
Set arbitrary sub-elements of a container or list entry.void
PreparedXMLStatement.setValues()
When all of the parameterized values have been filled in, this method is intended to be invoked for a final set operation with the given values.void
PreparedXMLStatement.setValues
(NavuContext context) When all of the parameterized values have been filled in, this method is intended to be invoked for a final set operation with the given values.void
Similar toPreparedXMLStatement.setValues(NavuContext)
but uses the context of the supplied node.NavuContainer.sharedCreate()
Creates an optional container.void
NavuLeaf.sharedCreate()
Create an empty leaf node, silently succeeding if the leaf already exists and also maintain the FASTMAP reference counter on the leaf.void
NavuLeafList.sharedCreate
(ConfValue elem) The variant ofcreate
that succeeds even if the object already exists, and also maintains a reference counter on the object.void
NavuLeafList.sharedCreate
(String elemStr) The variant ofcreate
that succeeds even if the object already exists, and also maintains a reference counter on the object.NavuList.sharedCreate
(ConfKey key) Variant ofNavuList.create(ConfKey)
that succeeds even if the key already exists, and also maintains a reference counter on the object.NavuList.sharedCreate
(ConfObject key) Variant ofNavuList.create(ConfObject)
that succeeds even if the key already exists, and also maintains a reference counter on the object.NavuList.sharedCreate
(String keyStr) Variant ofNavuList.create(String)
that succeeds even if the key already exists, and also maintains a reference counter on the object.NavuList.sharedCreate
(String[] keyArr) Variant ofNavuList.create(String[])
that succeeds even if the key already exists, and also maintains a reference counter on the object.void
Sets the value of a leaf node with FastMap support, creating backpointers and reference counter similar to sharedCreate() All FastMap code shall (in principle) allways use this method instead of set()void
SharedSet using string representation of value.void
NavuNode.sharedSetValues
(ConfXMLParam[] params) Set arbitrary sub-elements of a container or list entry with FastMap support, creating backpointers and reference counter.void
NavuNode.sharedSetValues
(String xml) Set arbitrary sub-elements of a container or list entry with FastMap support, creating backpointers and reference counter.void
PreparedXMLStatement.sharedSetValues()
Variant ofPreparedXMLStatement.setValues()
with FastMap support.void
PreparedXMLStatement.sharedSetValues
(NavuContext context) Variant ofPreparedXMLStatement.setValues(NavuContext)
with FastMap support.void
PreparedXMLStatement.sharedSetValues
(NavuNode node) Variant ofPreparedXMLStatement.setValues(NavuNode)
with FastMap support.int
NavuContainer.size()
Returns the number of nodes contained by the container.int
NavuLeafList.size()
Returns the number of leaf-list elements contained by the leaf-list.int
NavuList.size()
Returns the number of list elements contained by the list node.int
NavuContext.startOperationalTrans
(int mode) This method starts a transaction towards theConf.DB_OPERATIONAL
database to be used in the context.int
NavuContext.startOperationalTrans
(int mode, String vendor, String product, String version, String clientId) int
NavuContext.startPreCommitRunningTrans()
This method starts a transaction towards the PRE_COMMIT_RUNNING datastore.int
NavuContext.startPreCommitRunningTrans
(String vendor, String product, String version, String clientId) int
NavuContext.startRunningTrans
(int mode) This method starts a transaction towards theConf.DB_RUNNING
database to be used in the context.int
NavuContext.startRunningTrans
(int mode, String vendor, String product, String version, String clientId) NavuLeaf.toKey()
Convert the leaf value to a ConfKey.NavuLeaf.value()
Returns the effective value on the first call, or cached value in the subsequent calls of this leaf.NavuLeaf.valueAsString()
Returns the Schema aware string representation of a leaf.void
NavuContainer.valueUpdateInd
(NavuNode child) An indication received from a child node.void
NavuList.valueUpdateInd
(NavuNode child) NavuAction.xPathSelect
(String xPath) NavuNode.xPathSelect
(String query) Evaluates the XPath path expressionquery
and returns the resulting node set as list ofNavuNode
's.void
NavuNode.xPathSelectIterate
(String query, NavuNodeSetIterate iterate) Iterate through a NodeSet based on a supplied XPath query.ModifierConstructorDescriptionNavuParser
(String xml, MaapiSchemas.CSNode node, ConfPath path, int mode) Constructor for the XML parser The xml snippet must have root tag that corresponds to the root CSNode The parser works in one of five modes:NavuParser.MODE_GET
-
Uses of NavuException in com.tailf.navu.traversal
Modifier and TypeMethodDescriptionstatic NavuTreeTraversal
NavuTreeTraversal.createInstance
(NavuContext ctx, NavuTraversalMean travmeth) Factory method to retrieve an instance of this class.void
TraversalFilter.currentNode
(NavuNode node) NavuTraversalBfsMean.traverse
(NavuNode root, List<TraversalFilter> filters) NavuTraversalDfsMean.traverse
(NavuNode root, List<TraversalFilter> filters) NavuTraversalMean.traverse
(NavuNode root, List<TraversalFilter> filter) NavuTreeTraversal.traverse()
Start the traversal process. -
Uses of NavuException in com.tailf.ncs
Modifier and TypeMethodDescriptionPlanComponent.appendState
(String stateName) This method supplies a state to the specific component.PlanComponent.appendState
(String stateName, String createMonitor, String createTriggerExpr) PlanComponent.appendState
(String stateName, String createMonitor, String createTriggerExpr, String deleteMonitor, String deleteTriggerExpr) PlanComponent.backTrack()
PlanComponent.backTrack
(boolean isBacktracking) Setting status to ncs:failed for a specific state in the plan componentPlanComponent.setNotReached
(String stateName) Setting status to ncs:not-reached for a specific state in the plan componentPlanComponent.setReached
(String stateName) Setting status to ncs:reached for a specific state in the plan componentModifierConstructorDescriptionPlanComponent
(NavuNode service, String name, String componentType) Creation of a plan component.PlanComponent
(NavuNode service, String name, String componentType, ConfObjectRef serviceReference) -
Uses of NavuException in com.tailf.ncs.alarmman.consumer
Modifier and TypeMethodDescriptionstatic AlarmSourceCentral
AlarmSourceCentral.getAlarmSource
(int alarmQueueLen, Cdb cdb) Retrieves the alarm source central object. -
Uses of NavuException in com.tailf.ncs.alarmman.producer
Modifier and TypeMethodDescriptionvoid
AlarmSink.submitAlarm
(Alarm alarm) Submits the specifiedAlarm
into the alarm list.boolean
AlarmSink.submitAlarm
(ManagedDevice managedDevice, ManagedObject managedObject, ConfIdentityRef alarmtype, ConfBuf specificProblem, PerceivedSeverity severity, ConfBuf alarmText, List<ManagedObject> impactedObjects, List<AlarmId> relatedAlarms, List<ManagedObject> rootCauseObjects, ConfDatetime timeStamp, Attribute... customAttributes) Submits the specifiedAlarm
into the alarm list.boolean
AlarmSink.submitAlarm
(ManagedDevice managedDevice, ManagedObject managedObject, ConfIdentityRef alarmtype, ConfBuf specificProblem, PerceivedSeverity severity, String alarmText, List<ManagedObject> impactedObjects, List<AlarmId> relatedAlarms, List<ManagedObject> rootCauseObjects, ConfDatetime timeStamp, Attribute... customAttributes) Submits the specifiedAlarm
into the alarm list.
NavuContainer.setOperDataCase(String, String)