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.maapi |
MAAPI is an API which provides full access to the systems internal
transaction engine.
|
com.tailf.navu |
NAVU (Navigation Utilities) is an API which provides increased
accessibility to the ConfD/NCS populated data model tree:
NAVU-Tree.
|
com.tailf.ncs.alarmman.common |
The Common Alarm Management package contains common definitions that are
used within the alarm manager.
|
com.tailf.ncs.template | |
com.tailf.ned |
Network Equipment Drivers package
|
com.tailf.util |
Utility classes for representing compiled ConfNamespaces.
|
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.
|
List<String> |
Cdb.getMountId(ConfPath path) |
List<String> |
CdbSubscription.getMountId(ConfPath path) |
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) |
Modifier and Type | Class and Description |
---|---|
class |
ConfCdbUpgradePath
Class Representing a KeyPath path.
|
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 |
ConfPath.copyPop()
Creates a new ConfPath with the current path minus the last
element including list keys.
|
ConfPath |
ConfWarning.getPath() |
Modifier and Type | Method and Description |
---|---|
static 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.
|
List<String> |
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[].
|
Constructor and Description |
---|
ConfIdentityRef(ConfPath path,
MountIdInterface mountIdGetter,
String prefix,
String tagname) |
ConfObjectRef(ConfPath path)
Construct a ConfObjectRef from a given Absolute ConfPath.
|
ConfPath(ConfPath 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) |
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
|
void |
DpNotifStream.send(ConfDatetime time,
ConfXMLParam[] params,
ConfPath path)
Send a notification defined as a child of a container or list
in a YANG 1.1 module on this notification stream to ConfD/NCS.
|
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) |
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_th(int tid,
String xpath) |
ConfPath |
Maapi.xpath2kpath(String xpath)
Convert a XPath path to a ConfPath object.
|
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).
|
String |
Maapi.CLIDiffCmd(int thandle,
int thandleOld,
ConfPath path)
Get the diff between two transactions as C-/I-style CLI commands.
|
void |
Maapi.copy_tree(int tid,
boolean useSharedCreate,
ConfPath from,
ConfPath to)
Deprecated.
Use
Maapi.copyTree(int, boolean, ConfPath, ConfPath) instead. |
void |
Maapi.copy_tree(int tid,
ConfPath from,
ConfPath to)
Deprecated.
Use
Maapi.copyTree(int, ConfPath, ConfPath) instead. |
void |
Maapi.copyPath(int fromTh,
int toTh,
ConfPath path)
Similar to
Maapi.copy(int, int) , but does a replacing copy only
of the subtree rooted at the path given by path |
void |
Maapi.copyTree(int tid,
boolean useSharedCreate,
ConfPath from,
ConfPath to)
This function is used to copy an entire subtree in the configuration from
one point to another.
|
void |
Maapi.copyTree(int tid,
ConfPath from,
ConfPath to)
Equivalent to
Maapi#copyTree(int, false, ConfPath, ConfPath)
ie., for use outside fastmap, without 'shared' create/set |
void |
Maapi.create(int tid,
ConfPath path)
Create an entity in the XML tree.
|
void |
Maapi.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) |
List<String> |
MountIdCb.getMountId(ConfPath path) |
List<String> |
Maapi.getMountId(int tid,
ConfPath path) |
List<String> |
MaapiSchemas.getMountId(MountIdInterface midif,
ConfPath path) |
int |
Maapi.getNumberOfInstances(int tid,
ConfPath path) |
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
ConfPath path)
Read an arbitrary set of sub-elements of a container element.
|
<T extends List<ConfXMLParam>> |
Maapi.getValues(int tid,
T params,
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.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.
|
MaapiCursor |
Maapi.newCursor(int tid,
ConfPath path)
Creates a cursor for a list specified by
path |
MaapiCursor |
Maapi.newCursorWithFilter(int tid,
String filter,
ConfPath path)
Creates a cursor for a list specified by
path with an XPath
filter specified by filter . |
void |
MaapiSchemas.removeMountIdCachePath(ConfPath path) |
void |
Maapi.reportServiceProgress(int tid,
Maapi.Verbosity verbosity,
String msg,
String packageName,
ConfPath servicePath)
Report transaction progress events for a FASTMAP service.
|
Maapi.Progress |
Maapi.reportServiceProgressStart(int tid,
Maapi.Verbosity verbosity,
String msg,
String packageName,
ConfPath servicePath)
Report transaction progress events for a FASTMAP service.
|
void |
Maapi.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 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,
boolean createBackpointer,
ConfPath path)
Deprecated.
|
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 tid,
ConfXMLParam[] params,
boolean createBackpointer,
ConfPath path)
|
void |
Maapi.sharedSetValues(int tid,
ConfXMLParam[] params,
ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation
from NCS FastMap code.
|
void |
Maapi.sharedSetValues(int tid,
List<ConfXMLParam> params,
ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation
from NCS FastMap code.
|
Modifier and Type | Method and Description |
---|---|
ConfPath |
NavuNode.getConfPath()
Returns the corresponding ConfPath for the corresponding NavuNode.
|
Modifier and Type | Method and Description |
---|---|
NavuNode |
NavuAction.getNavuNode(ConfPath path) |
NavuNode |
NavuNode.getNavuNode(ConfPath path)
Retrieve a NavuNode based on the given absolute or relative
path.
|
static NavuNode |
KeyPath2NavuNode.getNode(ConfPath path,
NavuContext ctx) |
Constructor and Description |
---|
NavuParser(String xml,
MaapiSchemas.CSNode node,
ConfPath path,
int mode)
Constructor for the XML parser
The xml snippet must have root tag that corresponds to the root CSNode
The parser works in one of three modes:
NavuParser.MODE_GET |
Constructor and Description |
---|
ManagedObject(ConfPath value)
Creates a ManagedObject as a ConfObjectRef defined from a ConfPath.
|
Modifier and Type | Method and Description |
---|---|
void |
Template.apply(Maapi maapi,
int tid,
ConfPath rootPath,
TemplateVariables variables)
Apply a template in the specified context
|
Modifier and Type | Method and Description |
---|---|
ConfPath |
NedWorker.getCurrentPath()
This method returns the current path associated with the
action being processed.
|
ConfPath |
NedCmd.getPath() |
ConfPath |
NedEditOp.getPath() |
ConfPath |
NedTTL.getPath() |
ConfPath[] |
NedCmd.getPaths() |
Modifier and Type | Method and Description |
---|---|
void |
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 |
NedCliBaseTemplate.showStats(NedWorker worker,
int th,
ConfPath path) |
void |
NedConnectionBase.showStats(NedWorker w,
int th,
ConfPath path)
Deprecated.
|
void |
NedCliBaseTemplate.showStatsList(NedWorker worker,
int th,
ConfPath path) |
void |
NedConnectionBase.showStatsList(NedWorker w,
int th,
ConfPath path)
Deprecated.
|
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.
|
Constructor and Description |
---|
NedTTL(ConfPath path,
int ttl) |
Constructor and Description |
---|
XMLtoConfXMLParam(String xml,
ConfPath path)
Main constructor for initializing the xml parser.
|