Uses of Class
com.tailf.conf.ConfPath

Packages that use ConfPath

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.annotations	Annotations and proxy helper classes for callbacks.
com.tailf.dp.services	Service callback specific context and utilities.
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.util	Utility classes for representing compiled ConfNamespaces.

Uses of ConfPath in com.tailf.cdb

Methods in com.tailf.cdb with parameters of type ConfPath

Modifier and Type	Method and Description
void	CdbSession.cd(ConfPath path) Changes the working directory.
void	CdbSession.create(ConfPath path) Create a new optional element or list entry.
void	CdbSession.delete(ConfPath path) Delete an optional element or list entry and all its child elements.
boolean	CdbSession.exists(ConfPath path) Containers and leafs in a YANG model may be optional.
ConfObject	CdbSession.getCase(String choice, ConfPath path) Retrieve the currently selected case.
ConfValue	CdbSession.getElem(ConfPath path) This reads a a value from the path.
List<ConfXMLParam>	CdbSubscription.getModifications(int subid, CdbGetModificationFlag flag, ConfPath path) Deprecated.
List<ConfXMLParam>	CdbSubscription.getModifications(int subid, EnumSet<CdbGetModificationFlag> flags, ConfPath path) Retrieve changes that caused by subscription notification.
int	CdbSession.getNumberOfInstances(ConfPath path) Returns the number of elements of a container type.
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.
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.
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.
int	CdbSession.index(ConfPath path) Returns the position of a key
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.
static ConfException	CdbException.mk(ConfResponse r, ConfPath path)
int	CdbSession.nextIndex(ConfPath path) Returns the position of the next key
int	CdbSession.numInstances(ConfPath path) Deprecated. in favor to getNumberOfInstances, which follows java naming conventions. Returns the number of elements of a container type.
void	CdbSession.pushd(ConfPath path) Similar to CdbSession.cd(ConfPath) but pushes the previous current directory on a stack.
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	CdbSession.setElem(ConfValue value, ConfPath path) Sets an element in operational data.
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	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

Methods in com.tailf.conf that return ConfPath

Modifier and Type	Method and Description
ConfPath	ConfPath.append(String s) Appends suffix path to existing keypath
ConfPath	ConfPath.copyAppend(String s) CopyAppends to the keypath
ConfPath	ConfWarning.getPath()

Methods in com.tailf.conf with parameters of type ConfPath

Modifier and Type	Method and Description
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.
static String	ConfValue.getStringByValue(ConfPath path, ConfValue val) Get the string representation of a ConfValue at a given 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 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[].

Constructors in com.tailf.conf with parameters of type ConfPath

Constructor and Description
ConfObjectRef(ConfPath path) Construct a ConfObjectRef from a given Absolute ConfPath.
ConfWarning(ConfPath path, String message)

Uses of ConfPath in com.tailf.dp

Methods in com.tailf.dp with parameters of type ConfPath

Modifier and Type	Method and Description
Properties	DpServiceCallback.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.
Properties	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 method

Uses of ConfPath in com.tailf.dp.annotations

Methods in com.tailf.dp.annotations with parameters of type ConfPath

Modifier and Type	Method and Description
Properties	ServiceCallbackProxy.postModification(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque)
Properties	ServiceCallbackProxy.preModification(ServiceContext context, ServiceOperationType operation, ConfPath path, Properties opaque)

Uses of ConfPath in com.tailf.dp.services

Methods in com.tailf.dp.services that return ConfPath

Modifier and Type	Method and Description
ConfPath	ServiceContextImpl.getServicePath() Internal, subject to change without notice. Returns a ConfPath object pointing the current service instance

Uses of ConfPath in com.tailf.maapi

Methods in com.tailf.maapi that return ConfPath

Modifier and Type	Method and Description
ConfPath	Maapi.getCwdPath(int tid) Returns the current position like Maapi.getCwd(), but as a ConfPath instead of as a String.
ConfPath	MaapiCursor.getPath()
ConfPath	Maapi.xpath2kpath(String xpath) Convert a XPath path to a ConfPath object.

Methods in com.tailf.maapi with parameters of type ConfPath

Modifier and Type	Method and Description
void	Maapi.clearOpCache(ConfPath path) Request clearing of the operational data cache (see the Operational Data the User Guide).
void	Maapi.copy_tree(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.copy_tree(int tid, ConfPath from, ConfPath to)
void	Maapi.create(int tid, ConfPath path) Create an entity 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.diffIterate(int tid, Object initstate, EnumSet<DiffIterateFlags> flags, MaapiDiffIterate iter, ConfPath path) Iterates through the transaction diff.
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.
ConfTag	Maapi.getCase(int tid, String choice, ConfPath path)
ConfValue	Maapi.getElem(int tid, ConfPath path)
int	Maapi.getNumberOfInstances(int tid, ConfPath path)
<T extends ConfXMLParam> T[]	Maapi.getValues(int th, T[] params, ConfPath path) Read an arbitrary set of sub-elements of a container element.
<T extends List<ConfXMLParam>> T	Maapi.getValues(int th, T params, ConfPath path) Read 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.ncsApplyReverseDiffSet(int tid, ConfPath serviceIKP) Internal, subject to change without notice.
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)
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.
void	Maapi.ncsWriteServiceLogEntry(ConfPath serviceIKP, String msg, ConfIdentityRef type, ConfEnumeration level) Internal, subject to change without notice. NCS specific internal maapi function
MaapiCursor	Maapi.newCursor(int tid, ConfPath path) Creates a cursor for an list specified by fmt
void	Maapi.safeCreate(int tid, ConfPath path) Create a new list entity in the XML tree.
ConfValue	Maapi.safeGetElem(int tid, ConfPath path) Reads a value from the path specified
MaapiInputStream	Maapi.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	Maapi.setElem(int tid, String value, ConfPath path) Set value to a leaf node.
void	Maapi.setValues(int th, ConfXMLParam[] params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation.
void	Maapi.setValues(int th, List<ConfXMLParam> params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation.
void	Maapi.sharedCreate(int tid, boolean createBackpointer, ConfPath path) This is the variant of create() to use from FASTMAP code.
void	Maapi.sharedCreate(int tid, ConfPath path)
void	Maapi.sharedSetElem(int tid, ConfObject value, ConfPath path) Set value to a leaf node from NCS FastMap code.
void	Maapi.sharedSetValues(int th, ConfXMLParam[] params, boolean createBackpointer, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation from NCS FastMap code.
void	Maapi.sharedSetValues(int th, ConfXMLParam[] params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation from NCS FastMap code.
void	Maapi.sharedSetValues(int th, List<ConfXMLParam> params, ConfPath path) Set arbitrary sub-elements of a container element in one bulk operation from NCS FastMap code.

Uses of ConfPath in com.tailf.navu

Methods in com.tailf.navu that return ConfPath

Modifier and Type	Method and Description
ConfPath	NavuNode.getConfPath() Returns the corresponding ConfPath for the corresponding NavuNode.
ConfPath	IterationEntry.keyPath() Deprecated. Returns the keypath associated with the a completed iteration.

Methods in com.tailf.navu with parameters of type ConfPath

Modifier and Type	Method and Description
NavuNode	NavuNode.getNavuNode(ConfPath path) Retrieve a NavuNode based on the given absolute or relative path.
NavuNode	NavuAction.getNavuNode(ConfPath path)
static NavuNode	KeyPath2NavuNode.getNode(ConfPath path, NavuContext ctx)
NavuCdbSubscriber	NavuCdbSubscriber.register(NavuCdbDiffIterate cb, ConfPath path) Deprecated. Register a user provided callback with a specified path.
NavuCdbSubscriber	NavuCdbConfigSubscriber.register(NavuCdbDiffIterate cb, ConfPath path) Deprecated. Registers a subscription item onto the NavuCdbConfigSubscriber with a given user provided callback that will be invoked on Cdb notifications.
NavuCdbSubscriber	NavuCdbOperSubscriber.register(NavuCdbDiffIterate cb, ConfPath path) Deprecated. Registers a subscription item onto the this NavuCdbOperSubscriber with a given user provided callback that will be invoked on Cdb notifications.
NavuCdbSubscriber	NavuCdbSubscriber.register(NavuCdbDiffIterate cb, ConfPath path, EnumSet<DiffIterateFlags> diffIterFlags) Deprecated. Register a user provided callback with a specified path with additional iteration flags.
NavuCdbSubscriber	NavuCdbConfigSubscriber.register(NavuCdbDiffIterate cb, ConfPath path, EnumSet<DiffIterateFlags> flags) Deprecated. Registers a subscription item onto the NavuCdbConfigSubscriber with a given user provided callback that will be invoked on Cdb notifications.
NavuCdbSubscriber	NavuCdbOperSubscriber.register(NavuCdbDiffIterate cb, ConfPath path, EnumSet<DiffIterateFlags> flags) Deprecated. Registers a subscription item onto the this NavuCdbOperSubscriber with a given user provided callback that will be invoked on Cdb notifications.

Uses of ConfPath in com.tailf.util

Constructors in com.tailf.util with parameters of type ConfPath

Constructor and Description
XMLtoConfXMLParam(String xml, ConfPath path) Main constructor that for initializing the xml parser.