Uses of Class
com.tailf.conf.ConfObject
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.
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.
Network Equipment Drivers package
Package for subscription to asynchronous events.
-
Uses of ConfObject in com.tailf.cdb
Modifier and TypeMethodDescriptionRetrieve the currently selected case.Retrieve the currently selected case.CdbUpgradeSession.getCase
(String choice, ConfCdbUpgradePath path) CdbSession.getcwdPath()
Returns the current position as previously set byCdbSession.cd(ConfPath)
,CdbSession.pushd(ConfPath)
, orCdbSession.popd()
as aConfObject
array.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) Modifier and TypeMethodDescriptionCdbDiffIterate.iterate
(ConfObject[] kp, DiffIterateOperFlag op, ConfObject oldValue, ConfObject newValue, Object initstate) Iterate through a set of changes -
Uses of ConfObject in com.tailf.conf
Modifier and TypeClassDescriptionclass
Class that represents an attribute value for an element in a model.class
DATA_CONTAINER - Corresponds to the YANG tailf:hex-list and tailf:octet-list.class
DATA_CONTAINER - Corresponds to the YANG bit32 type.class
DATA_CONTAINER - Corresponds to the YANG bit64 type.class
DATA_CONTAINER - Corresponds to the YANG bits type, where bit position exceed 63.class
DATA_CONTAINER - This is the superclass for all bits types i.e.class
DATA_CONTAINER - Corresponds to the YANG boolean type.class
DATA_CONTAINER - Corresponds to the YANG string type.class
DATA_CONTAINER - Corresponds to the confspec xs:date type.class
DATA_CONTAINER - Corresponds to the YANG date-and-time type.class
DATA_CONTAINER - Corresponds to the YANG decimal64 type.class
Class representing value of type J_DEFAULT.class
DATA_CONTAINER - Corresponds to the YANG dotted-quad type.class
DATA_CONTAINER - Corresponds to the confspec xs:double type.class
DATA_CONTAINER - Corresponds to the confspec xs:duration type.class
DATA_CONTAINER - Corresponds to the YANG Enumeration type.class
DATA_CONTAINER - Corresponds to the confspec xs:float type.class
DATA_CONTAINER - Corresponds to the YANGtailf:hex-list
type.class
DATA_CONTAINER - Corresponds to the YANGhex-string
type.class
DATA_CONTAINER - Corresponds to the YANG identityRef type.class
DATA_CONTAINER - Corresponds to the YANG int16 type.class
DATA_CONTAINER - Corresponds to the YANG int32 type.class
DATA_CONTAINER - Corresponds to the YANG int64 type.class
DATA_CONTAINER - Corresponds to the YANG int8 type.class
DATA_CONTAINER - Base class for ConfIPv4 and ConfIPv6 containersclass
DATA_CONTAINER - Base class for ConfIPv4AndPrefixLen and ConfIPv6AndPrefixLen containersclass
DATA_CONTAINER - Base class for ConfIPv4Prefix and ConfIPv6Prefix containersclass
DATA_CONTAINER - Corresponds to the YANG inet:ipv4-address type.class
DATA_CONTAINER - Corresponds to the YANG tailf:ipv4-address-and-prefix-length type.class
DATA_CONTAINER - Corresponds to the YANG inet:ipv4-prefix type.class
DATA_CONTAINER - Corresponds to the YANG inet:ipv6-address type.class
DATA_CONTAINER - Corresponds to the YANG tailf:ipv6-address-and-prefix-length type.class
DATA_CONTAINER - Corresponds to the YANG inet:ipv6-prefix type.class
This class represents a list key or a leaf-list element.class
DATA_CONTAINER - Corresponds to the YANG leaf-list.class
Class representing value of type J_NOEXISTS.class
Corresponds to the YANG instance-identifier typeclass
DATA_CONTAINER - Corresponds to the YANG tailf:octet-list type.class
DATA_CONTAINER - Corresponds to the YANG tailf:oid type.class
DATA_CONTAINER - Corresponds to the confspec xs:qName type.class
Class representing an element in a model.class
Class representing an element in a model.class
DATA_CONTAINER - Corresponds to the confspec xs:time type.class
Conf value type descriptor.class
DATA_CONTAINER - Corresponds to the YANG uint16 typeclass
DATA_CONTAINER - Corresponds to the YANG uint32 typeclass
DATA_CONTAINER - Corresponds to the YANG uint64 typeclass
DATA_CONTAINER - Corresponds to the YANG uint8 typeclass
Base class of the DATA_CONTAINERConf<datatype>
classes.class
class
Represents the base class of a flat XML structure.class
Identifies a starting point in the model from which other parameters are relatively defined (used in CDB).class
Identifies a leaf parameter.class
Identifies a starting point in the model from which other parameters are relatively defined.class
Identifies a starting point in the model for a list item that should be deleted.class
Identifies the end point for parameter definitions.class
Identifies a parameter with its value.class
DATA_CONTAINER - Corresponds to the confspec XML Tag.Modifier and TypeMethodDescriptionstatic ConfObject
ConfObject.decode
(ConfEObject o) ConfKey.elementAt
(int i) ConfKey.elements()
ConfList.elements()
Return a copy as array of thisConfList.get
(int index) ConfObjectRef.getElems()
ConfUserInfo.getIpValue()
Get User session IP address as ConfIPv4 or ConfIPv6 respectivelyCompiler.getKP()
ConfXPath.getKP()
Returns an array ofConfTag
andConfKey
objects which represents the path in reverted order.InstancePath.getKP()
Returns an array ofConfTag
andConfKey
objects which represents the path in reverted order.XPathAbrevCompiler.getKP()
ConfCLIToken.getObject()
ConfXMLParam.getValue()
Returns the value for this parameter.static ConfObject[]
ConfInternal.hk_keypath
(ConfEObject term) Create a hkeypath from a term.static ConfObject[]
ConfInternal.mk_keypath
(ConfEObject term, ArrayList<ConfNamespace> ns_list) Makes a keypath from a term.ConfList.set
(int index, ConfObject val) Modifier and TypeMethodDescriptionvoid
ConfList.addElem
(ConfObject n) Add an element in the end of this ConfList unless it already existsvoid
ConfList.delete
(ConfObject n) Delete arbitrary object from the ConfListstatic ConfTypeDescriptor
ConfTypeDescriptor.getConfTypeDescriptor
(ConfObject o) Generates a ConfTypeDescriptor representing the type of a specified ConfObject.boolean
ConfList.isMember
(ConfObject o) static String
Conf.kpToString
(ConfObject[] kp) Converts a keypath Object[] kp into a string.void
ConfList.move
(ConfObject n, ConfList.WhereTo where, ConfObject to) Move a list element to a new position in the list.ConfList.set
(int index, ConfObject val) void
ConfUserInfo.setIpValue
(ConfObject ipValue) Internally used set methodvoid
ConfXMLParamValue.setValue
(ConfObject value) ModifierConstructorDescriptionConfCLIToken
(ConfObject obj, ConfBuf value) ConfKey
(ConfObject[] l) ConfList
(ConfObject[] l) ConfObjectRef
(ConfObject[] elems) Constructor using the autoloaded namespaces.ConfPath
(Cdb cdb, ConfObject[] kp) ConfPath
(ConfObject[] kp) Initializes a new instance of this class from a given reverted ConfObject[] keypath where elements is eitherConfTag
orConfKey
.ConfPath
(MountIdInterface mountIdCb, ConfObject[] kp) ConfPath
(Maapi maapi, int tid, ConfObject[] kp) ConfXKey
(ConfObject[] vals, Map<MaapiSchemas.CSNode, ConfValue> keyEntries) ConfXMLParamValue
(int ns, int tag, ConfObject val) ConfXMLParamValue
(ConfNamespace namespace, String tagString, ConfObject val) ConfXMLParamValue
(ConfPath path, MountIdInterface mountIdGetter, String prefix, String tagString, ConfObject val) ConfXMLParamValue
(String prefix, String tagString, ConfObject val) InstancePath
(ConfObject[] kp) Initializes a new instance of this class from a given reverted ConfObject[] keypath where elements is eitherConfTag
orConfKey
.InstancePath
(MountIdInterface mountGetter, ConfObject[] kp) -
Uses of ConfObject in com.tailf.dp
Modifier and TypeFieldDescriptionDpListFilter.node
Node to use when type isListFilterType.CONFD_LF_CMP
,ListFilterType.CONFD_LF_EXEC
orListFilterType.CONFD_LF_EXISTS
DpListFilter.val
Value to use when type isListFilterType.CONFD_LF_CMP
orListFilterType.CONFD_LF_EXEC
orListFilterType.CONFD_LF_ORIGIN
Modifier and TypeMethodDescriptionDpDataCallback.getCase
(DpTrans trans, ConfObject[] kp, ConfObject[] choice) This callback method needs to return the currently chosen 'case' for a 'choice' construct.DpUserInfo.getIPAddress()
Get User session IP address as ConfIPv4 or ConfIPv6 respectivelyDpDataCallback.getIteratorObject
(DpTrans trans, ConfObject[] kp, Object obj) The following callback is used with the iterators above.DpAccumulate.getKP()
The keypath consisting of an array of ConfTag and/or ConfKey objects.DpDataCallback.getObject
(DpTrans trans, ConfObject[] kp) The purpose of the callback is to return an array of values, corresponding to a complete list entry in one swoop.Modifier and TypeMethodDescriptionDpActionCallback.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.DpAuthorizationCallback.checkDataAccess
(DpAuthorizationContext context, ConfObject[] kp, AuthorizationOperCheck operation, AuthorizationOperCheck how) DpActionCallback.completion
(DpActionTrans actx, char cliStyle, String token, char completionChar, ConfObject[] kp, String cmdPath, String cmdParamId, ConfQname simpleType, String extra) The completion() callback is invoked for CLI completion and information.int
DpDataCallback.create
(DpTrans trans, ConfObject[] kp) This callback creates a new presence container, list entry or empty leaf.boolean
DpDataCallback.existsOptional
(DpTrans trans, ConfObject[] kp) If we have presence containers or optional leafs (empty leafs) without a type, we cannot use the getElem() callback to read such a leaf - since the element is typeless.DpDataFindNextIterator.findNext
(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key) This method is called by Dp when a FIND_NEXT or a FIND_NEXT_OBJECT call is issued.int
DpDataCallback.getAttrs
(DpTrans trans, ConfObject[] kp, List<ConfAttributeValue> attrList) This callback only needs to be implemented for callpoints specified for configuration data, and only if attributes are enabled in the server configuration (/confdConfig/enableAttributes set to true).DpDataCallback.getCase
(DpTrans trans, ConfObject[] kp, ConfObject[] choice) This callback method needs to return the currently chosen 'case' for a 'choice' construct.DpDataCallback.getElem
(DpTrans trans, ConfObject[] kp) This callback method needs to return a specific leaf value.DpDataCallback.getIteratorKey
(DpTrans trans, ConfObject[] kp, Object obj) The following callback is used with the iterators above.DpDataCallback.getIteratorObject
(DpTrans trans, ConfObject[] kp, Object obj) The following callback is used with the iterators above.List<ConfObject[]>
DpDataCallback.getIteratorObjectList
(DpTrans trans, ConfObject[] kp, Object obj, Iterator<? extends Object> iterator) This callback is used in place of getIteratorObject when aList
of objects is requested rather than a single instance.DpDataCallback.getObject
(DpTrans trans, ConfObject[] kp) The purpose of the callback is to return an array of values, corresponding to a complete list entry in one swoop.DpDataCallback.iterator
(DpTrans trans, ConfObject[] kp) This callback makes it possible for ConfD/NCS to traverse a set of list entries.DpDataCallback.iterator
(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key) This iterator method is a specialization ofDpDataCallback.iterator(DpTrans, ConfObject[])
in that it returns an extended iterator i.e.DpDataCallback.iterator
(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key, DpListFilter filter) Variant of the DpDataFindNextIterator-returning iterator above that may receive a DpListFilter instance which can be used to filter the list.DpDataCallback.iterator
(DpTrans trans, ConfObject[] kp, DpListFilter filter) Variant of iterator that may receive a DpListFilter which can be used to filter the list.void
DpDbCallback.lockPartial
(DpDbContext dbx, int dbname, int lockid, ConfObject[][] paths) This should only be implemented if our database supports locking from other sources than through ConfD, seeDpDbCallback.lock(DpDbContext,int)
above.int
DpDataCallback.moveAfter
(DpTrans trans, ConfObject[] kp, ConfKey prevkey) This callback only needs to be implemented if we provide configuration data that has YANG lists with a ordered-by user statement.int
DpDataCallback.numInstances
(DpTrans trans, ConfObject[] kp) This callback can optionally be implemented.int
DpDataCallback.remove
(DpTrans trans, ConfObject[] kp) This callback is used to remove a presence container, list entry or empty leaf and all its sub elements.int
DpDataCallback.setAttr
(DpTrans trans, ConfObject[] kp, ConfAttributeValue attr) This callback also only needs to be implemented for callpoints specified for configuration data, and only if attributes are enabled in the server configuration (/confdConfig/enableAttributes set to true).int
DpDataCallback.setCase
(DpTrans trans, ConfObject[] kp, ConfObject[] choice, ConfTag caseval) This callback method sets the currently chosen 'case' for a 'choice' construct.int
DpDataCallback.setElem
(DpTrans trans, ConfObject[] kp, ConfValue newval) This callback writes a data leaf.void
DpValpointCallback.validate
(DpTrans trans, ConfObject[] kp, ConfValue newval) The validate() callback should validate the values and throw aDpCallbackException
if the validation fails.int
DpDataCallback.writeAll
(DpTrans trans, ConfObject[] kp) This callback method sets the currently chosen 'case' for a 'choice' construct. -
Uses of ConfObject in com.tailf.dp.annotations
Modifier and TypeMethodDescriptionDataCallbackProxy.getCase
(DpTrans trans, ConfObject[] kp, ConfObject[] choice) DataCallbackProxy.getIteratorObject
(DpTrans trans, ConfObject[] kp, Object obj) DataCallbackProxy.getObject
(DpTrans trans, ConfObject[] kp) Modifier and TypeMethodDescriptionActionCallbackProxy.action
(DpActionTrans actx, ConfTag name, ConfObject[] kp, ConfXMLParam[] params) AuthorizationCallbackProxy.checkDataAccess
(DpAuthorizationContext context, ConfObject[] kp, AuthorizationOperCheck operation, AuthorizationOperCheck how) ActionCallbackProxy.completion
(DpActionTrans actx, char cliStyle, String token, char completionChar, ConfObject[] kp, String cmdPath, String cmdParamId, ConfQname simpleType, String extra) int
DataCallbackProxy.create
(DpTrans trans, ConfObject[] kp) boolean
DataCallbackProxy.existsOptional
(DpTrans trans, ConfObject[] kp) int
DataCallbackProxy.getAttrs
(DpTrans trans, ConfObject[] kp, List<ConfAttributeValue> attrList) DataCallbackProxy.getCase
(DpTrans trans, ConfObject[] kp, ConfObject[] choice) DataCallbackProxy.getElem
(DpTrans trans, ConfObject[] kp) DataCallbackProxy.getIteratorKey
(DpTrans trans, ConfObject[] kp, Object obj) DataCallbackProxy.getIteratorObject
(DpTrans trans, ConfObject[] kp, Object obj) List<ConfObject[]>
DataCallbackProxy.getIteratorObjectList
(DpTrans trans, ConfObject[] kp, Object obj, Iterator<? extends Object> iterator) DataCallbackProxy.getObject
(DpTrans trans, ConfObject[] kp) DataCallbackProxy.iterator
(DpTrans trans, ConfObject[] kp) DataCallbackProxy.iterator
(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key) DataCallbackProxy.iterator
(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key, DpListFilter filter) DataCallbackProxy.iterator
(DpTrans trans, ConfObject[] kp, DpListFilter filter) void
DBCallbackProxy.lockPartial
(DpDbContext dbx, int dbname, int lockid, ConfObject[][] paths) int
DataCallbackProxy.moveAfter
(DpTrans trans, ConfObject[] kp, ConfKey prevkey) int
DataCallbackProxy.numInstances
(DpTrans trans, ConfObject[] kp) int
DataCallbackProxy.remove
(DpTrans trans, ConfObject[] kp) int
DataCallbackProxy.setAttr
(DpTrans trans, ConfObject[] kp, ConfAttributeValue attr) int
DataCallbackProxy.setCase
(DpTrans trans, ConfObject[] kp, ConfObject[] choice, ConfTag caseval) int
DataCallbackProxy.setElem
(DpTrans trans, ConfObject[] kp, ConfValue newval) void
ValidateCallbackProxy.validate
(DpTrans trans, ConfObject[] kp, ConfValue newval) int
DataCallbackProxy.writeAll
(DpTrans trans, ConfObject[] kp) -
Uses of ConfObject in com.tailf.maapi
Modifier and TypeFieldDescriptionMaapiSchemas.CSStringLength.hi
Deprecated.MaapiSchemas.CSTypeRange.hi
Deprecated.MaapiSchemas.CSStringLength.lo
Deprecated.MaapiSchemas.CSTypeRange.lo
Deprecated.Modifier and TypeMethodDescriptionConfObject[][]
This method dereferences a leafref and returns a list of the objects the leafref "points" to.MaapiSchemas.CSNode.getDefval()
get default value represented as a subclass to ConfObjectMaapiSchemas.CSNodeInfo.getDefval()
get default value represented as a subclass to ConfObjectMaapiSchemas.CSStringLength.getHigh()
MaapiSchemas.CSTypeRange.getHigh()
MaapiSchemas.CSStringLength.getLow()
MaapiSchemas.CSTypeRange.getLow()
This reads a container object or a list entry object from the path in fmt and returns the result.ResultTypeKeyPath.keyPath()
Retrieves the result keypath from a queryMaapi.safeGetObject
(int tid, String fmt, Object... arguments) This is a variant of getObject() that returns null if the object doesn't existModifier and TypeMethodDescriptionMaapiDiffIterate.iterate
(ConfObject[] kp, DiffIterateOperFlag op, ConfObject old_value, ConfObject new_value, Object initstate) MaapiIterate.iterate
(ConfObject[] kp, ConfObject value, ConfAttributeValue[] attrs, Object initstate) void
Maapi.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.void
Maapi.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.MaapiXPathEvalResult.result
(ConfObject[] kp, ConfValue value, Object state) For each node in the resulting node set evaluated by the xpath this method will be called.void
Maapi.setElem
(int tid, ConfObject value, ConfPath path) Set value to a leaf node.void
Maapi.setElem
(int tid, ConfObject value, String fmt, Object... arguments) Set value to a leaf node.void
Maapi.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.void
Maapi.sharedSetElem
(int tid, ConfObject value, ConfPath path) Set value to a leaf node from NCS FastMap code.void
Maapi.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.ModifierConstructorDescriptionCSNodeInfo
(int[] keys, int minOccurs, int maxOccurs, int shallowType, MaapiSchemas.CSType type, ConfObject defval, MaapiSchemas.CSChoice choice0, int flags, HashMap<String, String> metaData) CSStringLength
(ConfObject lo, ConfObject hi) CSTypeRange
(ConfObject lo, ConfObject hi, int flags) -
Uses of ConfObject in com.tailf.ned
-
Uses of ConfObject in com.tailf.notif
Modifier and TypeMethodDescriptionCallHomeInfoNotification.getIPValue()
CommitFailedNotification.getIPValue()
SnmpaNotification.getIPValue()
SnmpaNotification.Varbind.getValue()
ModifierConstructorDescriptionCallHomeInfoNotification
(int info_type, String device, InetAddress ip, ConfObject ipValue, int port, String key, String alg) CommitFailedNotification
(int data_provider, int db_name, DpUserInfo uinfo, String daemon_name, InetAddress ip, ConfObject ipValue, int port) SnmpaNotification
(int pdu_type, int request_id, int thandle, InetAddress ip, ConfObject ipValue, int port, int error_status, int error_index, int num_variables, SnmpaNotification.Varbind[] varbinds, SnmpaNotification.TrapInfo v1_trap) Varbind
(int type, SnmpaNotification.SnmpVar var, ConfObject val, int vartype)