NavuAction (CONF API Version 6.4)

Object
- com.tailf.navu.NavuNode
- - com.tailf.navu.NavuAction

```
public class NavuAction
extends NavuNode
```
This class represents a action modeled in the data model.
Although the NavuAction implements NavuNode the usage of this class only to call the action with given parameters and it is limited in functionality specifies in NavuNode.

Method Summary

Methods
Modifier and Type	Method and Description
`ConfXMLParam[]`	`call()` Issues an action with empty parameters
`ConfXMLParam[]`	`call(ConfXMLParam[] params)` Issues an action call with given parameters
`ConfXMLParam[]`	`call(String xml)` Issues an action call with given parameter
`Collection<NavuNode>`	`children()` Return the children of this node.
`NavuContainer`	`container(Integer key)` Returns a subordinate reference to a container according to the given hash value.
`NavuContainer`	`container(String key)` Returns a subordinate reference to `NavuNode` according to the given string `key`.
`NavuContainer`	`container(String prefix, String key)` Returns a subordinate reference to container according to the given `key` and `prefix`.
`NavuContext`	`context()` Returns the current `NavuContext` that this node is attached to.
`List<ConfXMLParam>`	`encodeValues()` Encoding the sub-tree including the current `NavuNode` as the topmost `NavuNode` to a `ConfXMLParam` array.
`List<ConfXMLParam>`	`encodeXML()` Encoding the sub-tree including the current `NavuNode` as the topmost `NavuNode` to a `ConfXMLParam` array.
`boolean`	`equals(Object o)` Compares the specified object with this `NavuAction` for equality.
`boolean`	`exists()` Generic exists test for Navu navigational elements
`CdbSession`	`getCdbSession(CdbDBType dbType)` Deprecated.
`DiffIterateOperFlag`	`getChangeFlag()` Returns the latest change that this `NavuNode` has been a subject to by a transaction.
`List<NavuNode>`	`getChanges()` Return the descendant `NavuNode`'s (including this element) that has been affected by changes to the `MAAPI` transaction.
`List<NavuNode>`	`getChanges(boolean emitSubtree)` Return the descendant `NavuNode` including this `NavuNode` that has been affected by the current MAAPI transaction.
`List<NavuNode>`	`getChanges(boolean emitSubtree, DiffIterateOperFlag... forOps)` Return the descendant `NavuNode` including this `NavuNode` that has been affected by the current MAAPI transaction.
`NavuNodeInfo`	`getInfo()` Returns the `NaveNodeInfo` regarding this node.
`String`	`getKeyPath()` Returns the absolute keypath of this node.
`String`	`getName()` Returns the name of this NavuNode.
`NavuNode`	`getNavuNode(ConfPath path)` Retrieve a NavuNode based on the given absolute or relative `path`.
`NavuNode`	`getParent()` Returns the parent of the node.
`ConfNamespace`	`getRootNS()` Returns the root namespace of the topmost ancestor.
`ConfXMLParam[]`	`getValues(ConfXMLParam[] param)` Invokes or call an action defined in the data model (see `tailf_yang_extensions(5)`).
`ConfXMLParam[]`	`getValues(String xml)` Invokes or call an action defined in the data model (see `tailf_yang_extensions(5)`).
`int`	`hashCode()` Returns the hash code value for this `NavuAction`.
`NavuLeaf`	`leaf(Integer key)` Returns a subordinate reference to a leaf node according to the given hash value `key`.
`NavuLeaf`	`leaf(String leaf)` Returns a subordinate reference to a `NavuNode` according to the given string `key`.
`NavuLeaf`	`leaf(String prefix, String leaf)` Returns a subordinate reference to leaf according to the given `key` and `prefix`.
`NavuList`	`list(Integer key)` Returns a subordinate reference to list according to the given hash value `key`.
`NavuList`	`list(String key)` Returns a subordinate reference to `NavuNode` according to the given string `key`.
`NavuList`	`list(String prefix, String key)` Returns a subordinate reference to list according to the given `key` and `prefix`.
`void`	`reset()` Not supported does nothing
`Collection<NavuNode>`	`select(ConfObject[] query)`
`Collection<NavuNode>`	`select(List<String> query)` Not supported returns only an empty Collection
`Collection<NavuNode>`	`select(String query)` Not supported returns only an empty Collection
`NavuNode`	`setChange(List<ConfObject> kp, DiffIterateOperFlag op, ConfValue oldValue, NavuContext delContext)` Sets the change type on a node.
`void`	`startCdbSession(CdbDBType dbtype, EnumSet<CdbLockType> lockflags)` Deprecated.
`void`	`stopCdbSession()` Closes all CdbSessions for the NavuContainer.
`String`	`toString()`
`void`	`valueUpdateInd(NavuNode child)`
`List<NavuNode>`	`xPathSelect(String xPath)` Evaluates the XPath Path expression `query` returns resulting node set as list of `NavuNode`'s.

Methods inherited from class com.tailf.navu.NavuNode
getChange, getConfPath, getXml, prepareXMLCall, setValues, setValues, sharedSetValues, sharedSetValues, xPathSelectIterate

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - call
```
public ConfXMLParam[] call()
                    throws NavuException
```
    Issues an action with empty parameters
    
    Returns:
    result from this action call
    
    Throws:
    
    NavuException
  - call
```
public ConfXMLParam[] call(ConfXMLParam[] params)
                    throws NavuException
```
    Issues an action call with given parameters
    
    Parameters:
    params - parameters to the action call
    
    Throws:
    
    NavuException - if the NavuContext is not created with Maapi
  - call
```
public ConfXMLParam[] call(String xml)
                    throws NavuException
```
    Issues an action call with given parameter
    
    Parameters:
    xml - parameters as corresponding xml string data
    
    Throws:
    
    NavuException
  - children
```
public Collection<NavuNode> children()
                              throws NavuException
```
    Return the children of this node.
    
    Overrides:
    
    children in class NavuNode
    
    Returns:
    children of this node
    
    Throws:
    
    NavuException
  - container
```
public NavuContainer container(Integer key)
                        throws NavuException
```
    Description copied from class: NavuNode
    
    Returns a subordinate reference to a container according to the given hash value. The container hashvalue could be obtained through ConfNamespace.stringToHash(String), MaapiSchemas.stringToHash(String) or use the overloaded method NavuNode.container(String)
    
    Overrides:
    
    container in class NavuNode
    
    Parameters:
    key - hashed value of the container to return
    
    Returns:
    subordinate reference to a container
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a container or if subordinate node has no matching container with the hash value key
  - container
```
public NavuContainer container(String key)
                        throws NavuException
```
    Description copied from class: NavuNode
    
    Returns a subordinate reference to NavuNode according to the given string key.
    
    Overrides:
    
    container in class NavuNode
    
    Parameters:
    key - the name of the subordinate container
    
    Returns:
    reference to a subordinate container node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a container node or if subordinate node has no matching container with the name key
  - container
```
public NavuContainer container(String prefix,
                      String key)
                        throws NavuException
```
    Description copied from class: NavuNode
    
    Returns a subordinate reference to container according to the given key and prefix.
    
    Overrides:
    
    container in class NavuNode
    
    Parameters:
    prefix - the prefix for the namespace
    key - the name of the subordinate container
    
    Returns:
    reference to a subordinate container node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a container node or if subordinate node has no matching container with the name key and prefix
  - context
```
public NavuContext context()
```
    Returns the current NavuContext that this node is attached to.
    
    Overrides:
    
    context in class NavuNode
    
    Returns:
    current cdbSession().
  - encodeValues
```
public List<ConfXMLParam> encodeValues()
                                throws NavuException
```
    Description copied from class: NavuNode
    
    Encoding the sub-tree including the current NavuNode as the topmost NavuNode to a ConfXMLParam array.
    As opposed to encodeXML, the returning ConfXMLParam array does contain values in form of ConfXMLParamValue
    
    Specified by:
    
    encodeValues in class NavuNode
    
    Returns:
    A list of ConfXMLParam of the sub-tree including values
    
    Throws:
    
    NavuException - If the operation could not be performed for some reasons
    See Also:
    ConfXMLParam, ConfXMLParamValue
  - encodeXML
```
public List<ConfXMLParam> encodeXML()
                             throws NavuException
```
    Description copied from class: NavuNode
    Encoding the sub-tree including the current NavuNode as the topmost NavuNode to a ConfXMLParam array.
    The returning ConfXMLParam array contains no values except for list keys. The leaf elements are encoded as ConfXMLParamLeaf therefore the returning array could be used as a input parameter to NavuNode.getValues(ConfXMLParam[]) on the current elements parent.
    NavuNode node = ...; //cxa contains structure that does not contains values except for //keys in list elements ConfXMLParam[] cxa = node.encodeXML().toArray(new ConfXMLParam[0]); NavuNode parent = node.getParent(); //contains sub-tree with all the values ConfXMLParam[] cxb = parent.getValues(cxa);
    Specified by:
    
    encodeXML in class NavuNode
    
    Returns:
    An array of ConfXMLParam of the sub-tree (including key values) with key values.
    
    Throws:
    
    NavuException - If the operation could not be performed for some reasons
    See Also:
    ConfXMLParam, ConfXMLParamValue
  - equals
```
public boolean equals(Object o)
```
    Compares the specified object with this NavuAction for equality. Returns true if and only if the specified object is also a NavuAction and its keypath is equals.
    Specified by: equals in class NavuNode Parameters: o - the object to be compared for equality with this list Returns: true if the specified object is equal to this list
  exists public boolean exists() throws NavuException Description copied from class: NavuNode Generic exists test for Navu navigational elements Specified by: exists in class NavuNode Returns: boolean Throws: NavuException getCdbSession @Deprecated public CdbSession getCdbSession(CdbDBType dbType) Deprecated. This method is deprecated. Use one of NavuContextBase.getReadConfSession(), NavuContextBase.getReadConfSession() or NavuContextBase.getWriteOperSession() instead. Returns the current cdbSession. Overrides: getCdbSession in class NavuNode Returns: current cdbSession(). getChangeFlag public DiffIterateOperFlag getChangeFlag() Description copied from class: NavuNode Returns the latest change that this NavuNode has been a subject to by a transaction. Overrides: getChangeFlag in class NavuNode Returns: Flag for the latest change See Also: DiffIterateOperFlag getChanges public List<NavuNode> getChanges() throws NavuException Description copied from class: NavuNode Return the descendant NavuNode's (including this element) that has been affected by changes to the MAAPI transaction. The default behavior is to emit the affected descendant and include all the affected NavuNode's regardless of type of change. To filter out specific type of change use the methods NavuNode.getChanges(boolean, DiffIterateOperFlag...) Overrides: getChanges in class NavuNode Returns: A list of NavuNode's that has been affected by the changes to the current MAAPI transaction. Throws: NavuException - Is returned if we try to iterate on a transaction which is in the wrong state and not attached. getChanges public List<NavuNode> getChanges(boolean emitSubtree) throws NavuException Description copied from class: NavuNode Return the descendant NavuNode including this NavuNode that has been affected by the current MAAPI transaction. The emitSubtree flag specified if the desired sub-tree should be included in the return set. If set to true then the behavior is to include the whole sub-tree of affected NavuNode's. If set to false the sibling changes to the current transaction is to only included. Overrides: getChanges in class NavuNode Returns: A list of NavuNode that has been affected by changes to the current MAAPI transaction. Throws: NavuException - Is returned if we try to iterate on changes on a transaction which is in the wrong state and not attached. getChanges public List<NavuNode> getChanges(boolean emitSubtree, DiffIterateOperFlag... forOps) throws NavuException Description copied from class: NavuNode Return the descendant NavuNode including this NavuNode that has been affected by the current MAAPI transaction. The emitSubtree flag specified if the desired sub-tree should be included in the return set. If set to true then the behavior is to include the whole sub-tree of affected NavuNode's. If set to false the sibling NavuNode that has been affected by changes to the current transaction is to be included. The forOps argument specifies those specific changes that the NavuNode previously NavuNode's to be included filter out the set that does not match the specified arguments. Overrides: getChanges in class NavuNode Returns: A list of NavuNode that has been affected by changes to the current MAAPI transaction. Throws: NavuException - Is returned if we try to iterate on a transaction which is in the wrong state and not attached. getInfo public NavuNodeInfo getInfo() Description copied from class: NavuNode Returns the NaveNodeInfo regarding this node. A NavuNodeInfo is an object which further information could be retrieved from the current node. Overrides: getInfo in class NavuNode Returns: A informational instance about this NavuNode getKeyPath public String getKeyPath() Description copied from class: NavuNode Returns the absolute keypath of this node. Overrides: getKeyPath in class NavuNode Returns: A String representing the absolute keypath that this NavuNode getName public String getName() Description copied from class: NavuNode Returns the name of this NavuNode. Overrides: getName in class NavuNode Returns: - the node name. getNavuNode public NavuNode getNavuNode(ConfPath path) throws NavuException Description copied from class: NavuNode Retrieve a NavuNode based on the given absolute or relative path. If the path is relative it is relative this NavuNode . Overrides: getNavuNode in class NavuNode Returns: NavuNode pointed by path if it is absolute or if relative the NavuNode pointed by path relative this NavuNode Throws: NavuException - if the path is invalid according the schema or does not lead to a instance node. getParent public NavuNode getParent() Description copied from class: NavuNode Returns the parent of the node. Overrides: getParent in class NavuNode Returns: - this node parent or null if this NavuNode represents the root node. getRootNS public ConfNamespace getRootNS() Returns the root namespace of the topmost ancestor. Overrides: getRootNS in class NavuNode Returns: topmost namespace. getValues public ConfXMLParam[] getValues(ConfXMLParam[] param) throws NavuException Invokes or call an action defined in the data model (see tailf_yang_extensions(5)). The params and values arrays are the parameters for and results from the action, respectively, and use the ConfXMLParam. Overrides: getValues in class NavuNode Parameters: param - pre-populated array of ConfXMLParam Returns: Array of ConfXMLParam where ConfXMLParamLeaf is replaced with ConfXMLParamValue Throws: NavuException - If the input parameters does not confirm to the current data model or external error have occurred getValues public ConfXMLParam[] getValues(String xml) throws NavuException Invokes or call an action defined in the data model (see tailf_yang_extensions(5)). The XML input value to this action is the eqvivalent ConfXMLParam[] structure. The retrn uarrays are the parameters for and results from the action, respectively, and use the ConfXMLParam. Overrides: getValues in class NavuNode Parameters: xml - XML string representation as the input values to this action Throws: NavuException See Also: ConfXMLParam hashCode public int hashCode() Returns the hash code value for this NavuAction. This implementation uses exactly the code that is used to define the hash code for a String. Specified by: hashCode in class NavuNode Returns: the hash code value for this NavuAction leaf public NavuLeaf leaf(Integer key) throws NavuException Description copied from class: NavuNode Returns a subordinate reference to a leaf node according to the given hash value key. Overrides: leaf in class NavuNode Parameters: key - hashed value of the subordinate leaf Returns: reference to a subordinate container node Throws: NavuException - if the corresponding subordinate node is not a leaf node or if subordinate node has no matching leaf with the hash value key leaf public NavuLeaf leaf(String leaf) throws NavuException Description copied from class: NavuNode Returns a subordinate reference to a NavuNode according to the given string key. Overrides: leaf in class NavuNode Parameters: leaf - the name of the subordinate leaf Returns: reference to a subordinate leaf node Throws: NavuException - if the corresponding subordinate node is not a leaf node or if subordinate node has no matching leaf with the name key leaf public NavuLeaf leaf(String prefix, String leaf) throws NavuException Description copied from class: NavuNode Returns a subordinate reference to leaf according to the given key and prefix. Overrides: leaf in class NavuNode Parameters: prefix - the prefix for the namespace leaf - the name of the subordinate leaf Returns: reference to a subordinate leaf node Throws: NavuException - if the corresponding subordinate node is not a leaf node or if subordinate node has no matching leaf with the name key and prefix list public NavuList list(Integer key) throws NavuException Description copied from class: NavuNode Returns a subordinate reference to list according to the given hash value key. Overrides: list in class NavuNode Parameters: key - the name of the subordinate list Returns: reference to a subordinate list node Throws: NavuException - if the corresponding subordinate node is not a list node or if subordinate node has no matching list with the hash value key list public NavuList list(String key) throws NavuException Description copied from class: NavuNode Returns a subordinate reference to NavuNode according to the given string key. Overrides: list in class NavuNode Parameters: key - the name of the subordinate list Returns: reference to a subordinate list node Throws: NavuException - if the corresponding subordinate node is not a list node or if subordinate node has no matching list with the name key list public NavuList list(String prefix, String key) throws NavuException Description copied from class: NavuNode Returns a subordinate reference to list according to the given key and prefix. Overrides: list in class NavuNode Parameters: prefix - the prefix for the namespace key - the name of the subordinate list Returns: reference to a subordinate list node Throws: NavuException - if the corresponding subordinate node is not a list node or if subordinate node has no matching list with the name key and prefix reset public void reset() Not supported does nothing Specified by: reset in class NavuNode select public Collection<NavuNode> select(ConfObject[] query) throws NavuException Specified by: select in class NavuNode Parameters: query - Returns: a collection a nodes matching a Regular Expression query Throws: NavuException select public Collection<NavuNode> select(List<String> query) throws NavuException Not supported returns only an empty Collection Specified by: select in class NavuNode Parameters: query - a list of regular expression. Returns: a collection a nodes marching the query Throws: NavuException select public Collection<NavuNode> select(String query) throws NavuException Not supported returns only an empty Collection Specified by: select in class NavuNode Parameters: query - a "/" separated regular expression. Returns: a collection a nodes marching the query Throws: NavuException setChange public NavuNode setChange(List<ConfObject> kp, DiffIterateOperFlag op, ConfValue oldValue, NavuContext delContext) throws NavuException Sets the change type on a node. Specified by: setChange in class NavuNode Parameters: kp - op - oldValue - Returns: the actual NavuNode that was updated. Throws: IOException ConfException NavuException startCdbSession @Deprecated public void startCdbSession(CdbDBType dbtype, EnumSet<CdbLockType> lockflags) Deprecated. This method has been deprecated This method is a no op the internal session pool handles the session start Overrides: startCdbSession in class NavuNode stopCdbSession public void stopCdbSession() Description copied from class: NavuNode Closes all CdbSessions for the NavuContainer. This is only necessary the case if the the NavuContainer was created with a constructor for CDB access. In such cases it is important to call this method as soon as the NavuContainer has been used. The reason for this is to release any locks on the CDB database as soon as possible. Calling this method several times under the life-cycle of the NavuContainer object is supported. Overrides: stopCdbSession in class NavuNode toString public String toString() Overrides: toString in class Object valueUpdateInd public void valueUpdateInd(NavuNode child) Specified by: valueUpdateInd in class NavuNode xPathSelect public List<NavuNode> xPathSelect(String xPath) throws NavuException Description copied from class: NavuNode Evaluates the XPath Path expression query returns resulting node set as list of NavuNode's. The expression query will be evaluated using this node as the context node. examples: NavuContainer = root.container(myns._somecontainer1). container(myns._somecontainer2).container(myns._servers); //retrieve all the instance entries of the server list "server" servers.xPathSelect("server"); //retrieve all child nodes of instance with srv-name: www1 //entries of the server list "server" servers.xPathSelect("server[srv-name='www1']/*"); //retrieve all leaf ip node of instance with srv-name: www1 //entries of the server list "server" servers.xPathSelect("server[srv-name='www1']/ip"); Overrides: xPathSelect in class NavuNode Parameters: xPath - - XPath 1.0 query Returns: a collection a nodes marching the query Throws: NavuException

Class NavuAction

Method Summary

Methods inherited from class com.tailf.navu.NavuNode

Methods inherited from class Object

Method Detail

call

call

call

children

container

container

container

context

encodeValues

encodeXML

equals

exists

getCdbSession

getChangeFlag

getChanges

getChanges

getChanges

getInfo

getKeyPath

getName

getNavuNode

getParent

getRootNS

getValues

getValues

hashCode

leaf

leaf

leaf

list

list

list

reset

select

select

select

setChange

startCdbSession

stopCdbSession

toString

valueUpdateInd

xPathSelect