Uses of Class
com.tailf.conf.ConfPath
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.
Annotations and proxy helper classes for callbacks.
Service callback specific context and utilities.
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.
The Common Alarm Management package contains common definitions that are
used within the alarm manager.
Network Equipment Drivers package
Utility classes for representing compiled ConfNamespaces.
-
Uses of ConfPath in com.tailf.cdb
Modifier and TypeMethodDescriptionvoid
Changes the working directory.void
Create a new optional element or list entry.void
Delete an optional element or list entry and all its child elements.boolean
Containers and leafs in a YANG model may be optional.Retrieve the currently selected case.This reads a a value from the path.CdbSubscription.getModifications
(int subid, CdbGetModificationFlag flag, ConfPath path) Deprecated.CdbSubscription.getModifications
(int subid, EnumSet<CdbGetModificationFlag> flags, ConfPath path) Retrieve changes that caused by subscription notification.Cdb.getMountId
(ConfPath path) CdbSubscription.getMountId
(ConfPath path) int
CdbSession.getNumberOfInstances
(ConfPath path) Returns the number of elements of a container type.Same functionality as getObject(numOfObjects, 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, ConfPath path) Same functionality as getObjects(numOfObjects, instance, fmt, arguments) but takes a already constructed ConfPath object as argument instead of fmt, arguments.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.int
Returns the position of a keyboolean
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.static ConfException
CdbException.mk
(ConfResponse r, ConfPath path) int
Returns the position of the next keyint
CdbSession.numInstances
(ConfPath path) Deprecated.in favor to getNumberOfInstances, which follows java naming conventions.void
Similar toCdbSession.cd(ConfPath)
but pushes the previous current directory on a stack.void
Same functionality as setCase(choice, scase, fmt, arguments) but takes a already constructed ConfPath object as argument instead of fmt, arguments.void
Sets an element in operational data.void
Set all elements corresponding to the complete contents of a container element, except for list entry sub-elements.void
CdbSession.setValues
(ConfXMLParam[] params, ConfPath path) Set arbitrary sub-elements of a container element.void
CdbSession.setValues
(List<ConfXMLParam> params, ConfPath path) -
Uses of ConfPath in com.tailf.conf
Modifier and TypeMethodDescriptionAppends suffix path to existing keypathConfPath.append
(String s, List<MaapiSchemas.CSNode> pathNodes) Appends suffix path to existing keypathConfPath.copyAppend
(String s) CopyAppends to the keypathConfPath.copyPop()
Creates a new ConfPath with the current path minus the last element including list keys.ConfWarning.getPath()
Modifier and TypeMethodDescriptionstatic ConfNamespace
ConfNamespace.findNamespaceFromNsName
(ConfPath path, MountIdInterface mountIdGetter, String namespaceName) static ConfNamespace
ConfNamespace.findNamespaceFromPrefix
(ConfPath path, MountIdInterface mountIdGetter, String prefix) 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 ConfEnumeration
ConfEnumeration.getEnumByLabel
(ConfPath path, String label) Get an ConfEnumeration from the string label at a given position in the schema.static String
ConfEnumeration.getLabelByEnum
(ConfPath path, ConfEnumeration e) Get the string label of an enumeration at a given position in the schema.MountIdInterface.getMountId
(ConfPath path) static String
ConfValue.getStringByValue
(ConfPath path, ConfValue val) Get the string representation of a ConfValue at a given position in the schema.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 ConfValue
ConfValue.getValueByString
(ConfPath path, String str) Get a ConfValue representation a string at a given position in the schema.static ConfNamespace
ConfNamespace.lookupNamespaceFromPrefix
(ConfPath path, MountIdInterface mountIdGetter, String prefix) static ConfException
ConfException.mk
(ConfResponse r, ConfPath errPath) 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[].ModifierConstructorDescriptionConfIdentityRef
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagname) ConfObjectRef
(ConfPath path) Construct a ConfObjectRef from a given Absolute ConfPath.ConfWarning
(ConfPath path, String message) ConfXMLParamCdbStart
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString, int cdbInstanceInteger) ConfXMLParamLeaf
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString) ConfXMLParamStart
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString) ConfXMLParamStartDel
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString) ConfXMLParamStop
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString) ConfXMLParamValue
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString, ConfObject val) -
Uses of ConfPath in com.tailf.dp
Modifier and TypeMethodDescriptionDpServiceCallback.postModification
(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque) Post modification callback If registered this method will be called after a CREATE, UPDATE or DELETE of the service.DpServiceCallback.preModification
(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque) Pre modification callback If registered this method will be called before a CREATE, UPDATE or DELETE of the service.void
Dp.registerAnnotatedRangeActionCallbacks
(Object obj, ConfValue[] lower, ConfValue[] higher, ConfPath path) void
Dp.registerAnnotatedRangeDataCallbacks
(Object obj, ConfValue[] lower, ConfValue[] higher, ConfPath path) DataCallbacks can be registered for a range of values using this methodvoid
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. -
Uses of ConfPath in com.tailf.dp.annotations
Modifier and TypeMethodDescriptionServiceCallbackProxy.postModification
(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque) ServiceCallbackProxy.preModification
(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque) -
Uses of ConfPath in com.tailf.dp.services
Modifier and TypeMethodDescriptionServiceContextImpl.getServicePath()
Returns a ConfPath object pointing the current service instance -
Uses of ConfPath in com.tailf.maapi
Modifier and TypeMethodDescriptionMaapi.getCwdPath
(int tid) Returns the current position like Maapi.getCwd(), but as a ConfPath instead of as a String.MaapiCursor.getPath()
Maapi.xpath2kpath
(String xpath) Convert a XPath path to a ConfPath object.Maapi.xpath2kpath_th
(int tid, String xpath) Modifier and TypeMethodDescriptionvoid
Maapi.clearOpCache
(ConfPath path) Request clearing of the operational data cache (see the Operational Data the User Guide).Maapi.CLIDiffCmd
(int thandle, int thandleOld, ConfPath path) Get the diff between two transactions as C-/I-style CLI commands.void
Deprecated.UseMaapi.copyTree(int, boolean, ConfPath, ConfPath)
instead.void
Deprecated.UseMaapi.copyTree(int, ConfPath, ConfPath)
instead.void
Similar toMaapi.copy(int, int)
, but does a replacing copy only of the subtree rooted at the path given bypath
void
This function is used to copy an entire subtree in the configuration from one point to another.void
Maapi.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/setvoid
Create an entity in the XML tree.void
Deletes a node and all its children from the XML data tree.void
Maapi.diffIterate
(int tid, Object initstate, EnumSet<DiffIterateFlags> flags, MaapiDiffIterate iter, ConfPath path) Iterates through the transaction diff.void
Maapi.event
(int tid, Maapi.Verbosity verbosity, String msg, ConfPath path, Attributes attributes) Create a progress event.boolean
Boolean function which return 1 or 0 if a path defines an existing element in the XML data tree.Maapi.getMountId
(int tid, ConfPath path) MaapiSchemas.getMountId
(MountIdInterface midif, ConfPath path) MountIdCb.getMountId
(ConfPath path) int
Maapi.getNumberOfInstances
(int tid, ConfPath path) <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.void
Maapi.iterate
(int tid, Object initstate, EnumSet<ConfIterateFlags> flags, MaapiIterate iter, ConfPath path) Iterates through all the data in a transaction.static ConfException
MaapiException.mk
(ConfResponse r, ConfPath path) void
Maapi.ncsApplyTemplate
(int tid, String template, ConfPath rootIKP, Properties variables, boolean createShared) void
Maapi.ncsApplyTemplate
(int tid, String template, ConfPath rootIKP, Properties variables, String document, boolean createShared) void
Maapi.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.Creates a cursor for a list specified bypath
Maapi.newCursorWithFilter
(int tid, String filter, ConfPath path) Creates a cursor for a list specified bypath
with an XPath filter specified byfilter
.void
MaapiSchemas.removeMountIdCachePath
(ConfPath path) void
Maapi.reportServiceProgress
(int tid, Maapi.Verbosity verbosity, String msg, String packageName, ConfPath servicePath) Deprecated.useProgressTrace
instead.Maapi.reportServiceProgressStart
(int tid, Maapi.Verbosity verbosity, String msg, String packageName, ConfPath servicePath) Deprecated.useProgressTrace
instead.void
Maapi.safeCreate
(int tid, ConfPath path) Create a new list entity in the XML tree.Maapi.safeGetElem
(int tid, ConfPath path) Reads a value from thepath
specifiedMaapi.saveConfig
(int tid, EnumSet<MaapiConfigFlag> flags, ConfPath path) Save the subtree in different formats.void
Maapi.setElem
(int tid, ConfObject value, ConfPath path) Set value to a leaf node.void
Set value to a leaf node.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, List<ConfXMLParam> params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation.void
Maapi.sharedCreate
(int tid, ConfPath path) This is the variant of create() to use from FASTMAP code.void
Maapi.sharedSetElem
(int tid, ConfObject value, ConfPath path) Set value to a leaf node from NCS FastMap code.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, List<ConfXMLParam> params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation from NCS FastMap code.Maapi.startSpan
(int tid, Maapi.Verbosity verbosity, String msg, ConfPath path, Attributes attributes, Span[] links) Create a progress span. -
Uses of ConfPath in com.tailf.ncs.alarmman.common
ModifierConstructorDescriptionManagedObject
(ConfPath value) Creates a ManagedObject as a ConfObjectRef defined from a ConfPath. -
Uses of ConfPath in com.tailf.ncs.template
Modifier and TypeMethodDescriptionvoid
Template.apply
(Maapi maapi, int tid, ConfPath rootPath, TemplateVariables variables) Apply a template in the specified context -
Uses of ConfPath in com.tailf.ned
Modifier and TypeMethodDescriptionNedWorker.getCurrentPath()
This method returns the current path associated with the action being processed.NedCmd.getPath()
NedEditOp.getPath()
NedTTL.getPath()
ConfPath[]
NedCmd.getPathIntent()
ConfPath[]
NedCmd.getPaths()
Modifier and TypeMethodDescriptionvoid
NedCliBase.showPartial
(NedWorker w, ConfPath[] paths) Extract parts of the configuration and send it to NCS.void
NedCliBase.showPartial
(NedWorker w, ConfPath[] paths, String[] cmdpaths) Extract parts of the configuration and send it to NCS.void
NedGenericBase.showPartial
(NedWorker w, int th, ConfPath[] paths) Read parts of the configuration and applies it to the transaction provided in the method invocation.void
NedConnectionBase.showStatsFilter
(NedWorker w, int th, ConfPath[] paths) When this method is invoked the NED should populate the provided transaction th with the data corresponding to the filter.void
NedConnectionBase.showStatsPath
(NedWorker w, int th, ConfPath path) When this method is invoked depending on the node type the NED should: * If the path points to the list node or leaf-list node without specifying the key, then the NED should populate the list keys. -
Uses of ConfPath in com.tailf.progress
Modifier and TypeMethodDescriptionvoid
ProgressTrace.setServicePath
(ConfPath servicePath) Set NSO's service pathModifierConstructorDescriptionProgressTrace
(Maapi maapi, int tid, ConfPath servicePath) Creates a new instance ofProgressTrace
. -
Uses of ConfPath in com.tailf.util
ModifierConstructorDescriptionXMLtoConfXMLParam
(String xml, ConfPath path) Main constructor for initializing the xml parser.