| Package | Description | 
|---|---|
| com.tailf.cdb | 
 Package with methods for connecting to the configuration database. 
 | 
| com.tailf.conf | 
 Data types and utilities for communication with the server. 
 | 
| com.tailf.dp | 
 Data provider API package, for implementation of callbacks for validations, actions, transformation etc. 
 | 
| com.tailf.dp.services | 
 Service callback specific context and utilities. 
 | 
| com.tailf.ha | 
 
 Package for setup and control of High Availability cluster nodes. 
 | 
| com.tailf.maapi | 
 MAAPI is an API which provides full access to the systems internal
 transaction engine. 
 | 
| 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.ncs | 
 NCS Java machine management and control of Services, Neds,
 callbacks and Applications 
 | 
| com.tailf.ncs.alarmman.common | 
 The Common Alarm Management package contains common definitions that are
 used within the alarm manager. 
 | 
| com.tailf.ncs.alarmman.consumer | 
 The Alarm Manager consumer package provides support for subscription to
 alarms in the NCS Alarm list. 
 | 
| com.tailf.ncs.alarmman.producer | 
 The Alarm Manager producer package provides support for injection of
 alarms into the NCS Alarm list. 
 | 
| com.tailf.ncs.template | |
| com.tailf.ned | 
 Network Equipment Drivers package 
 | 
| com.tailf.notif | 
 Package for subscription to asynchronous events. 
 | 
| com.tailf.util | 
 Utility classes for representing compiled ConfNamespaces. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
CdbException
Cdb package generic exception 
 | 
class  | 
CdbExtendedException
This exception is used by clients of CdbSubscription that needs to report
 errors. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfException | 
CdbException.mk(ConfResponse r)  | 
static ConfException | 
CdbException.mk(ConfResponse r,
  ConfPath path)  | 
static ConfException | 
CdbExtendedException.mk(int extendedErrorCode,
  ConfNamespace appNS,
  String appTag,
  ConfResponse r)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
CdbSubscription.abortTransaction(CdbExtendedException ex)
Abort the transaction. 
 | 
void | 
CdbUpgradeSession.cd(ConfCdbUpgradePath path)  | 
void | 
CdbSession.cd(ConfPath path)
Changes the working directory. 
 | 
void | 
CdbUpgradeSession.cd(String fmt,
  Object... arguments)  | 
void | 
CdbSession.cd(String fmt,
  Object... arguments)
Change working directory to container specified by path string 
 | 
void | 
CdbUpgradeSession.create(ConfCdbUpgradePath path)  | 
void | 
CdbSession.create(ConfPath path)
Create a new optional element or list entry. 
 | 
void | 
CdbUpgradeSession.create(String fmt,
      Object... arguments)  | 
void | 
CdbSession.create(String fmt,
      Object... arguments)
similar to  
CdbSession.create(ConfPath) but specifies element using path
 string | 
void | 
CdbUpgradeSession.delete(ConfCdbUpgradePath path)  | 
void | 
CdbSession.delete(ConfPath path)
Delete an optional element or list entry and all its child elements. 
 | 
void | 
CdbUpgradeSession.delete(String fmt,
      Object... arguments)  | 
void | 
CdbSession.delete(String fmt,
      Object... arguments)
similar to  
CdbSession.delete(ConfPath) but specifies element using path
 string | 
void | 
CdbSubscription.diffIterate(int subid,
           CdbDiffIterate iter)
Iterate over changes made in CDB. 
 | 
void | 
CdbSubscription.diffIterate(int subid,
           CdbDiffIterate iter,
           EnumSet<DiffIterateFlags> flags,
           Object initstate)
Iterate over changes made in CDB with additional supplied flags. 
 | 
void | 
CdbSession.endSession()
Ends the data session 
 | 
boolean | 
CdbUpgradeSession.exists(ConfCdbUpgradePath path)  | 
boolean | 
CdbSession.exists(ConfPath path)
Containers and leafs in a YANG model may be optional. 
 | 
boolean | 
CdbUpgradeSession.exists(String fmt,
      Object... arguments)  | 
boolean | 
CdbSession.exists(String fmt,
      Object... arguments)
Checks whether an element exists. 
 | 
ConfObject | 
CdbUpgradeSession.getCase(String choice,
       ConfCdbUpgradePath path)  | 
ConfObject | 
CdbSession.getCase(String choice,
       ConfPath path)
 Retrieve the currently selected case. 
 | 
ConfObject | 
CdbUpgradeSession.getCase(String choice,
       String fmt,
       Object... arguments)  | 
ConfObject | 
CdbSession.getCase(String choice,
       String fmt,
       Object... arguments)
 Retrieve the currently selected case. 
 | 
String | 
CdbSession.getcwd()
Returns the current position as previously set by  
CdbSession.cd(ConfPath),
 CdbSession.pushd(ConfPath), or CdbSession.popd() as a string. | 
ConfObject[] | 
CdbSession.getcwdPath()
Returns the current position as previously set by  
CdbSession.cd(ConfPath),
 CdbSession.pushd(ConfPath), or CdbSession.popd() as a
 ConfObject array. | 
ConfValue | 
CdbUpgradeSession.getElem(ConfCdbUpgradePath path)  | 
ConfValue | 
CdbSession.getElem(ConfPath path)
This reads a a value from the path. 
 | 
ConfValue | 
CdbUpgradeSession.getElem(String fmt,
       Object... arguments)  | 
ConfValue | 
CdbSession.getElem(String fmt,
       Object... arguments)
similar to  
CdbSession.getElem(ConfPath) but specifies element using path
 string | 
List<ConfXMLParam> | 
CdbSubscription.getModifications(CdbGetModificationFlag flag)
Deprecated.  
 | 
List<ConfXMLParam> | 
CdbSubscription.getModifications(EnumSet<CdbGetModificationFlag> flags)
Retrieve changes that caused by subscription notification. 
 | 
List<ConfXMLParam> | 
CdbSubscription.getModifications(int subid,
                CdbGetModificationFlag flag,
                ConfPath path)
Deprecated.  
 | 
List<ConfXMLParam> | 
CdbSubscription.getModifications(int subid,
                CdbGetModificationFlag flag,
                String fmt,
                Object... args)
Deprecated.  
 | 
List<ConfXMLParam> | 
CdbSubscription.getModifications(int subid,
                EnumSet<CdbGetModificationFlag> flags,
                ConfPath path)
Retrieve changes that caused by subscription notification. 
 | 
List<ConfXMLParam> | 
CdbSubscription.getModifications(int subid,
                EnumSet<CdbGetModificationFlag> flags,
                String fmt,
                Object... args)
Retrieve changes that caused by subscription notification. 
 | 
String | 
CdbSubscription.getModificationsCLI(int subid)
Return a string with the CLI commands that corresponds to the
 changes that triggered subscription. 
 | 
String | 
CdbSubscription.getModificationsCLI(int subid,
                   int flags)
CLI string that corresponds to the changes that triggered subscription. 
 | 
List<String> | 
CdbSubscription.getMountId(ConfPath path)  | 
List<String> | 
Cdb.getMountId(ConfPath path)  | 
int | 
CdbUpgradeSession.getNumberOfInstances(ConfCdbUpgradePath path)  | 
int | 
CdbSession.getNumberOfInstances(ConfPath path)
Returns the number of elements of a container type. 
 | 
int | 
CdbUpgradeSession.getNumberOfInstances(String fmt,
                    Object... arguments)  | 
int | 
CdbSession.getNumberOfInstances(String fmt,
                    Object... arguments)
similar to  
CdbSession.getNumberOfInstances(ConfPath) but specifies element
  using path string | 
ConfObject[] | 
CdbUpgradeSession.getObject(int numOfObjects,
         ConfCdbUpgradePath path)  | 
ConfObject[] | 
CdbSession.getObject(int numOfObjects,
         ConfPath path)
Same functionality as getObject(numOfObjects, fmt, arguments) but takes a
 already constructed ConfPath object as argument instead of fmt,
 arguments. 
 | 
ConfObject[] | 
CdbUpgradeSession.getObject(int numOfObjects,
         String fmt,
         Object... arguments)  | 
ConfObject[] | 
CdbSession.getObject(int numOfObjects,
         String fmt,
         Object... arguments)
In some cases it can be motivated to read multiple values in one request
 - this will be more efficient since it only incurs a single round trip to
 the server, but usage is a bit more complex. 
 | 
List<ConfObject[]> | 
CdbUpgradeSession.getObjects(int numOfObjects,
          int instance,
          int numOfInstances,
          ConfCdbUpgradePath path)  | 
List<ConfObject[]> | 
CdbSession.getObjects(int numOfObjects,
          int instance,
          int numOfInstances,
          ConfPath path)
Same functionality as getObjects(numOfObjects, instance, fmt, arguments)
 but takes a already constructed ConfPath object as argument instead of
 fmt, arguments. 
 | 
List<ConfObject[]> | 
CdbUpgradeSession.getObjects(int numOfObjects,
          int instance,
          int numOfInstances,
          String fmt,
          Object... arguments)  | 
List<ConfObject[]> | 
CdbSession.getObjects(int numOfObjects,
          int instance,
          int numOfInstances,
          String fmt,
          Object... arguments)
Similar to cdb.getObject(), but reads multiple instances of a dynamic
 container based on the "instance integer" otherwise given within square
 brackets in the path - here the path must specify the dynamic container
 without the instance integer. 
 | 
CdbPhase | 
Cdb.getPhase()
Returns the start-phase CDB database is currently in. 
 | 
CdbTxId | 
Cdb.getTxId()
Returns a CdbTxid object which represents the last transaction
 id from CDB. 
 | 
long | 
CdbSubscription.getUserSession()  | 
ConfXMLParam[] | 
CdbUpgradeSession.getValues(ConfXMLParam[] params,
         ConfCdbUpgradePath path)  | 
ConfXMLParam[] | 
CdbSession.getValues(ConfXMLParam[] params,
         ConfPath path)
Same functionality as getValues(params, fmt, arguments) but takes a
 already constructed ConfPath object as argument instead of fmt,
 arguments. 
 | 
ConfXMLParam[] | 
CdbUpgradeSession.getValues(ConfXMLParam[] params,
         String fmt,
         Object... arguments)  | 
ConfXMLParam[] | 
CdbSession.getValues(ConfXMLParam[] params,
         String fmt,
         Object... arguments)
Read an arbitrary set of sub-elements of a container element. 
 | 
int | 
CdbUpgradeSession.index(ConfCdbUpgradePath path)  | 
int | 
CdbSession.index(ConfPath path)
Returns the position of a key 
 | 
int | 
CdbUpgradeSession.index(String fmt,
     Object... arguments)  | 
int | 
CdbSession.index(String fmt,
     Object... arguments)
similar to  
CdbSession.index(ConfPath) but specifies element using path
 string | 
boolean | 
CdbUpgradeSession.isDefault(ConfCdbUpgradePath path)  | 
boolean | 
CdbSession.isDefault(ConfPath path)
This method returns true for a leaf which has a default value defined
 in the data model when no value has been set, i.e. 
 | 
boolean | 
CdbUpgradeSession.isDefault(String fmt,
         Object... arguments)  | 
boolean | 
CdbSession.isDefault(String fmt,
         Object... arguments)
similar to  
CdbSession.isDefault(ConfPath) but specifies element using path
 string | 
int | 
CdbUpgradeSession.nextIndex(ConfCdbUpgradePath path)  | 
int | 
CdbSession.nextIndex(ConfPath path)
Returns the position of the next key 
 | 
int | 
CdbUpgradeSession.nextIndex(String fmt,
         Object... arguments)  | 
int | 
CdbSession.nextIndex(String fmt,
         Object... arguments)
similar to  
CdbSession.nextIndex(ConfPath) but specifies element using path
 string | 
int | 
CdbSession.numInstances(ConfPath path)
Deprecated. 
 
in favor to getNumberOfInstances, which follows java naming
 conventions.
 Returns the number of elements of a container type. 
 | 
int | 
CdbSession.numInstances(String fmt,
            Object... arguments)
Deprecated. 
 
in favor to getNumberOfInstances, which follows java naming
 conventions.
 similar to  
CdbSession.numInstances(ConfPath) but specifies element using
 path string | 
void | 
CdbSession.popd()
Pops the top element from the directory stack and changes directory to
 previous directory. 
 | 
void | 
CdbUpgradeSession.pushd(ConfCdbUpgradePath path)  | 
void | 
CdbSession.pushd(ConfPath path)
Similar to  
CdbSession.cd(ConfPath) but pushes the previous current
 directory on a stack. | 
void | 
CdbUpgradeSession.pushd(String fmt,
     Object... arguments)  | 
void | 
CdbSession.pushd(String fmt,
     Object... arguments)
similar to  
CdbSession.pushd(ConfPath) but specifies position using path
 string | 
int[] | 
CdbSubscription.read()
Reads the Cdb subscription socket for events and blocks. 
 | 
void | 
CdbUpgradeSession.setCase(String choice,
       String scase,
       ConfCdbUpgradePath path)  | 
void | 
CdbSession.setCase(String choice,
       String scase,
       ConfPath path)
Same functionality as setCase(choice, scase, fmt, arguments) but takes a
 already constructed ConfPath object as argument instead of fmt,
 arguments. 
 | 
void | 
CdbUpgradeSession.setCase(String choice,
       String scase,
       String fmt,
       Object... arguments)  | 
void | 
CdbSession.setCase(String choice,
       String scase,
       String fmt,
       Object... arguments)
 When we use the YANG choice construct in the data model, this function
 can be used to select the current case. 
 | 
void | 
CdbUpgradeSession.setElem(ConfValue value,
       ConfCdbUpgradePath path)  | 
void | 
CdbSession.setElem(ConfValue value,
       ConfPath path)
 Sets an element in operational data. 
 | 
void | 
CdbUpgradeSession.setElem(ConfValue value,
       String fmt,
       Object... arguments)  | 
void | 
CdbSession.setElem(ConfValue value,
       String fmt,
       Object... arguments)
similar to  
CdbSession.setElem(ConfValue, ConfPath) but specifies element
 using path string | 
void | 
CdbSubscription.setMandatory(String mandatoryName)
Attaches a mandatory attribute and a mandatory name to this subscriber
 CDB keeps a list of mandatory subscribers for infinite extent, i.e. 
 | 
void | 
CdbSession.setNamespace(ConfNamespace ns)
Before we start to read data from CDB we need to set the namespace. 
 | 
void | 
CdbUpgradeSession.setObject(ConfValue[] values,
         ConfCdbUpgradePath path)  | 
void | 
CdbSession.setObject(ConfValue[] values,
         ConfPath path)
Set all elements corresponding to the complete contents of a container
 element, except for list entry sub-elements. 
 | 
void | 
CdbUpgradeSession.setObject(ConfValue[] values,
         String fmt,
         Object... arguments)  | 
void | 
CdbSession.setObject(ConfValue[] values,
         String fmt,
         Object... arguments)
similar to  
CdbSession.setObject(ConfValue[], ConfPath) but specifies
 element using path string | 
void | 
Cdb.setTimeout(int timeoutSecs)
A timeout for cdb client actions can be specified via the config file. 
 | 
void | 
CdbUpgradeSession.setValues(ConfXMLParam[] params,
         ConfCdbUpgradePath path)  | 
void | 
CdbSession.setValues(ConfXMLParam[] params,
         ConfPath path)
Set arbitrary sub-elements of a container element. 
 | 
void | 
CdbUpgradeSession.setValues(ConfXMLParam[] params,
         String fmt,
         Object... arguments)  | 
void | 
CdbSession.setValues(ConfXMLParam[] params,
         String fmt,
         Object... arguments)
similar to  
CdbSession.setValues(ConfXMLParam[], ConfPath) but specifies
 element using path string | 
void | 
CdbSession.setValues(List<ConfXMLParam> params,
         ConfPath path)  | 
CdbSession | 
Cdb.startSession()
Starts a new CDB Session on an already
 established  
Cdb against CdbDBType.CDB_RUNNING
 datastore with CdbLockType.LOCK_SESSION lock. | 
CdbSession | 
Cdb.startSession(CdbDBType dbtype)
Starts a new CDB Session on an already
 established  
Cdb. | 
CdbSession | 
Cdb.startSession(CdbDBType dbtype,
            EnumSet<CdbLockType> lockflags)
Starts a new CDB Session on an already
 established  
Cdb. | 
CdbUpgradeSession | 
Cdb.startUpgradeSession()
Similar to  
Cdb.startSession() but always returns
 a CdbUpgradeSession. | 
CdbUpgradeSession | 
Cdb.startUpgradeSession(CdbDBType dbtype)
Similar to  
Cdb.startSession(CdbDBType) but always returns
 a CdbUpgradeSession. | 
CdbUpgradeSession | 
Cdb.startUpgradeSession(CdbDBType dbtype,
                   EnumSet<CdbLockType> lockflags)
Similar to  
Cdb.startSession(CdbDBType, EnumSet) but always returns
 a CdbUpgradeSession. | 
int | 
CdbSubscription.subscribe(CdbSubscriptionType subscriptionType,
         EnumSet<CdbSubscrConfigFlag> flags,
         int priority,
         ConfNamespace ns,
         String fmt,
         Object... args)
Subscribe to a path. 
 | 
int | 
CdbSubscription.subscribe(CdbSubscriptionType subscriptionType,
         EnumSet<CdbSubscrConfigFlag> flags,
         int priority,
         int nshash,
         String fmt,
         Object... args)
Subscribe to a path. 
 | 
int | 
CdbSubscription.subscribe(CdbSubscriptionType subscriptionType,
         int priority,
         ConfNamespace ns,
         String fmt,
         Object... args)
Subscribe to a path. 
 | 
int | 
CdbSubscription.subscribe(CdbSubscriptionType subscriptionType,
         int priority,
         int nshash,
         String fmt,
         Object... args)
Subscribe to a path. 
 | 
int | 
CdbSubscription.subscribe(int priority,
         ConfNamespace ns,
         String fmt,
         Object... args)
Subscribe to a given path. 
 | 
int | 
CdbSubscription.subscribe(int priority,
         int nshash,
         String fmt,
         Object... args)
Subscribe to given path. 
 | 
void | 
CdbSubscription.subscribeDone()
Finishing the subscription setup. 
 | 
void | 
CdbSubscription.sync(CdbSubscriptionSyncType subscriptionSyncType)
Synchronize the subscriber. 
 | 
void | 
Cdb.triggerOperSubscriptions(int[] spointArray)
Function similar to  
Cdb.triggerOperSubscriptions(int[], EnumSet)
 with the difference that this function will never wait to acquire a lock
 and therefore fail and throw an Exception if Cdb is locked. | 
void | 
Cdb.triggerOperSubscriptions(int[] spointArray,
                        EnumSet<CdbLockType> lockflags)
Function to trigger operational subscriptions in similar to
   
Cdb.triggerSubscriptions(int[]). | 
void | 
Cdb.triggerSubscriptions(int[] spointArray)
Triggers Cdb subscription for configuration data. 
 | 
void | 
Cdb.waitStart()
This call waits until start-phase 1 is completed and CDB
 is available. 
 | 
| Constructor and Description | 
|---|
CdbExtendedException(int extendedErrorCode,
                    ConfNamespace appNS,
                    String appTag,
                    ConfException ex)  | 
| Constructor and Description | 
|---|
Cdb(String name,
   Socket socket)
Creates a new instance of a  
Cdb socket supplying a
 established open socket to ConfD/NCS daemon. | 
Cdb(String name,
   SocketChannel channel)
Deprecated.  
 | 
Cdb(String name,
   SocketChannel channel,
   int buffsize)
Deprecated.  
 | 
CdbSession(Cdb cdb)
Creates a new CDB session
 instance against the running database. 
 | 
CdbSession(Cdb cdb,
          CdbDBType dbtype)
Starts a new session on an already connected Cdb instance. 
 | 
CdbSession(Cdb cdb,
          CdbDBType dbtype,
          EnumSet<CdbLockType> lockflags)
Starts a new session on an already established Cdb with
 explicitly given lockflags. 
 | 
CdbUpgradeSession(Cdb cdb)  | 
CdbUpgradeSession(Cdb cdb,
                 CdbDBType dbtype)  | 
CdbUpgradeSession(Cdb cdb,
                 CdbDBType dbtype,
                 EnumSet<CdbLockType> lockflags)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ConfBadTermException
Exception thrown when protocol data is malformed. 
 | 
class  | 
ConfWarningException
Warning exception base class. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfException | 
ConfException.mk(ConfResponse r)  | 
static ConfException | 
ConfException.mk(ConfResponse r,
  ConfPath errPath)  | 
| Modifier and Type | Method and Description | 
|---|---|
ConfPath | 
ConfPath.append(String s)
Appends suffix path to existing keypath 
 | 
ConfCdbUpgradePath | 
ConfCdbUpgradePath.append(String s)
Appends suffix path to existing keypath 
 | 
ConfPath | 
ConfPath.append(String s,
      List<MaapiSchemas.CSNode> pathNodes)
Appends suffix path to existing keypath 
 | 
void | 
ConfBits.clearBit(long pos)
Clear bit at position pos in bitset. 
 | 
ConfPath | 
ConfPath.copyAppend(String s)
CopyAppends to the keypath 
 | 
ConfCdbUpgradePath | 
ConfCdbUpgradePath.copyAppend(String s)
CopyAppends to the keypath 
 | 
ConfPath | 
ConfPath.copyPop()
Creates a new ConfPath with the current path minus the last
 element including list keys. 
 | 
ConfCdbUpgradePath | 
ConfCdbUpgradePath.copyPop()
Creates a new ConfCdbUpgradePath with the current path minus the last
 element including list keys. 
 | 
static ConfObject | 
ConfObject.decode(ConfEObject o)  | 
static ConfXMLParam | 
ConfXMLParam.decodeParam(ConfEObject o)
Decode the internal representation to a  
ConfXMLParam
 Used internally. | 
static ConfXMLParam[] | 
ConfXMLParam.decodeParams(ConfEObject o)  | 
static void | 
ConfInternal.diffIterate(Object socket,
           ConfIterate iter,
           Object initstate)  | 
static void | 
ConfInternal.diffIterate(SelectionKey key,
           ConfIterate iter,
           Object initstate)
Common static method for diffIterate with CdbSubscription. 
 | 
static long | 
ConfInternal.doConnect(SelectionKey key,
         int id)
Connects the provided selectable channel to the Erlang process
  using the supplied selector with the buffer buf with the identifier
  id. 
 | 
static long | 
ConfInternal.doConnect(Socket socket,
         int id)  | 
Object | 
XPathAbrevCompiler.equal(Object left,
     Object right)  | 
Object | 
Compiler.equal(Object left,
     Object right)
Produces an EXPRESSION object representing the comparison:
 left equals to right 
 | 
static ConfNamespace | 
ConfNamespace.findNamespaceFromNsName(ConfPath path,
                       MountIdInterface mountIdGetter,
                       String namespaceName)  | 
static String | 
ConfBits.getBitNamesByValue(ConfPath path,
                  ConfBits bits)
Get a string of bitnames like  bitnames like "bit1 bit2 ...", i.e
 a space separated list of bitnames from a ConfBits value. 
 | 
static String | 
ConfBits.getBitNamesByValue(String path,
                  ConfBits bits)
Like  
ConfBits.getBitNamesByValue(ConfPath, ConfBits) but takes a path
 string pointing to the bitset in the schema. | 
static ConfEnumeration | 
ConfEnumeration.getEnumByLabel(ConfPath path,
              String label)
Get an ConfEnumeration from the string label at a given
 position in the schema. 
 | 
static ConfEnumeration | 
ConfEnumeration.getEnumByLabel(String path,
              String label)
Get an ConfEnumeration from the string label at a given
 position in the schema. 
 | 
ConfObject[] | 
InstancePath.getKP()
 Returns an array of  
ConfTag and ConfKey
 objects which represents the path in reverted order. | 
static String | 
ConfEnumeration.getLabelByEnum(ConfPath path,
              ConfEnumeration e)
Get the string label of an enumeration at a given
 position in the schema. 
 | 
static String | 
ConfEnumeration.getLabelByEnum(String path,
              ConfEnumeration e)
Get the string label of an enumeration at a given
 position in the schema. 
 | 
List<String> | 
MountIdInterface.getMountId(ConfPath path)  | 
static Socket | 
SocketFactory.getSocket(Object caller)
Retrieve a socket which is connected to the default host/port. 
 | 
Socket | 
SocketFactoryCallback.getSocket(Object caller,
         InetAddress iaddr,
         int port)
Retrieve a connected socket to a specified destination 
 | 
static Socket | 
SocketFactory.getSocket(Object caller,
         InetAddress iaddr,
         int port)
Retrieve a connected socket to a specified destination
 If the default host/port is not set, it will be set to the same as
 the given socket. 
 | 
Socket | 
SocketFactoryCallback.getSocket(Object caller,
         String hostname,
         int port)
Retrieve a connected socket to a specified destination 
 | 
static Socket | 
SocketFactory.getSocket(Object caller,
         String hostname,
         int port)
Retrieve a connected socket to a specified destination
 If the default host/port is not set, it will be set to the same as
 the given socket. 
 | 
static String | 
ConfValue.getStringByValue(ConfPath path,
                ConfValue val)
Get the string representation of a ConfValue at a given
 position in the schema. 
 | 
static String | 
ConfValue.getStringByValue(String path,
                ConfValue val)
Get the string representation of a ConfValue at a given
 position in the schema. 
 | 
Socket | 
SocketFactoryCallback.getUnconnectedSocket(Object caller)
Retrieve an unconnected socket. 
 | 
static Socket | 
SocketFactory.getUnconnectedSocket(Object caller)
Retrieve an unconnected socket. 
 | 
static ConfBits | 
ConfBits.getValueByBitNamesString(ConfPath path,
                        String bitNames)
Get an ConfBits from the string of bitnames like "bit1 bit2 ...", i.e
 a space separated list of bitnames adhering to a specific position in
 the schema. 
 | 
static ConfBits | 
ConfBits.getValueByBitNamesString(String path,
                        String bitNames)
Like  
ConfBits.getValueByBitNamesString(ConfPath, String) but takes a path
 string pointing to the bitset in the schema. | 
static ConfValue | 
ConfValue.getValueByString(ConfPath path,
                String str)
Get a ConfValue representation a string at a given
 position in the schema. 
 | 
static ConfValue | 
ConfValue.getValueByString(String path,
                String str)
Get a ConfValue representation a string at a given
 position in the schema. 
 | 
static ConfObject[] | 
ConfInternal.hk_keypath(ConfEObject term)
Create a hkeypath from a term. 
 | 
boolean | 
ConfBits.isBitSet(long pos)
Check if bit is set at position pos in bitset. 
 | 
static ConfObject[] | 
ConfInternal.mk_keypath(ConfEObject term,
          ArrayList<ConfNamespace> ns_list)
Makes a keypath from a term. 
 | 
void | 
ConfList.move(ConfObject n,
    ConfList.WhereTo where,
    ConfObject to)
Move a list element to a new position in the list. 
 | 
ConfValue | 
ConfTypeDescriptor.newInstance(String str)
Creates a new ConfValue instance of the type described by this
 ConfTypeDescriptor and with a value represented by a string. 
 | 
void | 
ConfPath.pop()
Pops the last element from the path including list keys. 
 | 
Object | 
XPathAbrevCompiler.qname(String prefix,
     String tagName)  | 
Object | 
Compiler.qname(String prefix,
     String name)
Produces an QNAME that represents a name with an optional prefix. 
 | 
static void | 
ConfInternal.readFill(SelectionKey key,
        ByteBuffer buf,
        int siz)
Read exactly  
siz data into the buffer
 buf. | 
static void | 
ConfInternal.readFill(Socket socket,
        byte[] b)
Reads data into a buffer. 
 | 
static void | 
ConfInternal.readPayLoad(SelectionKey key,
           ByteBuffer buf,
           int size)  | 
static void | 
ConfInternal.readSize(SelectionKey key,
        ByteBuffer buf,
        int size)  | 
static int | 
ConfInternal.requestInt(Socket socket,
          int op)
Request an integer from ConfD/NCS. 
 | 
static int | 
ConfInternal.requestInt(Socket socket,
          int op,
          int thandle)
Requests an integer value from ConfD/NCS. 
 | 
static ConfResponse | 
ConfInternal.requestTerm(SelectionKey key,
           int op)
Request the operation  
op with no argument,
  and read the response from ConfD/NCS. | 
static ConfResponse | 
ConfInternal.requestTerm(SelectionKey key,
           int op,
           ConfEObject arg)
Write a term  
arg for the specified operation
  op and read the response,
  from ConfD/NCS. | 
static ConfResponse | 
ConfInternal.requestTerm(SelectionKey key,
           int op,
           int thandle,
           boolean isrel,
           ConfEObject arg)
Write a term  
arg for the specified operation
  op , transaction handle thandle
  ( if available -1 otherwise ) and read the response,
  from ConfD/NCS. | 
static ConfResponse | 
ConfInternal.requestTerm(Socket socket,
           int op)
Requests a term from ConfD/NCS. 
 | 
static ConfResponse | 
ConfInternal.requestTerm(Socket socket,
           int op,
           ConfEObject arg)
Requests a term from ConfD/NCS. 
 | 
static ConfResponse | 
ConfInternal.requestTerm(Socket socket,
           int op,
           int thandle,
           boolean isrel,
           ConfEObject arg)
Requests a term from ConfD/NCS. 
 | 
void | 
ConfBits.setBit(long pos)
Set bit at position pos in bitset. 
 | 
void | 
InstancePath.setMountIdGetter(MountIdInterface mountGetter)  | 
static ConfResponse | 
ConfInternal.termRead(Object sock)
Common method to read a term from ConfD/NCS
 NOTE: This method should not be used by users of this API. 
 | 
static ConfResponse | 
ConfInternal.termRead(SelectionKey key)
Common method to read ( request )  a term from ConfD/NCS
 NOTE: This method should not be used by users of this API. 
 | 
static ConfResponse | 
ConfInternal.termRead(SelectionKey key,
        int cdbop)
Read a response, term from ConfD/NCS with the
  given  
SelectionKey and the op cdbop. | 
static ConfResponse | 
ConfInternal.termRead(Socket sock)
Request one term from ConfD/NCS. 
 | 
static ConfResponse | 
ConfInternal.termRead(Socket sock,
        int cdbop)
Request one term from ConfD/NCS. 
 | 
static Document | 
ConfXMLParam.toDOM(ConfXMLParam[] params)
Return String  
DOM document representation of a
 (Conf)XML-structure. | 
static Document | 
ConfXMLParam.toDOM(ConfXMLParam[] params,
     String parentNode,
     String parentURI)
Return String  
DOM representation of a
  (Conf)XML-structure. | 
static String | 
ConfXMLParam.toXML(ConfXMLParam[] params)
Return String XML representation of a (Conf)XML-structure. 
 | 
static String | 
ConfXMLParam.toXML(ConfXMLParam[] params,
     String parentNode,
     String parentURI)
Return String XML representation of a (Conf)XML-structure. 
 | 
static ConfXMLParam[] | 
ConfXMLParam.toXMLParams(String xml,
           ConfPath path)
Converts an xml snippet to a corresponding ConfXMLParam[]. 
 | 
static ConfXMLParam[] | 
ConfXMLParam.toXMLParams(String xml,
           ConfPath path,
           int mode)
Converts an xml snippet to a corresponding ConfXMLParam[]. 
 | 
static ConfHaNode | 
ConfHaNode.unpack_ha_node(ConfEObject term)
Decodes a ConfEObject into a ConfHaNode. 
 | 
| Constructor and Description | 
|---|
ConfBinary(ConfEObject o)  | 
ConfBit32(String str)
String constructor for ConfBit32. 
 | 
ConfBit64(String str)
String constructor for ConfBit64. 
 | 
ConfBitBig(String str)
String constructor for ConfBitBig. 
 | 
ConfBool(String s)  | 
ConfCdbUpgradePath(String fmt,
                  Object... arguments)  | 
ConfDate(ConfEObject o)  | 
ConfDatetime(ConfEObject o)
For internal usage. 
 | 
ConfDecimal64(ConfEObject o)  | 
ConfDottedQuad(byte[] val)  | 
ConfDottedQuad(ConfBinary obj)
Constructs a ConfDottedQuad from a ConfBinary object. 
 | 
ConfDottedQuad(ConfEObject o)  | 
ConfDottedQuad(String str)
Construct a ConfDottedQuad from a string of bytes in the format of octets
 (decimal values) separated with dots. 
 | 
ConfDouble(ConfEObject o)  | 
ConfDuration(ConfEObject o)  | 
ConfEnumeration(ConfEObject o)  | 
ConfEnumeration(int ordinalValue)
Constructor for ordinalvalue. 
 | 
ConfEnumeration(int ordinalValue,
               ArrayList<ConfNamespace> ns_list)
Deprecated.  
 | 
ConfFloat(ConfEObject o)  | 
ConfHexList(String str)
Construct a  
ConfHexList from a string  of bytes in the
 format of hexadecimal values separated with colons. | 
ConfHexString(ConfEObject o)  | 
ConfHexString(String str)
Construct a  
ConfHexString from a string  of bytes in the
 format of hexadecimal values separated with colons. | 
ConfIdentityRef(ConfEObject o)  | 
ConfInt16(ConfEObject o)  | 
ConfInt32(ConfEObject o)  | 
ConfInt64(ConfEObject o)  | 
ConfInt8(ConfEObject o)  | 
ConfIPv4(ConfEObject vtup)  | 
ConfIPv4(ConfETuple vtup)  | 
ConfIPv4(String s)  | 
ConfIPv4AndPrefixLen(ConfEObject v)  | 
ConfIPv4Prefix(ConfEObject v)  | 
ConfIPv6(ConfEObject vtup)  | 
ConfIPv6(ConfETuple vtup)  | 
ConfIPv6AndPrefixLen(ConfEObject v)  | 
ConfIPv6Prefix(ConfEObject v)  | 
ConfKey(ConfEObject o)  | 
ConfList(ConfEObject o)  | 
ConfObjectRef(ConfEObject o)
It assumes that param is of type ConfEList. 
 | 
ConfObjectRef(ConfPath path)
Construct a ConfObjectRef from a given Absolute ConfPath. 
 | 
ConfObjectRef(String xpath)  | 
ConfObjectRef(String xpath,
             MountIdInterface mountGetter)  | 
ConfOctetList(String str)
Construct a ConfOctetList from a string of bytes in the format of octets
 (decimal values) separated with dots. 
 | 
ConfOID(ConfEObject o)  | 
ConfOID(String str)  | 
ConfPath(Cdb cdb,
        String fmt,
        Object... arguments)  | 
ConfPath(ConfEBinary o)
Initialize a ConfPath. 
 | 
ConfPath(Maapi maapi,
        int tid,
        ConfObject[] kp)  | 
ConfPath(Maapi maapi,
        int tid,
        String fmt,
        Object... arguments)  | 
ConfPath(MountIdInterface mountIdCb,
        String fmt,
        Object... arguments)  | 
ConfPath(String fmt,
        Object... arguments)
 Construct a  
ConfPath from a string path representation
 and of optional arguments. | 
ConfQname(ConfEObject o)  | 
ConfTag(ConfEObject o)  | 
ConfTime(ConfEObject o)  | 
ConfUInt16(ConfEObject o)  | 
ConfUInt32(ConfEObject o)  | 
ConfUInt64(ConfEObject o)  | 
ConfUInt8(ConfEObject o)  | 
ConfUserInfo(ConfETuple usess)
Internally used constructor to create a UserInfo record 
 | 
ConfXMLParamCdbStart(ConfEObject o,
                    int cdbInstanceInteger)  | 
ConfXMLParamLeaf(ConfEObject o)  | 
ConfXMLParamStart(ConfEObject o)  | 
ConfXMLParamStartDel(ConfEObject o)  | 
ConfXMLParamStop(ConfEObject o)  | 
ConfXMLParamValue(ConfEObject o)  | 
ConfXMLTagH(ConfEObject o)  | 
ConfXPath(String xpath)  | 
ConfXPath(String xpath,
         MountIdInterface mountGetter)  | 
InstancePath(ConfEBinary o)
Initialize a InstancePath. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DpCallbackException
Exception thrown from inside callbacks to identify problems. 
 | 
class  | 
DpCallbackExtendedException
Extended errorcode Exceptions thrown from inside callbacks to
 identify problems. 
 | 
class  | 
DpCallbackWarningException
Warnings thrown from inside callbacks to identify problems. 
 | 
class  | 
DpException
General Dp Exception 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfException | 
DpException.mk(ConfResponse r)  | 
static ConfException | 
DpCallbackExtendedException.mk(int extendedErrorCode,
  ConfNamespace appNS,
  String appTag,
  ConfResponse r)
Deprecated.  
 | 
| Modifier and Type | Method and Description | 
|---|---|
DpNotifStream | 
Dp.createNotifStream(String name)
Creates (and registers) a notifications stream with ConfD/NCS. 
 | 
DpNotifStream | 
Dp.createNotifStream(String name,
                 DpNotifReplayCallback replayCb)
Creates (and registers) a notifications stream with ConfD/NCS. 
 | 
DpNotifStream | 
Dp.createNotifStream(String name,
                 DpNotifReplayCallback replayCb,
                 Socket socket)
Creates (and registers) a notifications stream with ConfD/NCS. 
 | 
DpSnmpNotifier | 
Dp.createSnmpNotifier(String name,
                  String context_name)
Creates (and registers) a SNMP Notifer @see  
DpSnmpNotifier. | 
DpSnmpNotifier | 
Dp.createSnmpNotifier(String notify_name,
                  String context_name,
                  Object inform_cb)
Creates (and registers) a SNMP Notifier @see  
DpSnmpNotifier. | 
DpSnmpNotifier | 
Dp.createSnmpNotifier(String notify_name,
                  String context_name,
                  Object inform_cb,
                  Socket socket)
Creates (and registers) a SNMP Notifier see  
DpSnmpNotifier. | 
void | 
DpNotifStream.flush()
Notifications are sent asynchronously, i.e. 
 | 
Maapi | 
Dp.getServicePointMaapi()  | 
void | 
Dp.read()
Receives data on the control socket which is connected to ConfD/NCS. 
 | 
void | 
DpNotifStream.send(ConfDatetime time,
    ConfXMLParam params)
Send a notification defined at the top level of a YANG module
 on this notification stream to ConfD/NCS. 
 | 
void | 
DpNotifStream.send(ConfDatetime time,
    ConfXMLParam[] params)
Send a notification defined at the top level of a YANG module
 on this notification stream to ConfD/NCS. 
 | 
void | 
DpNotifStream.send(ConfDatetime time,
    ConfXMLParam[] params,
    ConfPath path)
Send a notification defined as a child of a container or list
 in a YANG 1.1 module on this notification stream to ConfD/NCS. 
 | 
void | 
DpNotifStream.send(ConfDatetime time,
    ConfXMLParam[] params,
    String fmt,
    Object... arguments)
Send a notification defined as a child of a container or list
 in a YANG 1.1 module on this notification stream to ConfD/NCS. 
 | 
void | 
DpSnmpNotifier.send(String notification,
    SnmpVarbind[] varbinds)
Send SNMP notification. 
 | 
void | 
DpSnmpNotifier.send(String notification,
    SnmpVarbind[] varbinds,
    Integer ref)
Send SNMP notification with the option to receive an Inform Response. 
 | 
| Constructor and Description | 
|---|
DpCallbackExtendedException(int extendedErrorCode,
                           ConfNamespace appNS,
                           String appTag,
                           ConfException ex)  | 
| Constructor and Description | 
|---|
Dp(String name,
  Socket socket)
This constructor will initialize the Dp class library and connect to
 ConfD/NCS on the provided control socket. 
 | 
Dp(String name,
  Socket ctrlSocket,
  boolean isNcs)
This constructor will initialize the Dp class library and connect to
 ConfD/NCS on the provided control socket. 
 | 
Dp(String name,
  Socket ctrlSocket,
  boolean isNcs,
  int minThreadPoolSize,
  int maxThreadPoolSize,
  long keepAliveTime,
  TimeUnit unit,
  BlockingQueue<Runnable> queue,
  boolean prestartCoreThreads)
This constructor will initialize the Dp class library and connect to
 ConfD/NCS on the provided control socket. 
 | 
DpUserInfo(ConfETuple usess)
Internally used Constructor. 
 | 
| 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. 
 | 
String | 
ServiceContext.getNedIdByDeviceName(String name)  | 
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()  | 
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. 
 | 
| Constructor and Description | 
|---|
ServiceModificationContextImpl(DpTrans dpTrans,
                              Dp dp,
                              ConfEObject eObject)
Internally used constructor 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HaException
Exception for the HA handling 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
MaapiException
Exception raised from the maapi package 
 | 
class  | 
MaapiMNsException
Warnings raised from the maapi package 
 | 
class  | 
MaapiMNsMissingException
Warnings raised from the maapi package 
 | 
class  | 
MaapiWarningException
Warnings raised from the maapi package 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfException | 
MaapiException.mk(ConfResponse r)  | 
static ConfException | 
MaapiException.mk(ConfResponse r,
  ConfPath path)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
Maapi.aaaReload(boolean synchronous)
When the ConfD/NCS AAA tree is populated by an external data provider,
 this method can be used by the data provider to notify ConfD/NCS when
 there is a change to the AAA data. 
 | 
void | 
Maapi.abortTrans(int tid)
Abort a transaction specified by transaction handle tid. 
 | 
void | 
Maapi.abortUpgrade()
Note, This method is only applicable for Confd. 
 | 
void | 
Maapi.applyTrans(int tid,
          boolean keepOpen)
Apply a current transaction with transaction handle tid. 
 | 
void | 
Maapi.applyTrans(int tid,
          boolean keepOpen,
          int flags)
Apply a current transaction with transaction handle tid
 with additional flags (NCS Specific). 
 | 
ApplyResult | 
Maapi.applyTransParams(int tid,
                boolean keepOpen,
                CommitParams params)
Apply a current transaction with transaction handle tid
 with additional NCS specific parameters. 
 | 
void | 
Maapi.attach(int tid,
      int nsi)
Same as  
Maapi.attach(int, int, int) with the exception
 that the User session id is implicit for the attached transaction. | 
void | 
Maapi.attach(int tid,
      int nsi,
      int usid)
Attach to a current transaction. 
 | 
void | 
Maapi.attach(int tid,
      String ns)
Same as  
Maapi.attach(int, String, int) with the exception
 that the User session id is implicit for the attached transaction. | 
void | 
Maapi.attach(int tid,
      String ns,
      int usid)
Attach to a current transaction. 
 | 
int | 
Maapi.attachInit()
Attach to transaction available in phase0. 
 | 
MaapiAuthentication | 
Maapi.authenticate(String user,
            String passwd)
If we are implementing a proprietary Management Agent with MAAPI API,
 the method  
Maapi.startUserSession(String,InetAddress,String,String[],
 MaapiUserSessionFlag) requires the application to tell ConfD/NCS
 which groups the user are member of. | 
MaapiAuthentication | 
Maapi.authenticate2(String user,
             String passwd,
             InetAddress src_addr,
             int src_port,
             String context,
             MaapiUserSessionFlag proto)
If we are implementing a proprietary Management Agent with MAAPI API, the
 method  
Maapi.startUserSession(String,InetAddress,String,String[],
 MaapiUserSessionFlag) requires the application to tell ConfD/NCS
 which groups the user are member of. | 
void | 
Maapi.candidateAbortCommit()
This function cancels a pending confirmed commit. 
 | 
void | 
Maapi.candidateAbortCommitPersistent(String persistId)
Cancel an ongoing persistent commit with the cookie given by persistId. 
 | 
void | 
Maapi.candidateCommit()
This function copies the candidate to running. 
 | 
void | 
Maapi.candidateCommitInfo(String label,
                   String comment)
This method can be used to set the "Label" and/or "Comment"
 that is stored in the rollback file when the candidate is committed
 to running. 
 | 
void | 
Maapi.candidateCommitInfo(String persistId,
                   String label,
                   String comment)
This method can be used to set the "Label" and/or "Comment"
 that is stored in the rollback file when the candidate is committed
 to running. 
 | 
void | 
Maapi.candidateCommitPersistent(String persistId)
Confirm an ongoing persistent commit with the cookie given by persistId. 
 | 
void | 
Maapi.candidateConfirmedCommit(int t)
This method also copies the candidate into running. 
 | 
void | 
Maapi.candidateConfirmedCommitInfo(int timeoutsecs,
                            String label,
                            String comment)
This method does the same as
  
Maapi.candidateConfirmedCommitPersistent(int, java.lang.String, java.lang.String), but allows for
 setting the "Label" and/or "Comment" that is stored in the
 rollback file when the candidate is committed to running. | 
void | 
Maapi.candidateConfirmedCommitInfo(int timeoutsecs,
                            String persist,
                            String persistId,
                            String label,
                            String comment)
This method does the same as
  
Maapi.candidateConfirmedCommitPersistent(int, java.lang.String, java.lang.String), but allows for
 setting the "Label" and/or "Comment" that is stored in the
 rollback file when the candidate is committed to running. | 
void | 
Maapi.candidateConfirmedCommitPersistent(int timeoutsecs,
                                  String persist,
                                  String persistId)
This method can be used to start or extend a persistent confirmed
 commit, see the Tail-f Commit Capability section in the NETCONF Server
 chapter in the User Guide. 
 | 
void | 
Maapi.candidateReset()
This function copies running into candidate. 
 | 
void | 
Maapi.candidateValidate()
This function validates the candidate. 
 | 
void | 
Maapi.cd(int tid,
  String fmt,
  Object... arguments)
This function mimics the behavior of the UNIX "cd" command. 
 | 
void | 
Maapi.clearOpCache()
Same as  
Maapi.clearOpCache(ConfPath), with the only difference that
 if clears all cached data from "/" and down. | 
void | 
Maapi.clearOpCache(ConfPath path)
Request clearing of the operational data cache (see the Operational Data
 the User Guide). 
 | 
void | 
Maapi.CLIAccounting(String user,
             int usid,
             String cmd)
Generate an audit log entry in the CLI audit log. 
 | 
CLICmdToPathResult | 
Maapi.CLICmdToPath(int th,
            String cmd)
Given a C- or I-style command, this method tries to determine the
 corresponding namespace and path in the schema. 
 | 
CLICmdToPathResult | 
Maapi.CLICmdToPath(String cmd)
Equivalent to  
Maapi.CLICmdToPath(int, String) with the first
 parameter set to -1 (ie, the command is not interpreted in the
 context of any particular transaction) | 
String | 
Maapi.CLIDiffCmd(int thandle,
          int thandleOld,
          ConfPath path)
Get the diff between two transactions as C-/I-style CLI commands. 
 | 
String | 
Maapi.CLIPathCmd(int th,
          EnumSet<CLIPathCmdFlag> flags,
          String fmt,
          Object... args)
Returns a string representing the C/I style CLI command that can be
 associated with the given path. 
 | 
String | 
Maapi.CLIPrompt(int usid,
         String prompt,
         boolean echo)
Prompts user for a string. 
 | 
String | 
Maapi.CLIPrompt(int usid,
         String prompt,
         boolean echo,
         int timeout)
Prompts user for a string. 
 | 
String | 
Maapi.CLIPromptOneOf(int usid,
              String prompt,
              String[] choice)
Prompt user for one of the strings given in the choice parameter. 
 | 
String | 
Maapi.CLIPromptOneOf(int usid,
              String prompt,
              String[] choice,
              int timeout)
Prompt user for one of the strings given in the choice parameter. 
 | 
String | 
Maapi.CLIReadEOF(int usid,
          boolean echo)
Read a multi line string from the CLI. 
 | 
String | 
Maapi.CLIReadEOF(int usid,
          boolean echo,
          int timeout)
Read a multi line string from the CLI. 
 | 
void | 
Maapi.CLIWrite(int usid,
        String buf)
Write to the CLI. 
 | 
void | 
CLIInteraction.cmd(String command)
Execute CLI command in ongoing CLI session. 
 | 
void | 
CLIInteraction.cmd(String command,
   EnumSet<CLIInteractionFlag> flags)
Execute CLI command in ongoing CLI session. 
 | 
void | 
CLIInteraction.cmd(String command,
   EnumSet<CLIInteractionFlag> flags,
   String unhide)
Execute CLI command in ongoing CLI session. 
 | 
MaapiInputStream | 
CLIInteraction.cmdIO(String command,
     EnumSet<CLIInteractionFlag> flags,
     String unhide)
Execute CLI command in ongoing CLI session and output result on socket. 
 | 
CommitQueueResult | 
Maapi.commitQueueResult(int tid,
                 int timeout)
Deprecated. 
 
Use
  
Maapi.applyTransParams(int, boolean, CommitParams) instead.
 This method must be called if applyTrans() or prepareTrans() was
 called, and one of the flags Maapi.COMMIT_NCS_COMMIT_QUEUE_ASYNC or
 Maapi.COMMIT_NCS_COMMIT_QUEUE_SYNC was set, and must not be called
 otherwise.
 If the transaction did not result in a commit queue entry (e.g.,
 it didn't involve any devices) the function returns a
 CommitQueueResult with its status set to NCS_COMMIT_QUEUE_NONE.
 Otherwise, if Maapi.COMMIT_NCS_COMMIT_QUEUE_ASYNC was set, the
 function returns a CommitQueueResult with its status set to
 NCS_COMMIT_QUEUE_ASYNC, and its queue_id set to the commit queue id.
 Otherwise, if Maapi.COMMIT_NCS_COMMIT_QUEUE_SYNC was set, the
 function waits at most timeout seconds for the commit queue
 item to be sent to the devices.  If the result was successful,
 it returns a CommitQueueResult with its status set to
 NCS_COMMIT_QUEUE_SYNC.  If the timer expires, it returns a
 CommitQueueResult with its status set to
 NCS_COMMIT_QUEUE_TIMEOUT, and its queue_id set to the commit
 queue id.  If the result was unsuccessful, an exception is raised.
 If any of the devices in the queue item returns an error
 the status is set to NCS_COMMIT_QUEUE_FAILED. If the queue item
 is deleted before execution the status is set to
 NCS_COMMIT_QUEUE_DELETED. | 
void | 
Maapi.commitTrans(int tid)
Commit a transaction specified by transaction handle tid. 
 | 
void | 
Maapi.commitUpgrade()
Note, This method is only applicable for Confd. 
 | 
int | 
Maapi.confirmedCommitInProgress()
Checks whether a confirmed commit is pending. 
 | 
void | 
Maapi.copy_tree(int tid,
         boolean useSharedCreate,
         ConfPath from,
         ConfPath to)
Deprecated. 
 
Use
  
Maapi.copyTree(int, boolean, ConfPath, ConfPath) instead. | 
void | 
Maapi.copy_tree(int tid,
         ConfPath from,
         ConfPath to)
Deprecated. 
 
Use  
Maapi.copyTree(int, ConfPath, ConfPath) instead. | 
void | 
Maapi.copy(int thfrom,
    int thto)
If we open two transactions from the same user sessions but towards
 different data stores, such as one transaction towards the candidate and
 one towards running, we can copy all data from one data store to the
 other with this method. 
 | 
void | 
Maapi.copyPath(int fromTh,
        int toTh,
        ConfPath path)
Similar to  
Maapi.copy(int, int), but does a replacing copy only
 of the subtree rooted at the path given by path | 
void | 
Maapi.copyRunningToStartup()
Copies running to startup. 
 | 
void | 
Maapi.copyTree(int tid,
        boolean useSharedCreate,
        ConfPath from,
        ConfPath to)
This function is used to copy an entire subtree in the configuration from
 one point to another. 
 | 
void | 
Maapi.copyTree(int tid,
        ConfPath from,
        ConfPath to)
Equivalent to  
Maapi#copyTree(int, false, ConfPath, ConfPath)
 ie., for use outside fastmap, without 'shared' create/set | 
void | 
Maapi.create(int tid,
      ConfPath path)
Create an entity in the XML tree. 
 | 
void | 
Maapi.create(int tid,
      String fmt,
      Object... arguments)
Create a new list entry in the XML tree. 
 | 
void | 
Maapi.delete(int tid,
      ConfPath path)
Deletes a node and all its children from the XML data tree. 
 | 
void | 
Maapi.delete(int tid,
      String fmt,
      Object... arguments)
Deletes a node and all its children from the XML data tree. 
 | 
void | 
Maapi.deleteAll(int th,
         MaapiDeleteAllFlag how)
This function can be used to delete "all" configuration data within
 a transaction. 
 | 
void | 
Maapi.deleteConfig(int db)
This function empties a data store. 
 | 
ConfObject[][] | 
Maapi.deref(int tid,
     String fmt,
     Object... arguments)
This method dereferences a leafref and returns a list of the objects the
 leafref "points" to. 
 | 
void | 
Maapi.detach(int tid)
Detaches an attached MAAPI socket. 
 | 
void | 
Maapi.diffIterate(int tid,
           MaapiDiffIterate iter)
Iterates through the transaction diff. 
 | 
void | 
Maapi.diffIterate(int tid,
           MaapiDiffIterate iter,
           Object initstate,
           String fmt,
           Object... args)
Iterates through the transaction diff. 
 | 
void | 
Maapi.diffIterate(int tid,
           MaapiDiffIterate iter,
           String fmt,
           Object... args)
Iterates through the transaction diff. 
 | 
void | 
Maapi.diffIterate(int tid,
           Object initstate,
           EnumSet<DiffIterateFlags> flags,
           MaapiDiffIterate iter,
           ConfPath path)
Iterates through the transaction diff. 
 | 
void | 
Maapi.disconnectRemote(String address)
Disconnect all remote connections between CONFD_IPC_PORT (see the IPC
 section in the Advanced Topics chapter in the User Guide) and address. 
 | 
void | 
Maapi.disconnectSockets(int[] sockets)
This function is an alternative to  
disconnectRemote()
 that can be useful in particular when using the "External IPC"
 functionality (see "Using a different IPC mechanism" in the ConfD IPC
 section in the Advanced Topics chapter in the User Guide). | 
boolean | 
Maapi.doDisplay(int tid,
         String fmt,
         Object... args)
If the data model uses the YANG 'when' or 'tailf:display-when'
 statement, this function can be used to determine if the item
 given by the path in fmt should be displayed or not. 
 | 
void | 
Maapi.endUserSession()
Ends the current user session on this  
Maapi instance. | 
boolean | 
Maapi.exists(int tid,
      ConfPath path)
Boolean function which return 1 or 0 if a path defines an existing
 element in the XML data tree. 
 | 
boolean | 
Maapi.exists(int tid,
      String fmt,
      Object... arguments)  | 
ConfKey | 
Maapi.findNext(MaapiCursor c,
        ConfFindNextType type,
        ConfKey key)
The findNext method makes it possible to jump forward to an element
 in the model at a position defined by the MaapiCursor
 After the findNext call the same MaapiCursor can be used in subsequent
 getNext calls. 
 | 
void | 
Maapi.finishTrans(int tid)
Finish the transaction specified by transaction handle tid. 
 | 
String | 
CLIInteraction.get(String parameter)
Read CLI session parameter. 
 | 
ConfAttributeValue[] | 
Maapi.getAttrs(int tid,
        ConfAttributeType[] attribs,
        String fmt,
        Object... args)
Retrieve attributes for a configuration node. 
 | 
String[] | 
Maapi.getAuthorizationInfo(int usid)
This method retrieves authorization info for a user session, i.e. 
 | 
ConfTag | 
Maapi.getCase(int tid,
       String choice,
       ConfPath path)  | 
ConfTag | 
Maapi.getCase(int tid,
       String choice,
       String fmt,
       Object... arguments)
This returns the current 'case' for a 'choice' construct. 
 | 
String | 
Maapi.getCwd(int tid)
Returns the current position as previously set by Maapi.cd(),
 Maapi.pushd(), or Maapi.popd() as a String. 
 | 
ConfPath | 
Maapi.getCwdPath(int tid)
Returns the current position like Maapi.getCwd(), but as a ConfPath
 instead of as a String. 
 | 
ConfValue | 
Maapi.getElem(int tid,
       ConfPath path)  | 
ConfValue | 
Maapi.getElem(int tid,
       String fmt,
       Object... arguments)
This reads a value from the path in fmt and returns the result. 
 | 
List<String> | 
MountIdCb.getMountId(ConfPath path)  | 
List<String> | 
Maapi.getMountId(int tid,
          ConfPath path)  | 
List<String> | 
MaapiSchemas.getMountId(MountIdInterface midif,
          ConfPath path)  | 
int | 
Maapi.getMyUserSession()
Returns the usid associated with this  
Maapi | 
ConfKey | 
Maapi.getNext(MaapiCursor c)
Iterates and gets the keys for the next element pinpointed by the
  
MaapiCursor initially retrieved by
 Maapi.newCursor(int, String, Object...). | 
int | 
Maapi.getNumberOfInstances(int tid,
                    ConfPath path)  | 
int | 
Maapi.getNumberOfInstances(int tid,
                    String fmt,
                    Object... arguments)
Return the number of instances in a list. 
 | 
ConfObject[] | 
Maapi.getObject(int tid,
         String fmt,
         Object... arguments)
This reads a container object or a list entry object from the path in fmt
 and returns the result. 
 | 
List<ConfObject[]> | 
Maapi.getObjects(MaapiCursor c,
          int numOfObjects,
          int numOfInstances)
Get several list instances with one request. 
 | 
int | 
Maapi.getRollbackId(int tid)
Get rollback id for committed transaction specified by
 transaction handle tid. 
 | 
int | 
Maapi.getRunningDbStatus()
Query ConfD/NCS for its consistency state. 
 | 
CommitParams | 
Maapi.getTransParams(int tid)
Get commit parameters for a transaction. 
 | 
MaapiUserSession | 
Maapi.getUserSession(int usid)
Return a  
MaapiUserSession given by the usid. | 
MaapiUserSessionId | 
Maapi.getUserSessionIdentification(int usid)
This method can be used to retrieve additional identification
 information for a user session (if available - ie., if it has been
 provided by the northbound client). 
 | 
String | 
Maapi.getUserSessionOpaque(int usid)
If the user session has "opaque" information provided by the
 northbound client (see the -O option in  
confd_cli),
 the opaque information can be retrieved using this method. | 
int[] | 
Maapi.getUserSessions()
Return all user sessions id's currently connected to ConfD/NCS. 
 | 
<T extends ConfXMLParam> | 
Maapi.getValues(int tid,
         T[] params,
         ConfPath path)
Read an arbitrary set of sub-elements of a container element. 
 | 
<T extends ConfXMLParam> | 
Maapi.getValues(int tid,
         T[] params,
         String fmt,
         Object... arguments)
Read an arbitrary set of sub-elements of a container element. 
 | 
<T extends List<ConfXMLParam>> | 
Maapi.getValues(int tid,
         T params,
         ConfPath path)
Read an arbitrary set of sub-elements of a container element. 
 | 
<T extends List<ConfXMLParam>> | 
Maapi.getValues(int tid,
         T params,
         String fmt,
         Object... arguments)
Read an arbitrary set of sub-elements of a container element. 
 | 
void | 
Maapi.initUpgrade(int timeoutsecs,
           int flags)
Note, This method is only applicable for Confd. 
 | 
void | 
Maapi.insert(int tid,
      boolean createBackPointer,
      String fmt,
      Object... arguments)
This function inserts a new element in an ordered list of elements. 
 | 
void | 
Maapi.insert(int tid,
      String fmt,
      Object... arguments)  | 
boolean | 
Maapi.isCandidateModified()
Returns true if candidate has been modified, i.e if there are pending non
 committed changes to the candidate data store. 
 | 
int | 
Maapi.isLockSet(int db)
This methods checks if a lock is taken or not. 
 | 
boolean | 
Maapi.isRunningModified()
Returns true if running has been modified since the last copy to startup,
 false if it has not been modified. 
 | 
void | 
Maapi.iterate(int tid,
       Object initstate,
       EnumSet<ConfIterateFlags> flags,
       MaapiIterate iter,
       ConfPath path)
Iterates through all the data in a transaction. 
 | 
void | 
Maapi.killUserSession(int usid)
Ends another users session, effectively logging out that user. 
 | 
MaapiRollback[] | 
Maapi.listRollback()
Get list of available rollback files. 
 | 
void | 
Maapi.loadConfig(int tid,
          EnumSet<MaapiConfigFlag> flags,
          String filename)
This function loads a configuration from filename into the server. 
 | 
void | 
Maapi.loadConfigCmds(int tid,
              EnumSet<MaapiConfigFlag> flags,
              String cmds,
              String fmt,
              Object... arguments)
This function loads a configuration from a string into the server. 
 | 
MaapiOutputStream | 
Maapi.loadConfigStream(int tid,
                EnumSet<MaapiConfigFlag> flags)
Load configuration from a  
OuputStream  into ConfD/NCS. | 
void | 
Maapi.loadRollback(int tid,
            int nr)
Load rollback file into a given transaction. 
 | 
void | 
Maapi.loadRollbackFixed(int tid,
                 int fixed_nr)
Load rollback file into a given transaction using the fixed
 number. 
 | 
MaapiSchemas | 
Maapi.loadSchemas()
Load Schemas method that downloads all schemas from server into a
 MaapiSchemas container, from which specified schemas can be accessed and
 traversed. 
 | 
MaapiSchemas | 
Maapi.loadSchemas(String[] namespaceURIs)
Load Schemas method that downloads a specified number of schemas
 the server into a MaapiSchemas container, from which specified schemas
 can be accessed and transversed. 
 | 
void | 
Maapi.lock(int db)
This function is used to take a lock on one of the databases. 
 | 
int | 
Maapi.lockPartial(int db,
           String xpath)
Same as  
Maapi.lockPartial(int,String[]) except only one xpath
 expression is given. | 
int | 
Maapi.lockPartial(int db,
           String[] xpaths)
It is possible to manipulate partial locks on the databases, i.e. 
 | 
void | 
Maapi.move(int tid,
    ConfKey tokey,
    String fmt,
    Object... arguments)
This function moves an existing object. 
 | 
void | 
Maapi.move(int tid,
    String tokey,
    String fmt,
    Object... arguments)
This function moves an existing object 
 | 
void | 
Maapi.moveOrdered(int tid,
           MoveWhereFlag where,
           ConfKey tokey,
           String fmt,
           Object... arguments)
For a list with the YANG ordered-by user statement, this function can be
 used to change the order of entries, by moving one entry to a new
 position. 
 | 
void | 
Maapi.ncsApplyTemplate(int tid,
                String template,
                ConfPath rootIKP,
                Properties variables,
                boolean createShared,
                boolean createBackpointer)  | 
void | 
Maapi.ncsApplyTemplate(int tid,
                String template,
                ConfPath rootIKP,
                Properties variables,
                String document,
                boolean createShared,
                boolean createBackpointer)  | 
String[] | 
Maapi.ncsGetTemplateVariables(String template)  | 
void | 
Maapi.ncsMovePrivateData(int initTid,
                  ConfPath from,
                  ConfPath to)
Used in service data migrations, after config data has been moved in
 the data upgrade, also the service ncs specific private data has to be
 moved. 
 | 
Set<String> | 
Maapi.ncsTemplates()  | 
void | 
Maapi.netconfSSHCallHome(ConfObject host,
                  int port)
Request that ConfD daemon initiates a NETCONF SSH Call Home
 connection (see RFC 8071) to the NETCONF client running on
 host. 
 | 
void | 
Maapi.netconfSSHCallHomeOpaque(ConfObject host,
                        String opaque,
                        int port)
Request that ConfD daemon initiates a NETCONF SSH Call Home
 connection (see RFC 8071) to the NETCONF client running on
 host. 
 | 
MaapiCursor | 
Maapi.newCursor(int tid,
         ConfPath path)
 Creates a cursor for a list specified by  
path | 
MaapiCursor | 
Maapi.newCursor(int tid,
         String fmt,
         Object... arguments)
 Creates a cursor for a list specified by  
fmt. | 
MaapiCursor | 
Maapi.newCursorWithFilter(int tid,
                   String filter,
                   ConfPath path)
 Creates a cursor for a list specified by  
path with an XPath
 filter specified by filter. | 
MaapiCursor | 
Maapi.newCursorWithFilter(int tid,
                   String filter,
                   String fmt,
                   Object... arguments)
 Creates a cursor for a list specified by  
fmt with an XPath
 filter specified by filter. | 
void | 
Maapi.performUpgrade(String[] loadpathdirs)
Note, This method is only applicable for Confd. 
 | 
void | 
Maapi.popd(int tid)
Pops the top position of the directory stack and changes directory 
 | 
void | 
Maapi.prepareTrans(int tid)
Prepares the transaction specified by transaction handle tid. 
 | 
void | 
Maapi.prepareTrans(int tid,
            int flags)
Prepares the transaction specified by transaction handle tid. 
 | 
void | 
CLIInteraction.printf(String fmt,
      Object... arguments)
Write to the CLI using printf formatting. 
 | 
void | 
Maapi.prioMessage(String to,
           String message)
Send a high priority message to a specific user, a specific user session
 or all users depending on the to parameter. 
 | 
String | 
CLIInteraction.prompt(String promptStr,
      boolean echo)
Prompt user for a string. 
 | 
String | 
CLIInteraction.prompt(String promptStr,
      boolean echo,
      int timeout)
This function does the same as prompt(String promptStr), but also takes a
 timeout parameter, which controls how long (in seconds) to wait for input
 before aborting. 
 | 
String | 
CLIInteraction.promptOneOf(String promptStr,
           String[] choice,
           boolean echo)
Prompt user for one of the strings given in the choice parameter. 
 | 
String | 
CLIInteraction.promptOneOf(String promptStr,
           String[] choice,
           boolean echo,
           int timeout)
This function does the same as promptOneOf(String promptStr, String[]
 choice, boolean echo), but also takes a timeout parameter. 
 | 
void | 
Maapi.pushd(int tid,
     String fmt,
     Object... arguments)
Behaves like cd() with the exception that we can subsequently call popd()
 and return to the previous position in the XML data tree. 
 | 
<T extends ResultType> | 
Maapi.queryStart(int tid,
          String expr,
          String context,
          int chunkSize,
          int offset,
          List<String> select,
          Class<T> cls)
Initiate (or starts) a new XPath query attached to the
 transaction given in  
tid. | 
<T extends ResultType> | 
Maapi.queryStart(int tid,
          String expr,
          String context,
          int chunkSize,
          int offset,
          List<String> select,
          List<String> sort,
          boolean reverseSortOrder,
          Class<T> cls)
Initiate (or starts) a new XPath query attached to the
 transaction given in  
th. | 
String | 
CLIInteraction.readEOF(boolean echo)
Read a multi line string from the CLI. 
 | 
String | 
CLIInteraction.readEOF(boolean echo,
       int timeout)
This function does the same as readEOF(boolean echo), but also takes a
 timeout parameter, which indicates how long the user may be idle (in
 seconds) before the reading is aborted. 
 | 
void | 
Maapi.reloadConfig()
Request that the daemon reloads its configuration files. 
 | 
MaapiSchemas | 
Maapi.reloadSchemas()
This method throws away any old MaapiSchemas container and downloads a
 new from the server. 
 | 
MaapiSchemas | 
Maapi.reloadSchemas(String[] namespaceURIs)
This method throws away any old MaapiSchemas container and downloads a
 new from the server. 
 | 
void | 
Maapi.reopenLogs()
Request that the daemon closes and re-opens its log files 
 | 
void | 
Maapi.reportProgress(int tid,
              Maapi.Verbosity verbosity,
              String msg)
Report progress of an action or transaction. 
 | 
void | 
Maapi.reportProgress(int tid,
              Maapi.Verbosity verbosity,
              String msg,
              String packageName)
Report progress of an action or transaction. 
 | 
Maapi.Progress | 
Maapi.reportProgressStart(int tid,
                   Maapi.Verbosity verbosity,
                   String msg,
                   String packageName)
Report progress of an action or transaction. 
 | 
void | 
Maapi.reportProgressStop(Maapi.Progress progress)
Report progress of an action or transaction. 
 | 
void | 
Maapi.reportProgressStop(Maapi.Progress progress,
                  String annotation)
Report progress of an action or transaction. 
 | 
void | 
Maapi.reportServiceProgress(int tid,
                     Maapi.Verbosity verbosity,
                     String msg,
                     String packageName,
                     ConfPath servicePath)
Report transaction progress events for a FASTMAP service. 
 | 
Maapi.Progress | 
Maapi.reportServiceProgressStart(int tid,
                          Maapi.Verbosity verbosity,
                          String msg,
                          String packageName,
                          ConfPath servicePath)
Report transaction progress events for a FASTMAP service. 
 | 
void | 
Maapi.reportServiceProgressStop(Maapi.Progress progress)
Report transaction progress events for a FASTMAP service. 
 | 
void | 
Maapi.reportServiceProgressStop(Maapi.Progress progress,
                         String annotation)
Report transaction progress events for a FASTMAP service. 
 | 
ConfXMLParam[] | 
Maapi.requestAction(ConfXMLParam[] params,
             int nshash,
             String fmt,
             Object... arguments)
Same as  
Maapi.requestAction(ConfXMLParam[], String, Object...)
 Since actions are not associated with transactions, the
 namespace hash nshash must be provided and the path
 to the action, i.e. | 
ConfXMLParam[] | 
Maapi.requestAction(ConfXMLParam[] params,
             String fmt,
             Object... arguments)
Invokes an action defined in the data model annotated with
  
tailf:action (see tailf_yang_extensions(5)). | 
ConfXMLParam[] | 
Maapi.requestAction(List<ConfXMLParam> params,
             int nshash,
             String fmt,
             Object... arguments)  | 
ConfXMLParam[] | 
Maapi.requestAction(List<ConfXMLParam> params,
             String fmt,
             Object... arguments)
Same as  
Maapi.requestAction(ConfXMLParam[], String, Object...)
 with the difference that the params is List
 instead of ConfXMLParam array. | 
ConfXMLParam[] | 
Maapi.requestActionTh(int tid,
               ConfXMLParam[] params,
               String fmt,
               Object... arguments)
Same as  
Maapi.requestAction(ConfXMLParam[], String, Object...)
 with the difference that the fmt is not required to have a namespace
 prefix in the root tag. | 
ConfXMLParam[] | 
Maapi.requestActionTh(int tid,
               List<ConfXMLParam> params,
               String fmt,
               Object... arguments)  | 
void | 
QueryResult.reset()
Reset/Rewind a running query so that it starts from the
 beginning again. 
 | 
void | 
QueryResult.reset(int offset)
Reset/Rewind a running query to a specific offset. 
 | 
long | 
QueryResult.resultCount()
Get number of elements in the result. 
 | 
void | 
Maapi.revert(int tid)
Remove all changes in the transaction. 
 | 
void | 
Maapi.safeCreate(int tid,
          ConfPath path)
Create a new list entity in the XML tree. 
 | 
void | 
Maapi.safeCreate(int tid,
          String fmt,
          Object... arguments)
Create a new entity in the XML tree. 
 | 
void | 
Maapi.safeDelete(int tid,
          String fmt,
          Object... arguments)
Deletes a node and all its children from the XML data tree. 
 | 
ConfValue | 
Maapi.safeGetElem(int tid,
           ConfPath path)
 Reads a value from the  
path specified | 
ConfValue | 
Maapi.safeGetElem(int tid,
           String fmt,
           Object... arguments)
This reads a value from the path in fmt and returns the result. 
 | 
ConfObject[] | 
Maapi.safeGetObject(int tid,
             String fmt,
             Object... arguments)
This is a variant of getObject() that returns null if the object doesn't
 exist 
 | 
MaapiInputStream | 
Maapi.saveConfig(int tid,
          EnumSet<MaapiConfigFlag> flags)
Save the entire config in different formats. 
 | 
MaapiInputStream | 
Maapi.saveConfig(int tid,
          EnumSet<MaapiConfigFlag> flags,
          ConfPath path)
Save the subtree in different formats. 
 | 
MaapiInputStream | 
Maapi.saveConfig(int tid,
          EnumSet<MaapiConfigFlag> flags,
          String fmt,
          Object... args)
Save the subtree in different formats, with ability to XPath Filtering. 
 | 
void | 
CLIInteraction.set(String parameter,
   String value)
Set CLI session parameter. 
 | 
void | 
Maapi.setAttr(int tid,
       ConfAttributeValue attr,
       String fmt,
       Object... args)
Set an attribute for a configuration node. 
 | 
void | 
Maapi.setComment(int tid,
          String comment)
Set the "Comment" that is stored in the rollback file when a
 transaction towards running is committed. 
 | 
boolean | 
Maapi.setDelayedWhen(int tid,
              boolean on)
This function enables/disables the "delayed when" mode of a transaction. 
 | 
void | 
Maapi.setElem(int tid,
       ConfObject value,
       ConfPath path)
Set value to a leaf node. 
 | 
void | 
Maapi.setElem(int tid,
       ConfObject value,
       String fmt,
       Object... arguments)
Set value to a leaf node. 
 | 
void | 
Maapi.setElem(int tid,
       String value,
       ConfPath path)
Set value to a leaf node. 
 | 
void | 
Maapi.setElem(int tid,
       String value,
       String fmt,
       Object... arguments)
Set value to a leaf node. 
 | 
void | 
Maapi.setFlags(int tid,
        EnumSet<MaapiFlag> flags)
This method can modify some aspects of the read/write session, see
 MaapiFlag The flags are an Enumset of  
MaapiFlag | 
void | 
Maapi.setLabel(int tid,
        String label)
Set the "Label" that is stored in the rollback file when a
 transaction towards running is committed. 
 | 
void | 
Maapi.setNamespace(int tid,
            int nsid)  | 
void | 
Maapi.setNamespace(int tid,
            String ns)
Before can invoke any of read or write functions, we must indicate which
 namespace we are going to use. 
 | 
void | 
Maapi.setNextUserSessionId(int usid)
Set the user session id that will be assigned to the next user session
 started. 
 | 
void | 
Maapi.setObject(int tid,
         ConfObject[] values,
         String fmt,
         Object... arguments)
This writes a container object or a list entry object from the path in
 fmt and returns the result. 
 | 
void | 
Maapi.setReadOnlyMode(boolean flag)
Control if the node should accept write transactions 
 | 
void | 
Maapi.setRunningDbStatus(int status)
Explicitly sets the systems notion of the consistency
 state. 
 | 
void | 
Maapi.setUserSession(int usid)
Associate this Maapi instance with an already existing user session. 
 | 
void | 
Maapi.setValues(int tid,
         ConfXMLParam[] params,
         ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation. 
 | 
void | 
Maapi.setValues(int tid,
         ConfXMLParam[] params,
         String fmt,
         Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation. 
 | 
void | 
Maapi.setValues(int tid,
         List<ConfXMLParam> params,
         ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation. 
 | 
void | 
Maapi.setValues(int tid,
         List<ConfXMLParam> params,
         String fmt,
         Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation. 
 | 
void | 
Maapi.sharedCreate(int tid,
            boolean createBackpointer,
            ConfPath path)
Deprecated. 
 
 | 
void | 
Maapi.sharedCreate(int tid,
            ConfPath path)  | 
void | 
Maapi.sharedCreate(int tid,
            String fmt,
            Object... arguments)  | 
void | 
Maapi.sharedSetElem(int tid,
             ConfObject value,
             ConfPath path)
Set value to a leaf node from NCS FastMap code. 
 | 
void | 
Maapi.sharedSetElem(int tid,
             ConfObject value,
             String fmt,
             Object... arguments)
Set value to a leaf node from NCS FastMap code
 This method is the equivalent of setElem() except that it
 can only be called from NCS FastMap service code. 
 | 
void | 
Maapi.sharedSetElem(int tid,
             String value,
             String fmt,
             Object... arguments)
Set value to a leaf node from NCS FastMap code. 
 | 
void | 
Maapi.sharedSetValues(int tid,
               ConfXMLParam[] params,
               boolean createBackpointer,
               ConfPath path)
 | 
void | 
Maapi.sharedSetValues(int tid,
               ConfXMLParam[] params,
               ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation
 from NCS FastMap code. 
 | 
void | 
Maapi.sharedSetValues(int tid,
               ConfXMLParam[] params,
               String fmt,
               Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation
 from NCS FastMap code. 
 | 
void | 
Maapi.sharedSetValues(int tid,
               List<ConfXMLParam> params,
               ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation
 from NCS FastMap code. 
 | 
void | 
Maapi.sharedSetValues(int tid,
               List<ConfXMLParam> params,
               String fmt,
               Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation
 from NCS FastMap code. 
 | 
void | 
Maapi.snmpaReload(boolean synchronous)
When the ConfD/NCS SNMP Agent config tree is implemented by an external
 data provider, this method can be used by the data provider to notify
 ConfD/NCS when there is a change to the data. 
 | 
void | 
Maapi.snmpSendNotification(String notifName,
                    String notifyTarget,
                    String ctxName,
                    SnmpVarbind[] varbinds)
Send SNMP notification. 
 | 
void | 
Maapi.startPhase(int phase)
Once the ConfD/NCS daemon has been started in phase0 it is possible to
 use this function to tell the daemon to proceed to startPhase 1 or 2. 
 | 
void | 
Maapi.startPhase(int phase,
          boolean synchronous)
Once the ConfD/NCS daemon has been started in phase0 it is possible to
 use this function to tell the daemon to proceed to start phase 1 or 2. 
 | 
int | 
Maapi.startTrans(int dbname,
          int mode)
Start a new transaction towards the specified database
  
dbname with a transaction mode mode. | 
int | 
Maapi.startTrans(int dbname,
          int mode,
          String vendor,
          String product,
          String version,
          String clientId)  | 
int | 
Maapi.startTrans2(int dbname,
           int mode,
           int usid)
Start a new transaction towards database within an existing
 user session specified by  
usid. | 
int | 
Maapi.startTransFlags(int dbname,
               int mode,
               int usid,
               EnumSet<MaapiFlag> flags)
Start a new transaction towards the specified database
  
dbname with a transaction mode mode with
 additional flags to control read/write sessions. | 
int | 
Maapi.startTransInTrans(int mode,
                 int usid,
                 int tid)
Start a new transaction within an existing user session and another
 transaction as backend 
 | 
void | 
Maapi.startUserSession(String user,
                InetAddress srcip,
                String context,
                String[] groups,
                MaapiUserSessionFlag proto)
Establish a new user session on this  
Maapi instance. | 
void | 
Maapi.startUserSession(String user,
                InetAddress srcip,
                String context,
                String[] groups,
                MaapiUserSessionFlag proto,
                String vendor,
                String product,
                String version,
                String clientId)  | 
void | 
QueryResult.stop()
 Stops the running query and makes the server end
 free up any internal resources associated with the query. 
 | 
void | 
Maapi.stop()
Requests that the daemon stops, returns when daemon has stopped. 
 | 
void | 
Maapi.stop(boolean synchronous)
Stops the daemon. 
 | 
void | 
Maapi.sysMessage(String to,
          String message)
Send a message to a specific user, a specific user session or all users
 depending on the to parameter. 
 | 
void | 
Maapi.unlock(int db)
This function releases a lock previously acquired using the lock()
 method. 
 | 
void | 
Maapi.unlockPartial(int lockId)
This methods releases a lock previously acquired using the lockPartial()
 method. 
 | 
void | 
Maapi.userMessage(String to,
           String message,
           String sender)
Send a message to a specific user, a specific user session or all users
 depending on the to parameter. 
 | 
String[] | 
Maapi.validateToken(String token,
             InetAddress srcAddr,
             int srcPort,
             String context,
             MaapiUserSessionFlag proto)
If external token validation (see /confdConfig/aaa/externalValidation)
 is in use, this method can be used to ask ConfD/NSO to validate such
 a token. 
 | 
void | 
Maapi.validateTrans(int tid,
             boolean unlock,
             boolean force)
Validates a transaction specified by transaction handle tid 
 | 
void | 
Maapi.waitStart(int phase)
Wait until the daemon has completed a certain start phase. 
 | 
void | 
Maapi.waitStarted()
Wait until the daemon is fully started, i.e. 
 | 
void | 
CLIInteraction.write(String str)
Write to the CLI. 
 | 
ConfPath | 
Maapi.xpath2kpath_th(int tid,
              String xpath)  | 
ConfPath | 
Maapi.xpath2kpath(String xpath)
Convert a XPath path to a ConfPath object. 
 | 
void | 
Maapi.xpathEval(int tid,
         MaapiXPathEvalResult xpatheval,
         MaapiXPathEvalTrace xpathtrace,
         String expr,
         Object initstate,
         String fmt,
         Object... arguments)
 Evaluated the xpath expression as supplied in by
  
expr. | 
String | 
Maapi.xpathEvalExpr(int tid,
             String expr,
             MaapiXPathEvalTrace xpathtrace,
             String fmt,
             Object... arg)
Evaluate the xpath expression given in  
expr parameter
 and return the result as a string. | 
| Constructor and Description | 
|---|
ApplyResult(ConfResponse result)  | 
CommitQueueResult(ConfResponse result)  | 
CommitQueueResult(long queue_id,
                 long status)
Deprecated. 
 
Use  
CommitQueueResult(ConfResponse) instead. | 
DryRunResult(ConfResponse result)  | 
Maapi(Socket socket)
Creates a new instance of  
Maapi supplying a established
 open socket to ConfD/NCS daemon. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
IllegalParentNavuNodeException  | 
class  | 
NavuException
Exception raised from the navu package 
 | 
class  | 
NoSuchNavuCaseException  | 
class  | 
NoSuchNavuChoiceException  | 
class  | 
NoSuchNavuNodeException  | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfException | 
NavuException.mk(ConfResponse r)  | 
| Modifier and Type | Method and Description | 
|---|---|
static NavuNode | 
KeyPath2NavuNode.getNode(ConfObject[] kp,
       NavuContext ctx)  | 
static NavuNode | 
KeyPath2NavuNode.getNode(ConfPath path,
       NavuContext ctx)  | 
CdbSession | 
NavuCdbSessionPoolable.getSession(Cdb rootCdb,
          CdbDBType dbType,
          EnumSet<CdbLockType> locks)
Returns a Cdb session to  
dbType datastore with
 the locks locks associated with the given Cdb. | 
NavuContainer | 
NavuNode.namespace(String ns)
The namespace specified here will be used when selecting a child
 to this NavuContainer and returns a reference to this NavuContainer
 object according to the given namespace id  
ns. | 
NavuContainer | 
NavuContainer.namespace(String ns)
The namespace specified here will be used when selecting a child
 to this NavuContainer and returns a reference to this NavuContainer
 object according to the given namespace id  
ns. | 
void | 
NavuCdbSessionPoolable.removeAllForCdb(Cdb rootCdb)
Removes or closes all CdbSession associated with the supplied Cdb. 
 | 
void | 
NavuCdbSessionPoolable.removeAllSessions()
Removes all established session held by any Cdb. 
 | 
| Constructor and Description | 
|---|
NavuException(ConfException e)  | 
NavuException(String msg,
             ConfException e)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
NcsException
Ncs package generic exception 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Cdb | 
ResourceManager.getCdbResource(Object object,
              ResourceType cdbType,
              Scope scope)  | 
static Cdb | 
ResourceManager.getCdbResource(Object object,
              ResourceType cdbType,
              Scope scope,
              String qualifier)  | 
static Maapi | 
ResourceManager.getMaapiResource(Object object,
                Scope scope)  | 
static Maapi | 
ResourceManager.getMaapiResource(Object object,
                Scope scope,
                String qualifier)  | 
static void | 
ResourceManager.registerResources(Object annotatedObject)
This method will inject resources into annotated fields of
 the object instances passed as argument 
 | 
| Constructor and Description | 
|---|
NavuEventHandler(InetSocketAddress addr,
                String notifSubscriberName)
Create an instance of the NavuEventHandler with a
 InetSocketAddress to NCS host and IPC port. 
 | 
NavuEventHandler(Socket socket,
                String notifSubscriberName)
Deprecated.  
 | 
NavuEventHandler(String host,
                int port,
                String notifSubscriberName)
Create an instance of the NavuEventHandler with a
 specified host and port. 
 | 
NcsDp(String name,
     Socket ctrlSocket,
     int queueSize)  | 
| Constructor and Description | 
|---|
AlarmAttribute(ConfNamespace ns,
              String attributeId,
              ConfValue value)  | 
ManagedObject(ConfPath value)
Creates a ManagedObject as a ConfObjectRef defined from a ConfPath. 
 | 
StatusChangeAttribute(ConfNamespace ns,
                     String attributeId,
                     ConfValue value)  | 
| Modifier and Type | Method and Description | 
|---|---|
static AlarmSourceCentral | 
AlarmSourceCentral.getAlarmSource(int alarmQueueLen,
              Cdb cdb)
Retrieves the alarm source central object. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
AlarmSink.submitAlarm(Alarm alarm)
Submits the specified  
Alarm 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 specified  
Alarm 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 specified  
Alarm into the alarm list. | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
Template.apply(Maapi maapi,
     int tid,
     ConfPath rootPath,
     TemplateVariables variables)
Apply a template in the specified context 
 | 
void | 
Template.apply(NavuNode root,
     TemplateVariables variables)
Apply a template in the specified context 
 | 
static boolean | 
Template.exists(Maapi maapi,
      String template)  | 
static boolean | 
Template.exists(NavuContext context,
      String template)  | 
static boolean | 
Template.exists(ServiceContext context,
      String template)
Tests for existence of a template. 
 | 
static Set<String> | 
Template.getTemplates(Maapi maapi)  | 
static Set<String> | 
Template.getTemplates(NavuContext context)  | 
static Set<String> | 
Template.getTemplates(ServiceContext aServiceContext)
Returns a set consisting of the loaded templates. 
 | 
String[] | 
Template.getVariables()  | 
| Constructor and Description | 
|---|
Template(Maapi aMaapi,
        String aTemplateName)  | 
Template(NavuContext aContext,
        String aTemplateName)  | 
Template(ServiceContext aServiceContext,
        String aTemplateName)
Construct a Template. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ConfPath[] | 
NedCmd.getPaths()  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
NotifException
Exceptions raised from the notif package 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ConfException | 
NotifException.mk(ConfResponse r)  | 
| Modifier and Type | Method and Description | 
|---|---|
Notification | 
Notif.read()
Read in the data. 
 | 
| Constructor and Description | 
|---|
Notif(Socket socket,
     EnumSet<NotificationType> eventTypes)
Same functionality as for Notif(socket, eventTypes, cfg)
 except that no extra configuration is expected to be set in eventTypes. 
 | 
Notif(Socket socket,
     EnumSet<NotificationType> eventTypes,
     int heartbeatInterval)
Same functionality as for Notif(socket, eventTypes, cfg)
 except that only heartbeat notifications are expected to require
 to be configured
 Since the ConfD/NCS daemon expects initialization within
 5 seconds after a new socket is established this constructor should be
 called directly for a new socket. 
 | 
Notif(Socket socket,
     EnumSet<NotificationType> eventTypes,
     int heartbeatInterval,
     int healthCheckInterval)
Same functionality as for Notif(socket, eventTypes, cfg)
 except that only heartbeat and healtcheck notifications
 are expected to require to be configured. 
 | 
Notif(Socket socket,
     EnumSet<NotificationType> eventTypes,
     NotificationCfg cfg)
Creates a notification instance. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ConfXMLParamToXML.serialize(Document doc,
         OutputStream out)
Flushes the source document  
doc to
  the target out. | 
void | 
ConfXMLParamToXML.serialize(Document doc,
         Writer out)
Flushes the source document  
doc to
   the target out | 
Document | 
ConfXMLParamToXML.toXML(ConfXMLParam[] param)
Transforms the supplied parameter  
ConfXMLParam[]
 to a document (Document). | 
Document | 
ConfXMLParamToXML.toXML(ConfXMLParam[] param,
     boolean includeEmpty)
Transforms the supplied parameter  
ConfXMLParam[]
 to a document (Document). | 
Document | 
ConfXMLParamToXML.toXML(ConfXMLParam[] param,
     String parentNode,
     String parentURI)
Transforms the supplied  
ConfXMLParam[]
 to a document (Document). | 
Document | 
ConfXMLParamToXML.toXML(ConfXMLParam[] param,
     String parentNode,
     String parentURI,
     boolean includeEmpty)
Transforms the supplied parameter  
ConfXMLParam[]
 to a document (Document). | 
ConfXMLParam[] | 
XMLtoConfXMLParam.toXMLParam()
Converts the xml to corresponding ConfXMLParam[]
 The resulting ConfXMLParam[] is prepared for a getValues() call. 
 | 
ConfXMLParam[] | 
XMLtoConfXMLParam.toXMLParam(int mode)
Converts the xml to corresponding ConfXMLParam[]
 The mode parameter controls whether this ConfXMLParam[] should be
 prepared for a getValues() call or for a setValues() call using
 using  
XMLtoConfXMLParam.MODE_GET or XMLtoConfXMLParam.MODE_SET respectively. | 
| Constructor and Description | 
|---|
XMLtoConfXMLParam(String xml,
                 ConfPath path)
Main constructor for initializing the xml parser. 
 |