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.ned |
Network Equipment Drivers package
|
com.tailf.notif |
Package for subscription to asynchronous events.
|
com.tailf.util |
Utility classes for representing compiled ConfNamespaces.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
CdbUpgradeSession.getValues(ConfXMLParam[] params,
ConfCdbUpgradePath path) |
ConfXMLParam[] |
CdbSession.getValues(ConfXMLParam[] params,
ConfPath path)
Same functionality as getValues(params, fmt, arguments) but takes a
already constructed ConfPath object as argument instead of fmt,
arguments.
|
ConfXMLParam[] |
CdbUpgradeSession.getValues(ConfXMLParam[] params,
String fmt,
Object... arguments) |
ConfXMLParam[] |
CdbSession.getValues(ConfXMLParam[] params,
String fmt,
Object... arguments)
Read an arbitrary set of sub-elements of a container element.
|
Modifier and Type | Method and Description |
---|---|
List<ConfXMLParam> |
CdbSubscription.getModifications(CdbGetModificationFlag flag)
Deprecated.
|
List<ConfXMLParam> |
CdbSubscription.getModifications(EnumSet<CdbGetModificationFlag> flags)
Retrieve changes that caused by subscription notification.
|
List<ConfXMLParam> |
CdbSubscription.getModifications(int subid,
CdbGetModificationFlag flag,
ConfPath path)
Deprecated.
|
List<ConfXMLParam> |
CdbSubscription.getModifications(int subid,
CdbGetModificationFlag flag,
String fmt,
Object... args)
Deprecated.
|
List<ConfXMLParam> |
CdbSubscription.getModifications(int subid,
EnumSet<CdbGetModificationFlag> flags,
ConfPath path)
Retrieve changes that caused by subscription notification.
|
List<ConfXMLParam> |
CdbSubscription.getModifications(int subid,
EnumSet<CdbGetModificationFlag> flags,
String fmt,
Object... args)
Retrieve changes that caused by subscription notification.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
CdbUpgradeSession.getValues(ConfXMLParam[] params,
ConfCdbUpgradePath path) |
ConfXMLParam[] |
CdbSession.getValues(ConfXMLParam[] params,
ConfPath path)
Same functionality as getValues(params, fmt, arguments) but takes a
already constructed ConfPath object as argument instead of fmt,
arguments.
|
ConfXMLParam[] |
CdbUpgradeSession.getValues(ConfXMLParam[] params,
String fmt,
Object... arguments) |
ConfXMLParam[] |
CdbSession.getValues(ConfXMLParam[] params,
String fmt,
Object... arguments)
Read an arbitrary set of sub-elements of a container element.
|
void |
CdbUpgradeSession.setValues(ConfXMLParam[] params,
ConfCdbUpgradePath path) |
void |
CdbSession.setValues(ConfXMLParam[] params,
ConfPath path)
Set arbitrary sub-elements of a container element.
|
void |
CdbUpgradeSession.setValues(ConfXMLParam[] params,
String fmt,
Object... arguments) |
void |
CdbSession.setValues(ConfXMLParam[] params,
String fmt,
Object... arguments)
similar to
CdbSession.setValues(ConfXMLParam[], ConfPath) but specifies
element using path string |
Modifier and Type | Method and Description |
---|---|
void |
CdbSession.setValues(List<ConfXMLParam> params,
ConfPath path) |
Modifier and Type | Class and Description |
---|---|
class |
ConfXMLParamCdbStart
Identifies a starting point in the model from which other parameters are
relatively defined (used in CDB).
|
class |
ConfXMLParamLeaf
Identifies a leaf parameter.
|
class |
ConfXMLParamStart
Identifies a starting point in the model from which other parameters are
relatively defined.
|
class |
ConfXMLParamStartDel
Identifies a starting point in the model for a list item that should be
deleted.
|
class |
ConfXMLParamStop
Identifies the end point for parameter definitions.
|
class |
ConfXMLParamValue
Identifies a parameter with its value.
|
Modifier and Type | Method and Description |
---|---|
static ConfXMLParam |
ConfXMLParam.decodeParam(ConfEObject o)
Decode the internal representation to a
ConfXMLParam
Used internally. |
static ConfXMLParam[] |
ConfXMLParam.decodeParams(ConfEObject o) |
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[].
|
Modifier and Type | Method and Description |
---|---|
static ConfEObject |
ConfXMLParam.encode(ConfXMLParam[] params) |
static ConfEObject |
ConfXMLParam.encode(List<String> mountId,
ConfXMLParam[] params) |
static ConfEObject |
ConfXMLParam.encodeHKP(ConfXMLParam[] params) |
static ConfEObject |
ConfXMLParam.encodeHKP(List<String> mountId,
ConfXMLParam[] params) |
static ConfEObject |
ConfXMLParam.encodeIKP(ConfXMLParam[] params) |
static ConfEObject |
ConfXMLParam.encodeIKP(List<String> mountId,
ConfXMLParam[] params) |
static Document |
ConfXMLParam.toDOM(ConfXMLParam[] params)
Return String
DOM document representation of a
(Conf)XML-structure. |
static Document |
ConfXMLParam.toDOM(ConfXMLParam[] params,
String parentNode,
String parentURI)
Return String
DOM representation of a
(Conf)XML-structure. |
static String |
ConfXMLParam.toXML(ConfXMLParam[] params)
Return String XML representation of a (Conf)XML-structure.
|
static String |
ConfXMLParam.toXML(ConfXMLParam[] params,
String parentNode,
String parentURI)
Return String XML representation of a (Conf)XML-structure.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
DpActionCallback.action(DpActionTrans actx,
ConfTag name,
ConfObject[] kp,
ConfXMLParam[] params)
The action() callback receives all the parameters pertaining to the
action: The name argument is a pointer to the action name as defined in
YANG model, the kp argument gives the path through the XML
tree, and finally the params argument is a representation of the
params element of the XML instance document provided with the invocation.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
DpActionCallback.action(DpActionTrans actx,
ConfTag name,
ConfObject[] kp,
ConfXMLParam[] params)
The action() callback receives all the parameters pertaining to the
action: The name argument is a pointer to the action name as defined in
YANG model, the kp argument gives the path through the XML
tree, and finally the params argument is a representation of the
params element of the XML instance document provided with the invocation.
|
void |
DpNotifStream.send(ConfDatetime time,
ConfXMLParam params)
Send a notification defined at the top level of a YANG module
on this notification stream to ConfD/NCS.
|
void |
DpNotifStream.send(ConfDatetime time,
ConfXMLParam[] params)
Send a notification defined at the top level of a YANG module
on this notification stream to ConfD/NCS.
|
void |
DpNotifStream.send(ConfDatetime time,
ConfXMLParam[] params,
ConfPath path)
Send a notification defined as a child of a container or list
in a YANG 1.1 module on this notification stream to ConfD/NCS.
|
void |
DpNotifStream.send(ConfDatetime time,
ConfXMLParam[] params,
String fmt,
Object... arguments)
Send a notification defined as a child of a container or list
in a YANG 1.1 module on this notification stream to ConfD/NCS.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
ActionCallbackProxy.action(DpActionTrans actx,
ConfTag name,
ConfObject[] kp,
ConfXMLParam[] params) |
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
ActionCallbackProxy.action(DpActionTrans actx,
ConfTag name,
ConfObject[] kp,
ConfXMLParam[] params) |
Modifier and Type | Method and Description |
---|---|
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
ConfPath path)
Read an arbitrary set of sub-elements of a container element.
|
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
String fmt,
Object... arguments)
Read an arbitrary set of sub-elements of a container element.
|
<T extends List<ConfXMLParam>> |
Maapi.getValues(int tid,
T params,
ConfPath path)
Read an arbitrary set of sub-elements of a container element.
|
<T extends List<ConfXMLParam>> |
Maapi.getValues(int tid,
T params,
String fmt,
Object... arguments)
Read an arbitrary set of sub-elements of a container element.
|
Modifier and Type | Method and Description |
---|---|
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
ConfPath path)
Read an arbitrary set of sub-elements of a container element.
|
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
String fmt,
Object... arguments)
Read an arbitrary set of sub-elements of a container element.
|
ConfXMLParam[] |
Maapi.requestAction(ConfXMLParam[] params,
int nshash,
String fmt,
Object... arguments)
Same as
Maapi.requestAction(ConfXMLParam[], String, Object...)
Since actions are not associated with transactions, the
namespace hash nshash must be provided and the path
to the action, i.e. |
ConfXMLParam[] |
Maapi.requestAction(ConfXMLParam[] params,
String fmt,
Object... arguments)
Invokes an action defined in the data model annotated with
tailf:action (see tailf_yang_extensions(5)). |
ConfXMLParam[] |
Maapi.requestAction(List<ConfXMLParam> params,
int nshash,
String fmt,
Object... arguments) |
ConfXMLParam[] |
Maapi.requestAction(List<ConfXMLParam> params,
String fmt,
Object... arguments)
Same as
Maapi.requestAction(ConfXMLParam[], String, Object...)
with the difference that the params is List
instead of ConfXMLParam array. |
ConfXMLParam[] |
Maapi.requestActionTh(int tid,
ConfXMLParam[] params,
String fmt,
Object... arguments)
Same as
Maapi.requestAction(ConfXMLParam[], String, Object...)
with the difference that the fmt is not required to have a namespace
prefix in the root tag. |
ConfXMLParam[] |
Maapi.requestActionTh(int tid,
List<ConfXMLParam> params,
String fmt,
Object... arguments) |
ConfXMLParam |
ResultTypeTag.tag()
Retrieves the result tag from a query
|
Modifier and Type | Method and Description |
---|---|
List<ConfXMLParam> |
CommitParams.getConfXMLParam() |
Modifier and Type | Method and Description |
---|---|
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
ConfPath path)
Read an arbitrary set of sub-elements of a container element.
|
<T extends ConfXMLParam> |
Maapi.getValues(int tid,
T[] params,
String fmt,
Object... arguments)
Read an arbitrary set of sub-elements of a container element.
|
ConfXMLParam[] |
Maapi.requestAction(ConfXMLParam[] params,
int nshash,
String fmt,
Object... arguments)
Same as
Maapi.requestAction(ConfXMLParam[], String, Object...)
Since actions are not associated with transactions, the
namespace hash nshash must be provided and the path
to the action, i.e. |
ConfXMLParam[] |
Maapi.requestAction(ConfXMLParam[] params,
String fmt,
Object... arguments)
Invokes an action defined in the data model annotated with
tailf:action (see tailf_yang_extensions(5)). |
ConfXMLParam[] |
Maapi.requestActionTh(int tid,
ConfXMLParam[] params,
String fmt,
Object... arguments)
Same as
Maapi.requestAction(ConfXMLParam[], String, Object...)
with the difference that the fmt is not required to have a namespace
prefix in the root tag. |
void |
Maapi.setValues(int tid,
ConfXMLParam[] params,
ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation.
|
void |
Maapi.setValues(int tid,
ConfXMLParam[] params,
String fmt,
Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation.
|
void |
Maapi.sharedSetValues(int tid,
ConfXMLParam[] params,
boolean createBackpointer,
ConfPath path)
|
void |
Maapi.sharedSetValues(int tid,
ConfXMLParam[] params,
ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation
from NCS FastMap code.
|
void |
Maapi.sharedSetValues(int tid,
ConfXMLParam[] params,
String fmt,
Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation
from NCS FastMap code.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
Maapi.requestAction(List<ConfXMLParam> params,
int nshash,
String fmt,
Object... arguments) |
ConfXMLParam[] |
Maapi.requestAction(List<ConfXMLParam> params,
String fmt,
Object... arguments)
Same as
Maapi.requestAction(ConfXMLParam[], String, Object...)
with the difference that the params is List
instead of ConfXMLParam array. |
ConfXMLParam[] |
Maapi.requestActionTh(int tid,
List<ConfXMLParam> params,
String fmt,
Object... arguments) |
void |
Maapi.setValues(int tid,
List<ConfXMLParam> params,
ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation.
|
void |
Maapi.setValues(int tid,
List<ConfXMLParam> params,
String fmt,
Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation.
|
void |
Maapi.sharedSetValues(int tid,
List<ConfXMLParam> params,
ConfPath path)
Set arbitrary sub-elements of a container element in one bulk operation
from NCS FastMap code.
|
void |
Maapi.sharedSetValues(int tid,
List<ConfXMLParam> params,
String fmt,
Object... arguments)
Set arbitrary sub-elements of a container element in one bulk operation
from NCS FastMap code.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
NavuAction.call()
Issues an action with empty parameters
|
ConfXMLParam[] |
NavuAction.call(ConfXMLParam[] params)
Issues an action call with given parameters
|
ConfXMLParam[] |
NavuAction.call(String xml)
Issues an action call with given parameter
|
ConfXMLParam[] |
PreparedXMLStatement.getConfXMLParams() |
ConfXMLParam[] |
NavuNode.getValues(ConfXMLParam[] params)
Read an arbitrary set of sub-elements from this
NavuNode . |
ConfXMLParam[] |
NavuAction.getValues(ConfXMLParam[] param)
Invokes or call an action defined in the data model (see
tailf_yang_extensions(5) ). |
ConfXMLParam[] |
NavuNode.getValues(String xml)
Read an arbitrary set of sub-elements of a container or list entry.
|
ConfXMLParam[] |
NavuLeaf.getValues(String xml) |
ConfXMLParam[] |
NavuAction.getValues(String xml)
Invokes or call an action defined in the data model (see
tailf_yang_extensions(5) ). |
ConfXMLParam[] |
NavuNode.getXml(String xml)
Deprecated.
|
ConfXMLParam[] |
NavuParser.parse()
Parses the xml and produces ConfXMLParam[]
|
Modifier and Type | Method and Description |
---|---|
abstract List<ConfXMLParam> |
NavuNode.encodeValues()
Encodes the sub-tree including the current
NavuNode
as the topmost NavuNode as a ConfXMLParam array. |
List<ConfXMLParam> |
NavuList.encodeValues() |
List<ConfXMLParam> |
NavuLeaf.encodeValues() |
List<ConfXMLParam> |
NavuContainer.encodeValues() |
List<ConfXMLParam> |
NavuAction.encodeValues() |
abstract List<ConfXMLParam> |
NavuNode.encodeXML()
Encodes the sub-tree including the current
NavuNode
as the topmost NavuNode as a ConfXMLParam array. |
List<ConfXMLParam> |
NavuList.encodeXML() |
List<ConfXMLParam> |
NavuLeaf.encodeXML() |
List<ConfXMLParam> |
NavuContainer.encodeXML() |
List<ConfXMLParam> |
NavuAction.encodeXML() |
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
NavuAction.call(ConfXMLParam[] params)
Issues an action call with given parameters
|
ConfXMLParam[] |
NavuNode.getValues(ConfXMLParam[] params)
Read an arbitrary set of sub-elements from this
NavuNode . |
ConfXMLParam[] |
NavuAction.getValues(ConfXMLParam[] param)
Invokes or call an action defined in the data model (see
tailf_yang_extensions(5) ). |
void |
NavuNode.setValues(ConfXMLParam[] params)
Set arbitrary sub-elements of a container or list entry.
|
void |
NavuNode.sharedSetValues(ConfXMLParam[] params)
Set arbitrary sub-elements of a container or list entry
with FastMap support, creating backpointers and reference counter.
|
Constructor and Description |
---|
PreparedXMLStatement(ConfXMLParam[] params,
Map<Integer,Object[]> paramInfoMap,
NavuNode node) |
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
NedCmd.getParams() |
ConfXMLParam[] |
NedConnectionBase.getSystemStateData() |
Modifier and Type | Method and Description |
---|---|
abstract void |
NedConnectionBase.command(NedWorker w,
String cmdName,
ConfXMLParam[] params)
This is for any optional commands on the device that are
not part of the yang files config data, but is modeled as
tailf:actions or rpcs in the device yang files.
|
void |
NedCliBaseTemplate.command(NedWorker worker,
String cmdname,
ConfXMLParam[] p) |
void |
NedWorker.commandResponse(ConfXMLParam[] reply)
This method is called by the NED to indicate that the
command method has been successfully completed when the NED
also has a reply.
|
void |
NedConnectionBase.setPlatformData(ConfXMLParam[] platformData)
This function is used to set the platform operational data for
a specific NED.
|
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
StreamNotification.getValues() |
Constructor and Description |
---|
StreamNotification(int stream_event_type,
ConfDatetime event_time,
ConfXMLParam[] values,
String error) |
Modifier and Type | Method and Description |
---|---|
ConfXMLParam[] |
XMLtoConfXMLParam.toXMLParam()
Converts the xml to corresponding ConfXMLParam[]
The resulting ConfXMLParam[] is prepared for a getValues() call.
|
ConfXMLParam[] |
XMLtoConfXMLParam.toXMLParam(int mode)
Converts the xml to corresponding ConfXMLParam[]
The mode parameter controls whether this ConfXMLParam[] should be
prepared for a getValues() call or for a setValues() call using
using
XMLtoConfXMLParam.MODE_GET or XMLtoConfXMLParam.MODE_SET respectively. |
Modifier and Type | Method and Description |
---|---|
Document |
ConfXMLParamToXML.toXML(ConfXMLParam[] param)
Transforms the supplied parameter
ConfXMLParam[]
to a document (Document ). |
Document |
ConfXMLParamToXML.toXML(ConfXMLParam[] param,
boolean includeEmpty)
Transforms the supplied parameter
ConfXMLParam[]
to a document (Document ). |
Document |
ConfXMLParamToXML.toXML(ConfXMLParam[] param,
String parentNode,
String parentURI)
Transforms the supplied
ConfXMLParam[]
to a document (Document ). |
Document |
ConfXMLParamToXML.toXML(ConfXMLParam[] param,
String parentNode,
String parentURI,
boolean includeEmpty)
Transforms the supplied parameter
ConfXMLParam[]
to a document (Document ). |