Uses of Class
com.tailf.conf.ConfException
Packages that use ConfException
Package
Description
Package with methods for connecting to the configuration database.
Data types and utilities for communication with the server.
Data provider API package, for implementation of callbacks for validations, actions, transformation etc.
Service callback specific context and utilities.
Package for setup and control of High Availability cluster nodes.
MAAPI is an API which provides full access to the systems internal
transaction engine.
NAVU (Navigation Utilities) is an API which provides increased
accessibility to the ConfD/NCS populated data model tree:
NAVU-Tree.
NCS Java machine management and control of Services, Neds,
callbacks and Applications
The Common Alarm Management package contains common definitions that are
used within the alarm manager.
The Alarm Manager consumer package provides support for subscription to
alarms in the NCS Alarm list.
The Alarm Manager producer package provides support for injection of
alarms into the NCS Alarm list.
Network Equipment Drivers package
Package for subscription to asynchronous events.
Utility classes for representing compiled ConfNamespaces.
-
Uses of ConfException in com.tailf.cdb
Subclasses of ConfException in com.tailf.cdbModifier and TypeClassDescriptionclassCdb package generic exceptionclassThis exception is used by clients of CdbSubscription that needs to report errors.Methods in com.tailf.cdb that return ConfExceptionModifier and TypeMethodDescriptionstatic ConfExceptionCdbException.mk(ConfResponse r) static ConfExceptionCdbException.mk(ConfResponse r, ConfPath path) static ConfExceptionCdbExtendedException.mk(int extendedErrorCode, ConfNamespace appNS, String appTag, ConfResponse r) Methods in com.tailf.cdb that throw ConfExceptionModifier and TypeMethodDescriptionvoidCdbSubscription.abortTransaction(CdbExtendedException ex) Abort the transaction.voidChanges the working directory.voidChange working directory to container specified by path stringvoidCdbUpgradeSession.cd(ConfCdbUpgradePath path) voidvoidCreate a new optional element or list entry.voidsimilar toCdbSession.create(ConfPath)but specifies element using path stringvoidCdbUpgradeSession.create(ConfCdbUpgradePath path) voidvoidDelete an optional element or list entry and all its child elements.voidsimilar toCdbSession.delete(ConfPath)but specifies element using path stringvoidCdbUpgradeSession.delete(ConfCdbUpgradePath path) voidvoidCdbSubscription.diffIterate(int subid, CdbDiffIterate iter) Iterate over changes made in CDB.voidCdbSubscription.diffIterate(int subid, CdbDiffIterate iter, EnumSet<DiffIterateFlags> flags, Object initstate) Iterate over changes made in CDB with additional supplied flags.voidCdbSession.endSession()Ends the data sessionbooleanContainers and leafs in a YANG model may be optional.booleanChecks whether an element exists.booleanCdbUpgradeSession.exists(ConfCdbUpgradePath path) booleanRetrieve the currently selected case.Retrieve the currently selected case.CdbUpgradeSession.getCase(String choice, ConfCdbUpgradePath path) Cdb.getCompactionInfo(CdbDbfileType dbfile) Retrieves compaction information on a CDB fileCdbSession.getcwd()Returns the current position as previously set byCdbSession.cd(ConfPath),CdbSession.pushd(ConfPath), orCdbSession.popd()as a string.CdbSession.getcwdPath()Returns the current position as previously set byCdbSession.cd(ConfPath),CdbSession.pushd(ConfPath), orCdbSession.popd()as aConfObjectarray.This reads a a value from the path.similar toCdbSession.getElem(ConfPath)but specifies element using path stringCdbUpgradeSession.getElem(ConfCdbUpgradePath path) CdbSubscription.getModifications(int subid, CdbGetModificationFlag flag, ConfPath path) Deprecated.CdbSubscription.getModifications(int subid, CdbGetModificationFlag flag, String fmt, Object... args) Deprecated.CdbSubscription.getModifications(int subid, EnumSet<CdbGetModificationFlag> flags, ConfPath path) Retrieve changes that caused by subscription notification.CdbSubscription.getModifications(int subid, EnumSet<CdbGetModificationFlag> flags, String fmt, Object... args) Retrieve changes that caused by subscription notification.CdbSubscription.getModifications(CdbGetModificationFlag flag) Deprecated.CdbSubscription.getModifications(EnumSet<CdbGetModificationFlag> flags) Retrieve changes that caused by subscription notification.CdbSubscription.getModificationsCLI(int subid) Return a string with the CLI commands that corresponds to the changes that triggered subscription.CdbSubscription.getModificationsCLI(int subid, int flags) CLI string that corresponds to the changes that triggered subscription.Cdb.getMountId(ConfPath path) CdbSubscription.getMountId(ConfPath path) intCdbSession.getNumberOfInstances(ConfPath path) Returns the number of elements of a container type.intCdbSession.getNumberOfInstances(String fmt, Object... arguments) similar toCdbSession.getNumberOfInstances(ConfPath)but specifies element using path stringintCdbUpgradeSession.getNumberOfInstances(ConfCdbUpgradePath path) intCdbUpgradeSession.getNumberOfInstances(String fmt, Object... arguments) Same functionality as getObject(numOfObjects, fmt, arguments) but takes a already constructed ConfPath object as argument instead of fmt, 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.CdbUpgradeSession.getObject(int numOfObjects, 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[]>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.List<ConfObject[]>CdbUpgradeSession.getObjects(int numOfObjects, int instance, int numOfInstances, ConfCdbUpgradePath path) List<ConfObject[]>CdbUpgradeSession.getObjects(int numOfObjects, int instance, int numOfInstances, String fmt, Object... arguments) Cdb.getPhase()Returns the start-phase CDB database is currently in.Cdb.getTxId()Returns a CdbTxid object which represents the last transaction id from CDB.longCdbSubscription.getUserSession()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.CdbSession.getValues(ConfXMLParam[] params, String fmt, Object... arguments) Read an arbitrary set of sub-elements of a container element.CdbUpgradeSession.getValues(ConfXMLParam[] params, ConfCdbUpgradePath path) CdbUpgradeSession.getValues(ConfXMLParam[] params, String fmt, Object... arguments) intReturns the position of a keyintsimilar toCdbSession.index(ConfPath)but specifies element using path stringintCdbUpgradeSession.index(ConfCdbUpgradePath path) intvoidCdb.initiateCompaction()Initiates compaction on CDB files:voidCdb.initiateDbfileCompaction(CdbDbfileType dbfile) Initiates compaction on a CDB file.booleanThis method returns true for a leaf which has a default value defined in the data model when no value has been set, i.e.booleansimilar toCdbSession.isDefault(ConfPath)but specifies element using path stringbooleanCdbUpgradeSession.isDefault(ConfCdbUpgradePath path) booleanintReturns the position of the next keyintsimilar toCdbSession.nextIndex(ConfPath)but specifies element using path stringintCdbUpgradeSession.nextIndex(ConfCdbUpgradePath path) intintCdbSession.numInstances(ConfPath path) Deprecated.in favor to getNumberOfInstances, which follows java naming conventions.intCdbSession.numInstances(String fmt, Object... arguments) Deprecated.in favor to getNumberOfInstances, which follows java naming conventions.voidCdbSession.popd()Pops the top element from the directory stack and changes directory to previous directory.voidSimilar toCdbSession.cd(ConfPath)but pushes the previous current directory on a stack.voidsimilar toCdbSession.pushd(ConfPath)but specifies position using path stringvoidCdbUpgradeSession.pushd(ConfCdbUpgradePath path) voidint[]CdbSubscription.read()Reads the Cdb subscription socket for events and blocks.voidSame functionality as setCase(choice, scase, fmt, arguments) but takes a already constructed ConfPath object as argument instead of fmt, arguments.voidWhen we use the YANG choice construct in the data model, this function can be used to select the current case.voidCdbUpgradeSession.setCase(String choice, String scase, ConfCdbUpgradePath path) voidvoidSets an element in operational data.voidsimilar toCdbSession.setElem(ConfValue, ConfPath)but specifies element using path stringvoidCdbUpgradeSession.setElem(ConfValue value, ConfCdbUpgradePath path) voidvoidCdbSubscription.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.voidCdbSession.setNamespace(ConfNamespace ns) Before we start to read data from CDB we need to set the namespace.voidSet all elements corresponding to the complete contents of a container element, except for list entry sub-elements.voidsimilar toCdbSession.setObject(ConfValue[], ConfPath)but specifies element using path stringvoidCdbUpgradeSession.setObject(ConfValue[] values, ConfCdbUpgradePath path) voidvoidCdb.setTimeout(int timeoutSecs) A timeout for cdb client actions can be specified via the config file.voidCdbSession.setValues(ConfXMLParam[] params, ConfPath path) Set arbitrary sub-elements of a container element.voidCdbSession.setValues(ConfXMLParam[] params, String fmt, Object... arguments) similar toCdbSession.setValues(ConfXMLParam[], ConfPath)but specifies element using path stringvoidCdbSession.setValues(List<ConfXMLParam> params, ConfPath path) voidCdbUpgradeSession.setValues(ConfXMLParam[] params, ConfCdbUpgradePath path) voidCdbUpgradeSession.setValues(ConfXMLParam[] params, String fmt, Object... arguments) Cdb.startSession()Starts a new CDB Session on an already establishedCdbagainstCdbDBType.CDB_RUNNINGdatastore withCdbLockType.LOCK_SESSIONlock.Cdb.startSession(CdbDBType dbtype) Starts a new CDB Session on an already establishedCdb.Cdb.startSession(CdbDBType dbtype, EnumSet<CdbLockType> lockflags) Starts a new CDB Session on an already establishedCdb.Cdb.startUpgradeSession()Similar toCdb.startSession()but always returns a CdbUpgradeSession.Cdb.startUpgradeSession(CdbDBType dbtype) Similar toCdb.startSession(CdbDBType)but always returns a CdbUpgradeSession.Cdb.startUpgradeSession(CdbDBType dbtype, EnumSet<CdbLockType> lockflags) Similar toCdb.startSession(CdbDBType, EnumSet)but always returns a CdbUpgradeSession.intSubscribe to given path.intCdbSubscription.subscribe(int priority, ConfNamespace ns, String fmt, Object... args) Subscribe to a given path.intCdbSubscription.subscribe(CdbSubscriptionType subscriptionType, int priority, int nshash, String fmt, Object... args) Subscribe to a path.intCdbSubscription.subscribe(CdbSubscriptionType subscriptionType, int priority, ConfNamespace ns, String fmt, Object... args) Subscribe to a path.intCdbSubscription.subscribe(CdbSubscriptionType subscriptionType, EnumSet<CdbSubscrConfigFlag> flags, int priority, int nshash, String fmt, Object... args) Subscribe to a path.intCdbSubscription.subscribe(CdbSubscriptionType subscriptionType, EnumSet<CdbSubscrConfigFlag> flags, int priority, ConfNamespace ns, String fmt, Object... args) Subscribe to a path.voidCdbSubscription.subscribeDone()Finishing the subscription setup.voidCdbSubscription.sync(CdbSubscriptionSyncType subscriptionSyncType) Synchronize the subscriber.voidCdb.triggerOperSubscriptions(int[] spointArray) Function similar toCdb.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.voidCdb.triggerOperSubscriptions(int[] spointArray, EnumSet<CdbLockType> lockflags) Function to trigger operational subscriptions in similar toCdb.triggerSubscriptions(int[]).voidCdb.triggerSubscriptions(int[] spointArray) Triggers Cdb subscription for configuration data.voidCdb.waitStart()This call waits until start-phase 1 is completed and CDB is available.Constructors in com.tailf.cdb with parameters of type ConfExceptionModifierConstructorDescriptionCdbExtendedException(int extendedErrorCode, ConfNamespace appNS, String appTag, ConfException ex) Constructors in com.tailf.cdb that throw ConfExceptionModifierConstructorDescriptionCreates a new instance of aCdbsocket 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) -
Uses of ConfException in com.tailf.conf
Subclasses of ConfException in com.tailf.confModifier and TypeClassDescriptionclassException thrown when protocol data is malformed.classWarning exception base class.Methods in com.tailf.conf that return ConfExceptionModifier and TypeMethodDescriptionstatic ConfExceptionConfException.mk(ConfResponse r) static ConfExceptionConfException.mk(ConfResponse r, ConfPath errPath) Methods in com.tailf.conf that throw ConfExceptionModifier and TypeMethodDescriptionAppends suffix path to existing keypathAppends suffix path to existing keypathConfPath.append(String s, List<MaapiSchemas.CSNode> pathNodes) Appends suffix path to existing keypathvoidConfBits.clearBit(long pos) Clear bit at position pos in bitset.ConfCdbUpgradePath.copyAppend(String s) CopyAppends to the keypathConfPath.copyAppend(String s) CopyAppends to the keypathConfCdbUpgradePath.copyPop()Creates a new ConfCdbUpgradePath with the current path minus the last element including list keys.ConfPath.copyPop()Creates a new ConfPath with the current path minus the last element including list keys.static ConfObjectConfObject.decode(ConfEObject o) static ConfXMLParamConfXMLParam.decodeParam(ConfEObject o) Decode the internal representation to aConfXMLParamUsed internally.static ConfXMLParam[]ConfXMLParam.decodeParams(ConfEObject o) static voidConfInternal.diffIterate(Object socket, ConfIterate iter, Object initstate) static voidConfInternal.diffIterate(SelectionKey key, ConfIterate iter, Object initstate) Common static method for diffIterate with CdbSubscription.static longstatic longConfInternal.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.Produces an EXPRESSION object representing the comparison: left equals to rightstatic ConfNamespaceConfNamespace.findNamespaceFromNsName(ConfPath path, MountIdInterface mountIdGetter, String namespaceName) static StringConfBits.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 StringConfBits.getBitNamesByValue(String path, ConfBits bits) LikeConfBits.getBitNamesByValue(ConfPath, ConfBits)but takes a path string pointing to the bitset in the schema.static ConfEnumerationConfEnumeration.getEnumByLabel(ConfPath path, String label) Get an ConfEnumeration from the string label at a given position in the schema.static ConfEnumerationConfEnumeration.getEnumByLabel(String path, String label) Get an ConfEnumeration from the string label at a given position in the schema.InstancePath.getKP()Returns an array ofConfTagandConfKeyobjects which represents the path in reverted order.static StringConfEnumeration.getLabelByEnum(ConfPath path, ConfEnumeration e) Get the string label of an enumeration at a given position in the schema.static StringConfEnumeration.getLabelByEnum(String path, ConfEnumeration e) Get the string label of an enumeration at a given position in the schema.MountIdInterface.getMountId(ConfPath path) static SocketRetrieve a socket which is connected to the default host/port.static SocketRetrieve 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 SocketSocketFactory.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.Retrieve a connected socket to a specified destinationSocketFactoryCallback.getSocket(Object caller, InetAddress iaddr, int port) Retrieve a connected socket to a specified destinationstatic StringConfValue.getStringByValue(ConfPath path, ConfValue val) Get the string representation of a ConfValue at a given position in the schema.static StringConfValue.getStringByValue(String path, ConfValue val) Get the string representation of a ConfValue at a given position in the schema.static SocketSocketFactory.getUnconnectedSocket(Object caller) Retrieve an unconnected socket.SocketFactoryCallback.getUnconnectedSocket(Object caller) Retrieve an unconnected socket.static ConfBitsConfBits.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 ConfBitsConfBits.getValueByBitNamesString(String path, String bitNames) LikeConfBits.getValueByBitNamesString(ConfPath, String)but takes a path string pointing to the bitset in the schema.static ConfValueConfValue.getValueByString(ConfPath path, String str) Get a ConfValue representation a string at a given position in the schema.static ConfValueConfValue.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.booleanConfBits.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.voidConfList.move(ConfObject n, ConfList.WhereTo where, ConfObject to) Move a list element to a new position in the list.ConfTypeDescriptor.newInstance(String str) Creates a new ConfValue instance of the type described by this ConfTypeDescriptor and with a value represented by a string.voidConfPath.pop()Pops the last element from the path including list keys.Produces an QNAME that represents a name with an optional prefix.static voidReads data into a buffer.static voidConfInternal.readFill(SelectionKey key, ByteBuffer buf, int siz) Read exactlysizdata into the bufferbuf.static voidConfInternal.readPayLoad(SelectionKey key, ByteBuffer buf, int size) static voidConfInternal.readSize(SelectionKey key, ByteBuffer buf, int size) static intConfInternal.requestInt(Socket socket, int op) Request an integer from ConfD/NCS.static intConfInternal.requestInt(Socket socket, int op, int thandle) Requests an integer value from ConfD/NCS.static ConfResponseConfInternal.requestTerm(Socket socket, int op) Requests a term from ConfD/NCS.static ConfResponseConfInternal.requestTerm(Socket socket, int op, int thandle, boolean isrel, ConfEObject arg) Requests a term from ConfD/NCS.static ConfResponseConfInternal.requestTerm(Socket socket, int op, ConfEObject arg) Requests a term from ConfD/NCS.static ConfResponseConfInternal.requestTerm(SelectionKey key, int op) Request the operationopwith no argument, and read the response from ConfD/NCS.static ConfResponseConfInternal.requestTerm(SelectionKey key, int op, int thandle, boolean isrel, ConfEObject arg) Write a termargfor the specified operationop, transaction handlethandle( if available -1 otherwise ) and read the response, from ConfD/NCS.static ConfResponseConfInternal.requestTerm(SelectionKey key, int op, ConfEObject arg) Write a termargfor the specified operationopand read the response, from ConfD/NCS.voidConfBits.setBit(long pos) Set bit at position pos in bitset.voidInstancePath.setMountIdGetter(MountIdInterface mountGetter) static ConfResponseCommon method to read a term from ConfD/NCS NOTE: This method should not be used by users of this API.static ConfResponseRequest one term from ConfD/NCS.static ConfResponseRequest one term from ConfD/NCS.static ConfResponseConfInternal.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 ConfResponseConfInternal.termRead(SelectionKey key, int cdbop) Read a response, term from ConfD/NCS with the givenSelectionKeyand the opcdbop.static DocumentConfXMLParam.toDOM(ConfXMLParam[] params) Return StringDOMdocument representation of a (Conf)XML-structure.static DocumentConfXMLParam.toDOM(ConfXMLParam[] params, String parentNode, String parentURI) Return StringDOMrepresentation of a (Conf)XML-structure.static StringConfXMLParam.toXML(ConfXMLParam[] params) Return String XML representation of a (Conf)XML-structure.static StringConfXMLParam.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 ConfHaNodeConfHaNode.unpack_ha_node(ConfEObject term) Decodes a ConfEObject into a ConfHaNode.Constructors in com.tailf.conf that throw ConfExceptionModifierConstructorDescriptionString constructor for ConfBit32.String constructor for ConfBit64.ConfBitBig(String str) String constructor for ConfBitBig.ConfCdbUpgradePath(String fmt, Object... arguments) For internal usage.ConfDottedQuad(byte[] val) ConfDottedQuad(ConfBinary obj) Constructs a ConfDottedQuad from a ConfBinary object.ConfDottedQuad(String str) Construct a ConfDottedQuad from a string of bytes in the format of octets (decimal values) separated with dots.ConfEnumeration(int ordinalValue) Constructor for ordinalvalue.ConfEnumeration(int ordinalValue, ArrayList<ConfNamespace> ns_list) Deprecated.ConfHexList(String str) Construct aConfHexListfrom a string of bytes in the format of hexadecimal values separated with colons.ConfHexString(String str) Construct aConfHexStringfrom a string of bytes in the format of hexadecimal values separated with colons.ConfIPv4(ConfEObject vtup) ConfIPv4(ConfETuple vtup) ConfIPv6(ConfEObject vtup) ConfIPv6(ConfETuple vtup) ConfObjectRef(ConfPath path) Construct a ConfObjectRef from a given Absolute ConfPath.It assumes that param is of type ConfEList.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.ConfPath(MountIdInterface mountIdCb, String fmt, Object... arguments) ConfPath(Maapi maapi, int tid, ConfObject[] kp) Initialize a ConfPath.Construct aConfPathfrom a string path representation and of optional arguments.ConfUserInfo(ConfETuple usess) Internally used constructor to create a UserInfo recordConfXMLParamCdbStart(ConfEObject o, int cdbInstanceInteger) ConfXPath(String xpath, MountIdInterface mountGetter) Initialize a InstancePath. -
Uses of ConfException in com.tailf.dp
Subclasses of ConfException in com.tailf.dpModifier and TypeClassDescriptionclassException thrown from inside callbacks to identify problems.classExtended errorcode Exceptions thrown from inside callbacks to identify problems.classWarnings thrown from inside callbacks to identify problems.classGeneral Dp ExceptionMethods in com.tailf.dp that return ConfExceptionModifier and TypeMethodDescriptionstatic ConfExceptionDpCallbackExtendedException.mk(int extendedErrorCode, ConfNamespace appNS, String appTag, ConfResponse r) Deprecated.static ConfExceptionDpException.mk(ConfResponse r) Methods in com.tailf.dp that throw ConfExceptionModifier and TypeMethodDescriptionDp.createNotifStream(String name) Creates (and registers) a notifications stream with ConfD/NCS.Dp.createNotifStream(String name, DpNotifReplayCallback replayCb) Creates (and registers) a notifications stream with ConfD/NCS.Dp.createNotifStream(String name, DpNotifReplayCallback replayCb, Socket socket) Creates (and registers) a notifications stream with ConfD/NCS.Dp.createSnmpNotifier(String name, String context_name) Creates (and registers) a SNMP Notifer @seeDpSnmpNotifier.Dp.createSnmpNotifier(String notify_name, String context_name, Object inform_cb) Creates (and registers) a SNMP Notifier @seeDpSnmpNotifier.Dp.createSnmpNotifier(String notify_name, String context_name, Object inform_cb, Socket socket) Creates (and registers) a SNMP Notifier seeDpSnmpNotifier.voidDpNotifStream.flush()Notifications are sent asynchronously, i.e.Dp.getServicePointMaapi()Dp.getServicePointMaapi(DpTrans trans) voidDp.read()Receives data on the control socket which is connected to ConfD/NCS.voidDpNotifStream.send(ConfDatetime time, ConfXMLParam params) Send a notification defined at the top level of a YANG module on this notification stream to ConfD/NCS.voidDpNotifStream.send(ConfDatetime time, ConfXMLParam[] params) Send a notification defined at the top level of a YANG module on this notification stream to ConfD/NCS.voidDpNotifStream.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.voidDpNotifStream.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.voidDpSnmpNotifier.send(String notification, SnmpVarbind[] varbinds) Send SNMP notification.voidDpSnmpNotifier.send(String notification, SnmpVarbind[] varbinds, Integer ref) Send SNMP notification with the option to receive an Inform Response.Constructors in com.tailf.dp with parameters of type ConfExceptionModifierConstructorDescriptionDpCallbackExtendedException(int extendedErrorCode, ConfNamespace appNS, String appTag, ConfException ex) Constructors in com.tailf.dp that throw ConfExceptionModifierConstructorDescriptionThis constructor will initialize the Dp class library and connect to ConfD/NCS on the provided control 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, 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. -
Uses of ConfException in com.tailf.dp.services
Methods in com.tailf.dp.services that throw ConfExceptionModifier and TypeMethodDescriptionstatic voidServiceLog.debug(NavuNode service, String msg, ConfIdentityRef type) Write service log entry with level debug.static voidServiceLog.error(NavuNode service, String msg, ConfIdentityRef type) Write service log entry with level error.ServiceContextImpl.getAttachedServiceMaapi()Internal used method to get the a maapi object attached to the correct transactionServiceContext.getNedIdByDeviceName(String name) ServiceContextImpl.getNedIdByDeviceName(String name) ServiceContext.getRootNode()Returns the path root as a NavuNode with the NavuContext attached to the ongoing Maapi transaction.ServiceContextImpl.getRootNode()Returns the path root as a NavuNode with the NavuContext attached to the ongoing Maapi transaction.NanoServiceContextImpl.getServiceNode()ServiceContext.getServiceNode()Returns the current service path as a NavuNode with the NavuContext attached to the ongoing Maapi transaction.ServiceContextImpl.getServiceNode()Returns the current service path as a NavuNode with the NavuContext attached to the ongoing Maapi transaction.NanoServiceContext.getStateNode()NanoServiceContextImpl.getStateNode()static voidServiceLog.info(NavuNode service, String msg, ConfIdentityRef type) Write service log entry with level info.static voidServiceLog.trace(NavuNode service, String msg, ConfIdentityRef type) Write service log entry with level trace.static voidServiceLog.warn(NavuNode service, String msg, ConfIdentityRef type) Write service log entry with level warn.Constructors in com.tailf.dp.services that throw ConfExceptionModifierConstructorDescriptionNanoServiceContextImpl(DpTrans dpTrans, Dp dp, ConfEObject eObject, ServiceOperationType operation) Internally called constructor to create a ServiceContextServiceContextImpl(DpTrans dpTrans, Dp dp, ConfEObject eObject, ServiceOperationType operation) Internally called constructor to create a ServiceContextServiceModificationContextImpl(DpTrans dpTrans, Dp dp, ConfEObject eObject) Internally used constructor -
Uses of ConfException in com.tailf.ha
Subclasses of ConfException in com.tailf.ha -
Uses of ConfException in com.tailf.maapi
Subclasses of ConfException in com.tailf.maapiModifier and TypeClassDescriptionclassException raised from the maapi packageclassWarnings raised from the maapi packageclassWarnings raised from the maapi packageclassWarnings raised from the maapi packageMethods in com.tailf.maapi that return ConfExceptionModifier and TypeMethodDescriptionstatic ConfExceptionMaapiException.mk(ConfResponse r) static ConfExceptionMaapiException.mk(ConfResponse r, ConfPath path) Methods in com.tailf.maapi that throw ConfExceptionModifier and TypeMethodDescriptionvoidMaapi.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.voidMaapi.abortTrans(int tid) Abort a transaction specified by transaction handletid.voidMaapi.abortUpgrade()Note, This method is only applicable for Confd.voidMaapi.applyTrans(int tid, boolean keepOpen) Apply a current transaction with transaction handletid.voidMaapi.applyTrans(int tid, boolean keepOpen, int flags) Apply a current transaction with transaction handletidwith additional flags (NCS Specific).Maapi.applyTransParams(int tid, boolean keepOpen, CommitParams params) Apply a current transaction with transaction handletidwith additional NCS specific parameters.voidMaapi.attach(int tid, int nsi) Same asMaapi.attach(int, int, int)with the exception that the User session id is implicit for the attached transaction.voidMaapi.attach(int tid, int nsi, int usid) Attach to a current transaction.voidSame asMaapi.attach(int, String, int)with the exception that the User session id is implicit for the attached transaction.voidAttach to a current transaction.intMaapi.attachInit()Attach to transaction available in phase0.Maapi.authenticate(String user, String passwd) If we are implementing a proprietary Management Agent with MAAPI API, the methodMaapi.startUserSession(String,InetAddress,String,String[], MaapiUserSessionFlag)requires the application to tell ConfD/NCS which groups the user are member of.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 methodMaapi.startUserSession(String,InetAddress,String,String[], MaapiUserSessionFlag)requires the application to tell ConfD/NCS which groups the user are member of.voidMaapi.candidateAbortCommit()This function cancels a pending confirmed commit.voidMaapi.candidateAbortCommitPersistent(String persistId) Cancel an ongoing persistent commit with the cookie given by persistId.voidMaapi.candidateCommit()This function copies the candidate to running.voidMaapi.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.voidMaapi.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.voidMaapi.candidateCommitPersistent(String persistId) Confirm an ongoing persistent commit with the cookie given by persistId.voidMaapi.candidateConfirmedCommit(int t) This method also copies the candidate into running.voidMaapi.candidateConfirmedCommitInfo(int timeoutsecs, String label, String comment) This method does the same asMaapi.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.voidMaapi.candidateConfirmedCommitInfo(int timeoutsecs, String persist, String persistId, String label, String comment) This method does the same asMaapi.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.voidMaapi.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.voidMaapi.candidateReset()This function copies running into candidate.voidMaapi.candidateValidate()This function validates the candidate.voidThis function mimics the behavior of the UNIX "cd" command.voidMaapi.clearOpCache()Same asMaapi.clearOpCache(ConfPath), with the only difference that if clears all cached data from "/" and down.voidMaapi.clearOpCache(ConfPath path) Request clearing of the operational data cache (see the Operational Data the User Guide).voidMaapi.CLIAccounting(String user, int usid, String cmd) Generate an audit log entry in the CLI audit log.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.Maapi.CLICmdToPath(String cmd) Equivalent toMaapi.CLICmdToPath(int, String)with the first parameter set to -1 (ie, the command is not interpreted in the context of any particular transaction)Maapi.CLIDiffCmd(int thandle, int thandleOld, ConfPath path) Get the diff between two transactions as C-/I-style CLI commands.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.Prompts user for a string.Prompts user for a string.Maapi.CLIPromptOneOf(int usid, String prompt, String[] choice) Prompt user for one of the strings given in the choice parameter.Maapi.CLIPromptOneOf(int usid, String prompt, String[] choice, int timeout) Prompt user for one of the strings given in the choice parameter.Maapi.CLIReadEOF(int usid, boolean echo) Read a multi line string from the CLI.Maapi.CLIReadEOF(int usid, boolean echo, int timeout) Read a multi line string from the CLI.voidWrite to the CLI.voidExecute CLI command in ongoing CLI session.voidCLIInteraction.cmd(String command, EnumSet<CLIInteractionFlag> flags) Execute CLI command in ongoing CLI session.voidCLIInteraction.cmd(String command, EnumSet<CLIInteractionFlag> flags, String unhide) Execute CLI command in ongoing CLI session.CLIInteraction.cmdIO(String command, EnumSet<CLIInteractionFlag> flags, String unhide) Execute CLI command in ongoing CLI session and output result on socket.Maapi.commitQueueResult(int tid, int timeout) Deprecated.UseMaapi.applyTransParams(int, boolean, CommitParams)instead.voidMaapi.commitTrans(int tid) Commit a transaction specified by transaction handletid.voidMaapi.commitUpgrade()Note, This method is only applicable for Confd.intMaapi.confirmedCommitInProgress()Checks whether a confirmed commit is pending.voidMaapi.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.voidDeprecated.UseMaapi.copyTree(int, boolean, ConfPath, ConfPath)instead.voidDeprecated.UseMaapi.copyTree(int, ConfPath, ConfPath)instead.voidSimilar toMaapi.copy(int, int), but does a replacing copy only of the subtree rooted at the path given bypathvoidMaapi.copyRunningToStartup()Copies running to startup.voidThis function is used to copy an entire subtree in the configuration from one point to another.voidMaapi.copyTree(int, boolean, ConfPath, ConfPath)Equivalent toMaapi.copyTree(int, boolean, ConfPath, ConfPath)with useSharedCreate set to false i.e., for use outside fastmap, without 'shared' create/setvoidCreate an entity in the XML tree.voidCreate a new list entry in the XML tree.voidDeletes a node and all its children from the XML data tree.voidDeletes a node and all its children from the XML data tree.voidMaapi.deleteAll(int th, MaapiDeleteAllFlag how) This function can be used to delete "all" configuration data within a transaction.voidMaapi.deleteConfig(int db) This function empties a data store.ConfObject[][]This method dereferences a leafref and returns a list of the objects the leafref "points" to.voidMaapi.detach(int tid) Detaches an attached MAAPI socket.voidMaapi.diffIterate(int tid, MaapiDiffIterate iter) Iterates through the transaction diff.voidMaapi.diffIterate(int tid, MaapiDiffIterate iter, Object initstate, String fmt, Object... args) Iterates through the transaction diff.voidMaapi.diffIterate(int tid, MaapiDiffIterate iter, String fmt, Object... args) Iterates through the transaction diff.voidMaapi.diffIterate(int tid, Object initstate, EnumSet<DiffIterateFlags> flags, MaapiDiffIterate iter, ConfPath path) Iterates through the transaction diff.voidMaapi.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.voidMaapi.disconnectSockets(int[] sockets) This function is an alternative todisconnectRemote()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).booleanIf 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.End progress span.voidMaapi.endUserSession()Ends the current user session on thisMaapiinstance.voidMaapi.event(int tid, Maapi.Verbosity verbosity, String msg, ConfPath path, Attributes attributes) Create a progress event.booleanbooleanBoolean function which return 1 or 0 if a path defines an existing element in the XML data tree.booleanMaapi.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.voidMaapi.finishTrans(int tid) Finish the transaction specified by transaction handletid.Read CLI session parameter.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.This returns the current 'case' for a 'choice' construct.Maapi.getCwd(int tid) Returns the current position as previously set by Maapi.cd(), Maapi.pushd(), or Maapi.popd() as a String.Maapi.getCwdPath(int tid) Returns the current position like Maapi.getCwd(), but as a ConfPath instead of as a String.This reads a value from the path in fmt and returns the result.Maapi.getMountId(int tid, ConfPath path) MaapiSchemas.getMountId(MountIdInterface midif, ConfPath path) MountIdCb.getMountId(ConfPath path) intMaapi.getMyUserSession()Returns the usid associated with thisMaapiMaapi.getNext(MaapiCursor c) Iterates and gets the keys for the next element pinpointed by theMaapiCursorinitially retrieved byMaapi.newCursor(int, String, Object...).intMaapi.getNumberOfInstances(int tid, ConfPath path) intMaapi.getNumberOfInstances(int tid, String fmt, Object... arguments) Return the number of instances in a list.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.intMaapi.getRollbackId(int tid) Get rollback id for committed transaction specified by transaction handletid.intMaapi.getRunningDbStatus()Query ConfD/NCS for its consistency state.Maapi.getTransParams(int tid) Get commit parameters for a transaction.Maapi.getUserSession(int usid) Return aMaapiUserSessiongiven by theusid.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).Maapi.getUserSessionOpaque(int usid) If the user session has "opaque" information provided by the northbound client (see the -O option inconfd_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>
T[]Read an arbitrary set of sub-elements of a container element.<T extends ConfXMLParam>
T[]Read an arbitrary set of sub-elements of a container element.<T extends List<ConfXMLParam>>
TRead an arbitrary set of sub-elements of a container element.<T extends List<ConfXMLParam>>
TRead an arbitrary set of sub-elements of a container element.voidMaapi.initUpgrade(int timeoutsecs, int flags) Note, This method is only applicable for Confd.voidThis function inserts a new element in an ordered list of elements.voidbooleanMaapi.isCandidateModified()Returns true if candidate has been modified, i.e if there are pending non committed changes to the candidate data store.intMaapi.isLockSet(int db) This methods checks if a lock is taken or not.booleanMaapi.isRunningModified()Returns true if running has been modified since the last copy to startup, false if it has not been modified.voidMaapi.iterate(int tid, Object initstate, EnumSet<ConfIterateFlags> flags, MaapiIterate iter, ConfPath path) Iterates through all the data in a transaction.voidMaapi.killUserSession(int usid) Ends another users session, effectively logging out that user.Maapi.listRollback()Deprecated.Consult the /rollback-files list instead.voidMaapi.loadConfig(int tid, EnumSet<MaapiConfigFlag> flags, String filename) This function loads a configuration from filename into the server.voidMaapi.loadConfigCmds(int tid, EnumSet<MaapiConfigFlag> flags, String cmds, String fmt, Object... arguments) This function loads a configuration from a string into the server.Maapi.loadConfigStream(int tid, EnumSet<MaapiConfigFlag> flags) Load configuration from aOuputStreaminto ConfD/NCS.voidMaapi.loadRollback(int tid, int nr) Deprecated.Use the action /rollback-files/apply-rollback-file instead.voidMaapi.loadRollbackFixed(int tid, int fixed_nr) Deprecated.Use the action /rollback-files/apply-rollback-file instead.Maapi.loadSchemas()Load Schemas method that downloads all schemas from server into a MaapiSchemas container, from which specified schemas can be accessed and traversed.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.voidMaapi.lock(int db) This function is used to take a lock on one of the databases.intMaapi.lockPartial(int db, String xpath) Same asMaapi.lockPartial(int,String[])except only one xpath expression is given.intMaapi.lockPartial(int db, String[] xpaths) It is possible to manipulate partial locks on the databases, i.e.voidThis function moves an existing object.voidThis function moves an existing objectvoidMaapi.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.voidMaapi.ncsApplyTemplate(int tid, String template, ConfPath rootIKP, Properties variables, boolean createShared) voidMaapi.ncsApplyTemplate(int tid, String template, ConfPath rootIKP, Properties variables, String document, boolean createShared) String[]Maapi.ncsGetTemplateVariables(String template) voidMaapi.ncsMovePrivateData(int initTid, ConfPath from, ConfPath to) Deprecated.This method is not activly maintained and does not fully support all kinds of services (i.e.booleanMaapi.ncsRunWithRetry(MaapiRetryableOp op) Runopwith a new read-write transaction against the RUNNING datastore.booleanMaapi.ncsRunWithRetry(MaapiRetryableOp op, int maxNumRetries, CommitParams commitParams) Runopwith a new read-write transaction against the RUNNING datastore.booleanMaapi.ncsRunWithRetry(MaapiRetryableOp op, int maxNumRetries, CommitParams commitParams, int usid, EnumSet<MaapiFlag> flags) Runopwith a new read-write transaction against the RUNNING datastore.Maapi.ncsTemplates()voidMaapi.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.voidMaapi.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.Creates a cursor for a list specified bypathCreates a cursor for a list specified byfmt.Maapi.newCursorWithFilter(int tid, String filter, ConfPath path) Creates a cursor for a list specified bypathwith an XPath filter specified byfilter.Maapi.newCursorWithFilter(int tid, String filter, String fmt, Object... arguments) Creates a cursor for a list specified byfmtwith an XPath filter specified byfilter.voidMaapi.performUpgrade(String[] loadpathdirs) Note, This method is only applicable for Confd.voidMaapi.popd(int tid) Pops the top position of the directory stack and changes directoryvoidMaapi.prepareTrans(int tid) Prepares the transaction specified by transaction handletid.voidMaapi.prepareTrans(int tid, int flags) Prepares the transaction specified by transaction handletid.voidWrite to the CLI using printf formatting.voidMaapi.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.Prompt user for a string.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.CLIInteraction.promptOneOf(String promptStr, String[] choice, boolean echo) Prompt user for one of the strings given in the choice parameter.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.voidBehaves 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>
QueryResult<T>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 intid.<T extends ResultType>
QueryResult<T>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 inth.CLIInteraction.readEOF(boolean echo) Read a multi line string from the CLI.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.voidMaapi.reloadConfig()Request that the daemon reloads its configuration files.Maapi.reloadSchemas()This method throws away any old MaapiSchemas container and downloads a new from the server.Maapi.reloadSchemas(String[] namespaceURIs) This method throws away any old MaapiSchemas container and downloads a new from the server.voidMaapi.reopenLogs()Request that the daemon closes and re-opens its log filesvoidMaapi.reportProgress(int tid, Maapi.Verbosity verbosity, String msg) Report progress of an action or transaction.voidMaapi.reportProgress(int tid, Maapi.Verbosity verbosity, String msg, String packageName) Deprecated.useProgressTraceinstead.Maapi.reportProgressStart(int tid, Maapi.Verbosity verbosity, String msg, String packageName) Deprecated.useProgressTraceinstead.voidMaapi.reportProgressStop(Maapi.Progress progress) Deprecated.useProgressTraceinstead.voidMaapi.reportProgressStop(Maapi.Progress progress, String annotation) Deprecated.useProgressTraceinstead.voidMaapi.reportServiceProgress(int tid, Maapi.Verbosity verbosity, String msg, String packageName, ConfPath servicePath) Deprecated.useProgressTraceinstead.Maapi.reportServiceProgressStart(int tid, Maapi.Verbosity verbosity, String msg, String packageName, ConfPath servicePath) Deprecated.useProgressTraceinstead.voidMaapi.reportServiceProgressStop(Maapi.Progress progress) Deprecated.useProgressTraceinstead.voidMaapi.reportServiceProgressStop(Maapi.Progress progress, String annotation) Deprecated.useProgressTraceinstead.Maapi.requestAction(ConfXMLParam[] params, int nshash, String fmt, Object... arguments) Same asMaapi.requestAction(ConfXMLParam[], String, Object...)Since actions are not associated with transactions, the namespace hashnshashmust be provided and the path to the action, i.e.Maapi.requestAction(ConfXMLParam[] params, String fmt, Object... arguments) Invokes an action defined in the data model annotated withtailf:action(see tailf_yang_extensions(5)).Maapi.requestAction(List<ConfXMLParam> params, int nshash, String fmt, Object... arguments) Maapi.requestAction(List<ConfXMLParam> params, String fmt, Object... arguments) Same asMaapi.requestAction(ConfXMLParam[], String, Object...)with the difference that theparamsisListinstead ofConfXMLParamarray.Maapi.requestActionTh(int tid, ConfXMLParam[] params, String fmt, Object... arguments) Same asMaapi.requestAction(ConfXMLParam[], String, Object...)with the difference that the fmt is not required to have a namespace prefix in the root tag.Maapi.requestActionTh(int tid, List<ConfXMLParam> params, String fmt, Object... arguments) voidQueryResult.reset()Reset/Rewind a running query so that it starts from the beginning again.voidQueryResult.reset(int offset) Reset/Rewind a running query to a specific offset.longQueryResult.resultCount()Get number of elements in the result.voidMaapi.revert(int tid) Remove all changes in the transaction.voidMaapi.safeCreate(int tid, ConfPath path) Create a new list entity in the XML tree.voidMaapi.safeCreate(int tid, String fmt, Object... arguments) Create a new entity in the XML tree.voidMaapi.safeDelete(int tid, String fmt, Object... arguments) Deletes a node and all its children from the XML data tree.Maapi.safeGetElem(int tid, ConfPath path) Reads a value from thepathspecifiedMaapi.safeGetElem(int tid, String fmt, Object... arguments) This reads a value from the path in fmt and returns the result.Maapi.safeGetObject(int tid, String fmt, Object... arguments) This is a variant of getObject() that returns null if the object doesn't existMaapi.saveConfig(int tid, EnumSet<MaapiConfigFlag> flags) Save the entire config in different formats.Maapi.saveConfig(int tid, EnumSet<MaapiConfigFlag> flags, ConfPath path) Save the subtree in different formats.Maapi.saveConfig(int tid, EnumSet<MaapiConfigFlag> flags, String fmt, Object... args) Save the subtree in different formats, with ability to XPath Filtering.voidSet CLI session parameter.voidMaapi.setAttr(int tid, ConfAttributeValue attr, String fmt, Object... args) Set an attribute for a configuration node.voidMaapi.setComment(int tid, String comment) Set the "Comment" that is stored in the rollback file when a transaction towards running is committed.booleanMaapi.setDelayedWhen(int tid, boolean on) This function enables/disables the "delayed when" mode of a transaction.voidMaapi.setElem(int tid, ConfObject value, ConfPath path) Set value to a leaf node.voidMaapi.setElem(int tid, ConfObject value, String fmt, Object... arguments) Set value to a leaf node.voidSet value to a leaf node.voidSet value to a leaf node.voidThis method can modify some aspects of the read/write session, see MaapiFlag The flags are an Enumset ofMaapiFlagvoidSet the "Label" that is stored in the rollback file when a transaction towards running is committed.voidMaapi.setNamespace(int tid, int nsid) voidMaapi.setNamespace(int tid, String ns) Before can invoke any of read or write functions, we must indicate which namespace we are going to use.voidMaapi.setNextUserSessionId(int usid) Set the user session id that will be assigned to the next user session started.voidMaapi.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.voidMaapi.setReadOnlyMode(boolean flag) Control if the node should accept write transactionsvoidMaapi.setRunningDbStatus(int status) Explicitly sets the systems notion of the consistency state.voidMaapi.setUserSession(int usid) Associate this Maapi instance with an already existing user session.voidMaapi.setValues(int tid, ConfXMLParam[] params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation.voidMaapi.setValues(int tid, ConfXMLParam[] params, String fmt, Object... arguments) Set arbitrary sub-elements of a container element in one bulk operation.voidMaapi.setValues(int tid, List<ConfXMLParam> params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation.voidMaapi.setValues(int tid, List<ConfXMLParam> params, String fmt, Object... arguments) Set arbitrary sub-elements of a container element in one bulk operation.voidMaapi.sharedCreate(int tid, ConfPath path) This is the variant of create() to use from FASTMAP code.voidMaapi.sharedCreate(int tid, String fmt, Object... arguments) voidMaapi.sharedSetElem(int tid, ConfObject value, ConfPath path) Set value to a leaf node from NCS FastMap code.voidMaapi.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.voidMaapi.sharedSetElem(int tid, String value, String fmt, Object... arguments) Set value to a leaf node from NCS FastMap code.voidMaapi.sharedSetValues(int tid, ConfXMLParam[] params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation from NCS FastMap code.voidMaapi.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.voidMaapi.sharedSetValues(int tid, List<ConfXMLParam> params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation from NCS FastMap code.voidMaapi.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.voidMaapi.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.voidMaapi.snmpSendNotification(String notifName, String notifyTarget, String ctxName, SnmpVarbind[] varbinds) Send SNMP notification.voidMaapi.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.voidMaapi.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.Maapi.startSpan(int tid, Maapi.Verbosity verbosity, String msg, ConfPath path, Attributes attributes, Span[] links) Create a progress span.intMaapi.startTrans(int dbname, int mode) Start a new transaction towards the specified databasedbnamewith a transaction modemode.intMaapi.startTrans(int dbname, int mode, String vendor, String product, String version, String clientId) intMaapi.startTrans2(int dbname, int mode, int usid) Start a new transaction towards database within an existing user session specified byusid.intMaapi.startTransFlags(int dbname, int mode, int usid, EnumSet<MaapiFlag> flags) Start a new transaction towards the specified databasedbnamewith a transaction modemodewith additionalflagsto control read/write sessions.intMaapi.startTransInTrans(int mode, int usid, int tid) Start a new transaction within an existing user session and another transaction as backendvoidMaapi.startUserSession(String user, InetAddress srcip, String context, String[] groups, MaapiUserSessionFlag proto) Establish a new user session on thisMaapiinstance.voidMaapi.startUserSession(String user, InetAddress srcip, String context, String[] groups, MaapiUserSessionFlag proto, String vendor, String product, String version, String clientId) voidMaapi.stop()Requests that the daemon stops, returns when daemon has stopped.voidMaapi.stop(boolean synchronous) Stops the daemon.voidQueryResult.stop()Stops the running query and makes the server end free up any internal resources associated with the query.voidMaapi.sysMessage(String to, String message) Send a message to a specific user, a specific user session or all users depending on the to parameter.voidMaapi.unlock(int db) This function releases a lock previously acquired using the lock() method.voidMaapi.unlockPartial(int lockId) This methods releases a lock previously acquired using the lockPartial() method.voidMaapi.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.voidMaapi.validateTrans(int tid, boolean unlock, boolean force) Validates a transaction specified by transaction handletidvoidMaapi.waitStart(int phase) Wait until the daemon has completed a certain start phase.voidMaapi.waitStarted()Wait until the daemon is fully started, i.e.voidWrite to the CLI.Maapi.xpath2kpath(String xpath) Convert a XPath path to a ConfPath object.Maapi.xpath2kpath_th(int tid, String xpath) voidMaapi.xpathEval(int tid, MaapiXPathEvalResult xpatheval, MaapiXPathEvalTrace xpathtrace, String expr, Object initstate, String fmt, Object... arguments) Evaluated the xpath expression as supplied in byexpr.Maapi.xpathEvalExpr(int tid, String expr, MaapiXPathEvalTrace xpathtrace, String fmt, Object... arg) Evaluate the xpath expression given inexprparameter and return the result as a string.Constructors in com.tailf.maapi that throw ConfExceptionModifierConstructorDescriptionApplyResult(ConfResponse result) CommitQueueResult(long queue_id, long status) Deprecated.UseCommitQueueResult(ConfResponse)instead.CommitQueueResult(ConfResponse result) DryRunResult(ConfResponse result) Creates a new instance ofMaapisupplying a established open socket to ConfD/NCS daemon. -
Uses of ConfException in com.tailf.ncs
Subclasses of ConfException in com.tailf.ncsMethods in com.tailf.ncs that throw ConfExceptionModifier and TypeMethodDescriptionstatic CdbResourceManager.getCdbResource(Object object, ResourceType cdbType, Scope scope) static CdbResourceManager.getCdbResource(Object object, ResourceType cdbType, Scope scope, String qualifier) static MaapiResourceManager.getMaapiResource(Object object, Scope scope) static MaapiResourceManager.getMaapiResource(Object object, Scope scope, String qualifier) static voidResourceManager.registerResources(Object annotatedObject) This method will inject resources into annotated fields of the object instances passed as argumentConstructors in com.tailf.ncs that throw ConfExceptionModifierConstructorDescriptionNavuEventHandler(String host, int port, String notifSubscriberName) Create an instance of the NavuEventHandler with a specified host and port.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. -
Uses of ConfException in com.tailf.ncs.alarmman.common
Constructors in com.tailf.ncs.alarmman.common that throw ConfExceptionModifierConstructorDescriptionAlarmAttribute(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) -
Uses of ConfException in com.tailf.ncs.alarmman.consumer
Methods in com.tailf.ncs.alarmman.consumer that throw ConfExceptionModifier and TypeMethodDescriptionstatic AlarmSourceCentralAlarmSourceCentral.getAlarmSource(int alarmQueueLen, Cdb cdb) Retrieves the alarm source central object. -
Uses of ConfException in com.tailf.ncs.alarmman.producer
Methods in com.tailf.ncs.alarmman.producer that throw ConfExceptionModifier and TypeMethodDescriptionvoidAlarmSink.submitAlarm(Alarm alarm) Submits the specifiedAlarminto the alarm list.booleanAlarmSink.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 specifiedAlarminto the alarm list.booleanAlarmSink.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 specifiedAlarminto the alarm list. -
Uses of ConfException in com.tailf.ncs.template
Methods in com.tailf.ncs.template that throw ConfExceptionModifier and TypeMethodDescriptionvoidTemplate.apply(Maapi maapi, int tid, ConfPath rootPath, TemplateVariables variables) Apply a template in the specified contextvoidTemplate.apply(NavuNode root, TemplateVariables variables) Apply a template in the specified contextstatic booleanTemplate.exists(ServiceContext context, String template) Tests for existence of a template.static booleanstatic booleanTemplate.exists(NavuContext context, String template) Template.getTemplates(ServiceContext aServiceContext) Returns a set consisting of the loaded templates.Template.getTemplates(Maapi maapi) Template.getTemplates(NavuContext context) String[]Template.getVariables()Constructors in com.tailf.ncs.template that throw ConfExceptionModifierConstructorDescriptionTemplate(ServiceContext aServiceContext, String aTemplateName) Construct a Template.Template(NavuContext aContext, String aTemplateName) -
Uses of ConfException in com.tailf.ned
Methods in com.tailf.ned that throw ConfException -
Uses of ConfException in com.tailf.notif
Subclasses of ConfException in com.tailf.notifMethods in com.tailf.notif that return ConfExceptionMethods in com.tailf.notif that throw ConfExceptionConstructors in com.tailf.notif that throw ConfExceptionModifierConstructorDescriptionNotif(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. -
Uses of ConfException in com.tailf.progress
Methods in com.tailf.progress that throw ConfExceptionModifier and TypeMethodDescriptionvoidEnd a spanvoidEnd a span with annotationvoidProgressTrace.event(Maapi.Verbosity verbosity, String message) Report an eventvoidProgressTrace.event(Maapi.Verbosity verbosity, String message, Attributes attributes) Report an eventvoidReport an eventvoidProgressTraceNed.event(Maapi.Verbosity verbosity, String message) Report an eventvoidProgressTraceNed.event(Maapi.Verbosity verbosity, String message, Attributes attributes) Report an eventvoidReport an eventProgressTrace.startSpan(Maapi.Verbosity verbosity, String message) Start a new spanProgressTrace.startSpan(Maapi.Verbosity verbosity, String message, Attributes attributes, Span[] links) Start a new spanStart a new spanProgressTraceNed.startSpan(Maapi.Verbosity verbosity, String message) Start a new spanProgressTraceNed.startSpan(Maapi.Verbosity verbosity, String message, Attributes attributes, Span[] links) Start a new spanStart a new spanConstructors in com.tailf.progress that throw ConfExceptionModifierConstructorDescriptionProgressTrace(Maapi maapi, int tid) Creates a new instance ofProgressTraceProgressTraceNed(Maapi maapi, String deviceId) Creates a new instance ofProgressTraceNed -
Uses of ConfException in com.tailf.util
Methods in com.tailf.util that throw ConfExceptionModifier and TypeMethodDescriptionvoidConfXMLParamToXML.serialize(Document doc, OutputStream out) Flushes the source documentdocto the targetout.voidFlushes the source documentdocto the targetoutConfXMLParamToXML.toXML(ConfXMLParam[] param) Transforms the supplied parameterConfXMLParam[]to a document (Document).ConfXMLParamToXML.toXML(ConfXMLParam[] param, boolean includeEmpty) Transforms the supplied parameterConfXMLParam[]to a document (Document).ConfXMLParamToXML.toXML(ConfXMLParam[] param, String parentNode, String parentURI) Transforms the suppliedConfXMLParam[]to a document (Document).ConfXMLParamToXML.toXML(ConfXMLParam[] param, String parentNode, String parentURI, boolean includeEmpty) Transforms the supplied parameterConfXMLParam[]to a document (Document).XMLtoConfXMLParam.toXMLParam()Converts the xml to corresponding ConfXMLParam[] The resulting ConfXMLParam[] is prepared for a getValues() call.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 usingXMLtoConfXMLParam.MODE_GETorXMLtoConfXMLParam.MODE_SETrespectively.Constructors in com.tailf.util that throw ConfExceptionModifierConstructorDescriptionXMLtoConfXMLParam(String xml, ConfPath path) Main constructor for initializing the xml parser.