Uses of Class
com.tailf.conf.ConfObject
Packages that use 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 Element Drivers package
Package for subscription to asynchronous events.
-
Uses of ConfObject in com.tailf.cdb
Methods in com.tailf.cdb that return ConfObjectModifier 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 aConfObjectarray.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) Methods in com.tailf.cdb with parameters of type ConfObjectModifier 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
Subclasses of ConfObject in com.tailf.confModifier and TypeClassDescriptionclassClass that represents an attribute value for an element in a model.classDATA_CONTAINER - Corresponds to the YANG tailf:hex-list and tailf:octet-list.classDATA_CONTAINER - Corresponds to the YANG bit32 type.classDATA_CONTAINER - Corresponds to the YANG bit64 type.classDATA_CONTAINER - Corresponds to the YANG bits type, where bit position exceed 63.classDATA_CONTAINER - This is the superclass for all bits types i.e.classDATA_CONTAINER - Corresponds to the YANG boolean type.classDATA_CONTAINER - Corresponds to the YANG string type.classDATA_CONTAINER - Corresponds to the confspec xs:date type.classDATA_CONTAINER - Corresponds to the YANG date-and-time type.classDATA_CONTAINER - Corresponds to the YANG decimal64 type.classClass representing value of type J_DEFAULT.classDATA_CONTAINER - Corresponds to the YANG dotted-quad type.classDATA_CONTAINER - Corresponds to the confspec xs:double type.classDATA_CONTAINER - Corresponds to the confspec xs:duration type.classDATA_CONTAINER - Corresponds to the YANG empty type.classDATA_CONTAINER - Corresponds to the YANG Enumeration type.classDATA_CONTAINER - Corresponds to the confspec xs:float type.classDATA_CONTAINER - Corresponds to the YANGtailf:hex-listtype.classDATA_CONTAINER - Corresponds to the YANGhex-stringtype.classDATA_CONTAINER - Corresponds to the YANG identityRef type.classDATA_CONTAINER - Corresponds to the YANG int16 type.classDATA_CONTAINER - Corresponds to the YANG int32 type.classDATA_CONTAINER - Corresponds to the YANG int64 type.classDATA_CONTAINER - Corresponds to the YANG int8 type.classDATA_CONTAINER - Base class for ConfIPv4 and ConfIPv6 containersclassDATA_CONTAINER - Base class for ConfIPv4AndPrefixLen and ConfIPv6AndPrefixLen containersclassDATA_CONTAINER - Base class for ConfIPv4Prefix and ConfIPv6Prefix containersclassDATA_CONTAINER - Corresponds to the YANG inet:ipv4-address type.classDATA_CONTAINER - Corresponds to the YANG tailf:ipv4-address-and-prefix-length type.classDATA_CONTAINER - Corresponds to the YANG inet:ipv4-prefix type.classDATA_CONTAINER - Corresponds to the YANG inet:ipv6-address type.classDATA_CONTAINER - Corresponds to the YANG tailf:ipv6-address-and-prefix-length type.classDATA_CONTAINER - Corresponds to the YANG inet:ipv6-prefix type.classThis class represents a list key or a leaf-list element.classDATA_CONTAINER - Corresponds to the YANG leaf-list.classClass representing value of type J_NOEXISTS.classDATA_CONTAINER - Corresponds to the YANG instance-identifier type.classDATA_CONTAINER - Corresponds to the YANG tailf:octet-list type.classDATA_CONTAINER - Corresponds to the YANG tailf:oid type.classDATA_CONTAINER - Corresponds to the confspec xs:qName type.classClass representing an element in a model.classClass representing an element in a model.classDATA_CONTAINER - Corresponds to the confspec xs:time type.classConf value type descriptor.classDATA_CONTAINER - Corresponds to the YANG uint16 typeclassDATA_CONTAINER - Corresponds to the YANG uint32 typeclassDATA_CONTAINER - Corresponds to the YANG uint64 typeclassDATA_CONTAINER - Corresponds to the YANG uint8 typeclassBase class of the DATA_CONTAINERConf<datatype>classes.classclassRepresents the base class of a flat XML structure.classIdentifies a starting point in the model from which other parameters are relatively defined (used in CDB).classIdentifies a leaf parameter.classIdentifies a starting point in the model from which other parameters are relatively defined.classIdentifies a starting point in the model for a list item that should be deleted.classIdentifies the end point for parameter definitions.classIdentifies a parameter with its value.classDATA_CONTAINER - Corresponds to the confspec XML Tag.Methods in com.tailf.conf that return ConfObjectModifier and TypeMethodDescriptionstatic ConfObjectConfObject.decode(ConfEObject o) static ConfObjectConfObject.decode(ConfEObject o, ConfPath path) static ConfObjectConfObject.decode(ConfEObject o, String tag) 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 ofConfTagandConfKeyobjects which represents the path in reverted order.InstancePath.getKP()Returns an array ofConfTagandConfKeyobjects which represents the path in reverted order.static final ConfObject[]InstancePath.getKP(List<com.tailf.conf.gen.PathParser.PathElement> pl, boolean isRel, boolean hasSchema, MountIdInterface mountGetter) 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, List<ConfNamespace> nsList) Makes a keypath from a term.ConfList.set(int index, ConfObject val) Methods in com.tailf.conf with parameters of type ConfObjectModifier and TypeMethodDescriptionvoidConfList.addElem(ConfObject n) Add an element in the end of this ConfList unless it already existsvoidConfList.delete(ConfObject n) Delete arbitrary object from the ConfListstatic ConfTypeDescriptorConfTypeDescriptor.getConfTypeDescriptor(ConfObject o) Generates a ConfTypeDescriptor representing the type of a specified ConfObject.booleanConfList.isMember(ConfObject o) static StringConf.kpToString(ConfObject[] kp) Converts a keypath Object[] kp into a string.voidConfList.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) voidConfUserInfo.setIpValue(ConfObject ipValue) Internally used set methodvoidConfXMLParamValue.setValue(ConfObject value) Constructors in com.tailf.conf with parameters of type ConfObjectModifierConstructorDescriptionConfCLIToken(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 eitherConfTagorConfKey.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 eitherConfTagorConfKey.InstancePath(MountIdInterface mountGetter, ConfObject[] kp) -
Uses of ConfObject in com.tailf.dp
Fields in com.tailf.dp declared as ConfObjectModifier and TypeFieldDescriptionDpListFilter.nodeNode to use when type isListFilterType.CONFD_LF_CMP,ListFilterType.CONFD_LF_EXECorListFilterType.CONFD_LF_EXISTSDpListFilter.valValue to use when type isListFilterType.CONFD_LF_CMPorListFilterType.CONFD_LF_EXECorListFilterType.CONFD_LF_ORIGINDpListFilter.valuesMethods in com.tailf.dp that return ConfObjectModifier 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.Methods in com.tailf.dp with parameters of type ConfObjectModifier 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.intDpDataCallback.create(DpTrans trans, ConfObject[] kp) This callback creates a new presence container, list entry or empty leaf.booleanDpDataCallback.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.intDpDataCallback.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 aListof 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.voidDpDbCallback.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.intDpDataCallback.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.intDpDataCallback.numInstances(DpTrans trans, ConfObject[] kp) This callback can optionally be implemented.intDpDataCallback.remove(DpTrans trans, ConfObject[] kp) This callback is used to remove a presence container, list entry or empty leaf and all its sub elements.intDpDataCallback.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).intDpDataCallback.setCase(DpTrans trans, ConfObject[] kp, ConfObject[] choice, ConfTag caseval) This callback method sets the currently chosen 'case' for a 'choice' construct.intDpDataCallback.setElem(DpTrans trans, ConfObject[] kp, ConfValue newval) This callback writes a data leaf.voidDpValpointCallback.validate(DpTrans trans, ConfObject[] kp, ConfValue newval) The validate() callback should validate the values and throw aDpCallbackExceptionif the validation fails.intDpDataCallback.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
Methods in com.tailf.dp.annotations that return ConfObjectModifier and TypeMethodDescriptionDataCallbackProxy.getCase(DpTrans trans, ConfObject[] kp, ConfObject[] choice) DataCallbackProxy.getIteratorObject(DpTrans trans, ConfObject[] kp, Object obj) DataCallbackProxy.getObject(DpTrans trans, ConfObject[] kp) Methods in com.tailf.dp.annotations with parameters of type ConfObjectModifier 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) intDataCallbackProxy.create(DpTrans trans, ConfObject[] kp) booleanDataCallbackProxy.existsOptional(DpTrans trans, ConfObject[] kp) intDataCallbackProxy.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) voidDBCallbackProxy.lockPartial(DpDbContext dbx, int dbname, int lockid, ConfObject[][] paths) intDataCallbackProxy.moveAfter(DpTrans trans, ConfObject[] kp, ConfKey prevkey) intDataCallbackProxy.numInstances(DpTrans trans, ConfObject[] kp) intDataCallbackProxy.remove(DpTrans trans, ConfObject[] kp) intDataCallbackProxy.setAttr(DpTrans trans, ConfObject[] kp, ConfAttributeValue attr) intDataCallbackProxy.setCase(DpTrans trans, ConfObject[] kp, ConfObject[] choice, ConfTag caseval) intDataCallbackProxy.setElem(DpTrans trans, ConfObject[] kp, ConfValue newval) voidValidateCallbackProxy.validate(DpTrans trans, ConfObject[] kp, ConfValue newval) intDataCallbackProxy.writeAll(DpTrans trans, ConfObject[] kp) -
Uses of ConfObject in com.tailf.maapi
Methods in com.tailf.maapi that return ConfObjectModifier 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 existMethods in com.tailf.maapi with parameters of type ConfObjectModifier and TypeMethodDescriptionMaapiDiffIterate.iterate(ConfObject[] kp, DiffIterateOperFlag op, ConfObject oldValue, ConfObject newValue, Object initstate) MaapiIterate.iterate(ConfObject[] kp, ConfObject value, ConfAttributeValue[] attrs, Object initstate) voidMaapi.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.voidMaapi.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.voidMaapi.setElem(int tid, ConfObject value, ConfPath path) Set value to a leaf node.voidMaapi.setElem(int tid, ConfObject value, String fmt, Object... arguments) Set value to a leaf node.voidMaapi.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.voidMaapi.sharedSetElem(int tid, ConfObject value, ConfPath path) Set value to a leaf node from NCS FastMap code.voidMaapi.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. -
Uses of ConfObject in com.tailf.ned
Methods in com.tailf.ned that return ConfObject -
Uses of ConfObject in com.tailf.notif
Methods in com.tailf.notif that return ConfObjectModifier and TypeMethodDescriptionCallHomeInfoNotification.getIPValue()CommitFailedNotification.getIPValue()SnmpaNotification.getIPValue()SnmpaNotification.Varbind.getValue()Constructors in com.tailf.notif with parameters of type ConfObjectModifierConstructorDescriptionCallHomeInfoNotification(int infoType, String device, InetAddress ip, ConfObject ipValue, int port, String key, String alg) CommitFailedNotification(int dataProvider, int dbName, DpUserInfo uinfo, String daemonName, InetAddress ip, ConfObject ipValue, int port) SnmpaNotification(int pduType, int requestId, int thandle, InetAddress ip, ConfObject ipValue, int port, int errorStatus, int errorIndex, int numVariables, SnmpaNotification.Varbind[] varbinds, SnmpaNotification.TrapInfo v1Trap) Varbind(int type, SnmpaNotification.SnmpVar var, ConfObject val, int vartype)