com.tailf.conf (NCS Java API Version 5.6)

Interface Summary
Interface	Description
Compiler
ConfIterate	The subinterfaces to this interfaces is used as parameter to various `diffIterate` methods.
MountIdInterface
SocketFactoryCallback	Interface for user defined creation of sockets, towards NCS/Confd

Class Summary
Class	Description
Conf	General class for static methods and constants used by the ConfD API:s (Maapi, Cdb, Dp, and Notif)
ConfAttributeValue	Class that represents an attribute value for an element in a model.
ConfBinary	DATA_CONTAINER - Corresponds to the YANG tailf:hex-list and tailf:octet-list.
ConfBit32	DATA_CONTAINER - Corresponds to the YANG bit32 type.
ConfBit64	DATA_CONTAINER - Corresponds to the YANG bit64 type.
ConfBitBig	DATA_CONTAINER - Corresponds to the YANG bits type, where bit position exceed 63.
ConfBits	DATA_CONTAINER - This is the superclass for all bits types i.e.
ConfBool	DATA_CONTAINER - Corresponds to the YANG boolean type.
ConfBuf	DATA_CONTAINER - Corresponds to the YANG string type.
ConfCdbUpgradePath	Class Representing a KeyPath path.
ConfCLIToken
ConfDate	DATA_CONTAINER - Corresponds to the confspec xs:date type.
ConfDatetime	DATA_CONTAINER - Corresponds to the YANG date-and-time type.
ConfDecimal64	DATA_CONTAINER - Corresponds to the YANG decimal64 type.
ConfDefault	Class representing value of type J_DEFAULT.
ConfDottedQuad	DATA_CONTAINER - Corresponds to the YANG dotted-quad type.
ConfDouble	DATA_CONTAINER - Corresponds to the confspec xs:double type.
ConfDuration	DATA_CONTAINER - Corresponds to the confspec xs:duration type.
ConfEnumeration	DATA_CONTAINER - Corresponds to the YANG Enumeration type.
ConfFloat	DATA_CONTAINER - Corresponds to the confspec xs:float type.
ConfHaNode	ConfHaNode represents a HA node by identity and IP address
ConfHexList	DATA_CONTAINER - Corresponds to the YANG `tailf:hex-list` type.
ConfHexString	DATA_CONTAINER - Corresponds to the YANG `hex-string` type.
ConfIdentityRef	DATA_CONTAINER - Corresponds to the YANG identityRef type.
ConfInt16	DATA_CONTAINER - Corresponds to the YANG int16 type.
ConfInt32	DATA_CONTAINER - Corresponds to the YANG int32 type.
ConfInt64	DATA_CONTAINER - Corresponds to the YANG int64 type.
ConfInt8	DATA_CONTAINER - Corresponds to the YANG int8 type.
ConfInternal	This class implements the internal communication API in Java.
ConfIP	DATA_CONTAINER - Base class for ConfIPv4 and ConfIPv6 containers
ConfIPAndPrefixLen	DATA_CONTAINER - Base class for ConfIPv4AndPrefixLen and ConfIPv6AndPrefixLen containers
ConfIPPrefix	DATA_CONTAINER - Base class for ConfIPv4Prefix and ConfIPv6Prefix containers
ConfIPv4	DATA_CONTAINER - Corresponds to the YANG inet:ipv4-address type.
ConfIPv4AndPrefixLen	DATA_CONTAINER - Corresponds to the YANG tailf:ipv4-address-and-prefix-length type.
ConfIPv4Prefix	DATA_CONTAINER - Corresponds to the YANG inet:ipv4-prefix type.
ConfIPv6	DATA_CONTAINER - Corresponds to the YANG inet:ipv6-address type.
ConfIPv6AndPrefixLen	DATA_CONTAINER - Corresponds to the YANG tailf:ipv6-address-and-prefix-length type.
ConfIPv6Prefix	DATA_CONTAINER - Corresponds to the YANG inet:ipv6-prefix type.
ConfKey	This class represents a list key or a leaf-list element.
ConfList	DATA_CONTAINER - Corresponds to the YANG leaf-list.
ConfNamespace	Base class of the ConfNamespace objects.
ConfNamespaceStub	A ConfNamespaceStub can be used in place of a real namespace file when accessing removed data models during a cdb upgrade.
ConfNoExists	Class representing value of type J_NOEXISTS.
ConfObject	Base class of the Conf data type classes.
ConfObjectRef	Corresponds to the YANG instance-identifier type
ConfOctetList	DATA_CONTAINER - Corresponds to the YANG tailf:octet-list type.
ConfOID	DATA_CONTAINER - Corresponds to the YANG tailf:oid type.
ConfPath	Class Representing an KeyPath path.
ConfQname	DATA_CONTAINER - Corresponds to the confspec xs:qName type.
ConfResponse	Internal Class.
ConfTag	Class representing an element in a model.
ConfTagDefault	Class representing an element in a model.
ConfTime	DATA_CONTAINER - Corresponds to the confspec xs:time type.
ConfTypeDescriptor	Conf value type descriptor.
ConfUInt16	DATA_CONTAINER - Corresponds to the YANG uint16 type
ConfUInt32	DATA_CONTAINER - Corresponds to the YANG uint32 type
ConfUInt64	DATA_CONTAINER - Corresponds to the YANG uint64 type
ConfUInt8	DATA_CONTAINER - Corresponds to the YANG uint8 type
ConfUserInfo	User session information container.
ConfValue	Base class of the DATA_CONTAINER Conf classes.
ConfWarning	Warning messages container.
ConfXKey
ConfXMLParam	Represents the base class of a flat XML structure.
ConfXMLParamCdbStart	Identifies a starting point in the model from which other parameters are relatively defined (used in CDB).
ConfXMLParamLeaf	Identifies a leaf parameter.
ConfXMLParamStart	Identifies a starting point in the model from which other parameters are relatively defined.
ConfXMLParamStartDel	Identifies a starting point in the model for a list item that should be deleted.
ConfXMLParamStop	Identifies the end point for parameter definitions.
ConfXMLParamValue	Identifies a parameter with its value.
ConfXMLTagH	DATA_CONTAINER - Corresponds to the confspec XML Tag.
ConfXPath	Class Representing an XPath path.
ErrorMessageFormatter
InstancePath	Class Representing an path.
SnmpVarbind	The SnmpVarbind is a data structure for holding an SNMP variable binding which is on either of the forms: Variable - Value OID - Value Column - RowIndex - Value
SocketFactory	Class for creation and control of sockets, towards NCS/Confd This singleton factory class control all socket connections.
XPathAbrevCompiler

Enum Summary
Enum	Description
ConfAttributeType	Enumeration of attribute types
ConfFindNextType	Enum used in findNext calls to determine if the element extraction should start at indicated element or the element after that
ConfIterateFlags	Enumeration flags us by `CdbSubscription.diffIterate(int,CdbDiffIterate,EnumSet,Object)` to control the behavior of iterate over changes made in CDB data.
ConfIterateResultFlag	flags us by DiffIterate interface The iterate() method should return any of the following constants
ConfList.WhereTo
DiffIterateFlags	Enumeration flags us by `CdbSubscription.diffIterate(int,CdbDiffIterate,EnumSet,Object)` to control the behavior of iterate over changes made in CDB data.
DiffIterateOperFlag	The modification flags supplied by the library to `CdbDiffIterate`, `MaapiDiffIterate` user implementation of the `CdbDiffIterate.iterate(com.tailf.conf.ConfObject[], DiffIterateOperFlag,com.tailf.conf.ConfObject,com.tailf.conf.ConfObject, Object)` and `MaapiDiffIterate.iterate(com.tailf.conf.ConfObject[], DiffIterateOperFlag,com.tailf.conf.ConfObject, com.tailf.conf.ConfObject,Object)`.
DiffIterateResultFlag	flags us by DiffIterate interface The iterate() method should return any of the following constants
ErrorCode	Error codes for all errors delivered over the protocol.
ErrorVerbosity	verbosity levels for reported errors
XMLParamType	Enum identifying type of ConfXMLParam subclass.

Exception Summary
Exception	Description
AmbiguousNamespaceException	Exception thrown when protocol data is malformed.
ConfBadTermException	Exception thrown when protocol data is malformed.
ConfException	Exception base class.
ConfWarningException	Warning exception base class.

Annotation Types Summary
Annotation Type Description

IterateFlags

Annotation Types Summary
Annotation Type	Description
IterateFlags

Package com.tailf.conf Description

Data types and utilities for communication with the server.

The base class for all Conf terms is ConfObject. Not all Conf terms can contain a value. The ones that do all inherit the abstract class ConfValue. The inheritance hierarchy looks like this:

 ConfObject
         |
         +--ConfValue
         |         |
         |         +--ConfXYZ
         |         |
         |         :    :
         |         :    :
         |         |
         |         +--Conf
         |
         +--ConfKey
         |
         +--ConfTag
         |
         +--ConfTypeDescriptor
         |
         +--ConfXMLParam
                   |
                   +--ConfXMLParamStart
                   |         |
                   |         +-- ConfXMLParamCdbStart
                   |
                   +--ConfXMLParamStop
                   |
                   +--ConfXMLParamLeaf
                   |
                   +--ConfXMLParamValue

In addition to the term and value classes there are some utility classes in this package.