Package com.tailf.dp

Data provider API package, for implementation of callbacks for validations, actions, transformation etc.

See: Description

Interface Summary

Interface	Description
DpActionCallback	This interface is used for the user actions callbacks.
DpAuthCallback	With this interface we can register a callback with ConfDs AAA subsystem, to be invoked whenever AAA has completed processing of an authentication attempt.
DpAuthorizationCallback	We can register two authorization callbacks with ConfD´s AAA subsystem.
DpDataCallback	This interface is used for the user data callbacks.
DpDataFindNextIterator	Extended Iterator interface used to get findNext functionality.
DpDbCallback	This interface is used for the user database callbacks.
DpExceptionReporter	Interface for the user of the Dp deamon to handle catched exceptions in the implicit threads started in the Dp.read() method
DpMountIdInterface
DpNanoServiceCallback	This interface is used for the Nano Service callbacks.
DpNotifReplayCallback	This interface is used for the notifications replay callback.
DpServiceCallback	This interface is used for the service callbacks.
DpSnmpInformResponseCallback	This interface is used for the SNMP notifier callbacks.
DpTransCallback	This interface is used for the user transaction callbacks.
DpTransValidateCallback	This interface is used for the user validation callbacks.
DpValpointCallback	This interface is used for the user valpoint callbacks.
NextObjectList<E>	Instances of classes implementing this interface can be used as return value for the DpDataCallback.getIteratorObjectList(com.tailf.dp.DpTrans, com.tailf.conf.ConfObject[], java.lang.Object, java.util.Iterator<? extends java.lang.Object>) method.

Class Summary

Class	Description
Completion	Reply structure container for completion callbacks.
CompletionDefaultReply	Default completion reply for callbacks invoked by a tailf:cli-completion-actionpoint or a tailf:cli-custom-range-actionpoint directive.
CompletionRangeEnumReply	Reply structure container for completion callbacks invoked by a tailf:cli-custom-range-enumerator directive.
CompletionReply	Reply structure container for completion callbacks invoked by a tailf:cli-completion-actionpoint or a tailf:cli-custom-range-actionpoint directive.
Dp	This class implements the Data Provider API (DP).
DpAccumulate	The DpAccumulate object is used for accumulating operations on database from the DpDataCallbacks setElem, create, and remove operations when they return Conf.REPLY_ACCUMULATE.
DpActionTrans	The action transaction context.
DpAuthContext	Authentication context class.
DpAuthorizationContext	Authorization context class.
DpDbContext	Database context.
DpListFilter	This class represents list filters that may be passed to data providers.
DpNotifReplayThread	This class implements the Notification streams thread.
DpNotifStream	The application can generate notifications that are sent via the northbound protocols.
DpProto	General class for protocol constants
DpSnmpNotifier	The application can send SNMP notifications and inform requests.
DpThread	DpThread with the ability to log more info about a thread and that uses a Uncaught exception handler.
DpThreadPoolFactory	The customized thread Factory this is used for creating customized threads that uses UncaughtExceptionHandler and for thread that performs debug logging message so we could interpret the thread dumps and error logs.
DpTrans	The transaction context.
DpUserInfo	The user information.
DpValidateTrans	The validate transaction context.
DpWorkerThreadPool	Dp Thread pool of worker thread.
NextObjectArrayList<E>	ArrayList-based implementation of the NextObjectList interface.

Enum Summary

Enum	Description
AuthorizationOperCheck	AuthorizationOperCheck used as argument to authorization callbacks.
AuthorizationResult	Enum for returning authorization result from authorization callbacks
ListFilterExprOp	The type of comparison or function to employ when the filter type is ListFilterType.CONFD_LF_CMP or ListFilterType.CONFD_LF_EXEC.
ListFilterType	Enumeration of list filter types

Exception Summary

Exception	Description
DpCallbackException	Exception thrown from inside callbacks to identify problems.
DpCallbackExtendedException	Extended errorcode Exceptions thrown from inside callbacks to identify problems.
DpCallbackWarningException	Warnings thrown from inside callbacks to identify problems.
DpException	General Dp Exception

Package com.tailf.dp Description

Data provider API package, for implementation of callbacks for validations, actions, transformation etc.

Validation.

The database stores device configuration data. Some device configuration data is truly critical for the correct operations of the device. Misconfiguring a network device may lead to a situation where the device is no longer connected to the network. Before committing configuration data it is crucial to ensure that the new configuration is correct. Another benefit with a guaranteed correct configuration, is that application software which reads the configuration data need not check the validity of the configuration.

Actions.

When we want to define operations that do not affect the configuration data store, we can use the tailf:action statement in the YANG data model. The action definition specifies how the action is invoked, including input and output parameters (if any). Once defined, the action is available for invocation from all of NETCONF, CLI and Web UI.

Transformations.

When building new variants of an old product, we often have a situation where we have large amounts of application code, which reads configuration data from some datastore and we do not want to make any changes to the application code, we merely wish to expose a different view of the same configuration data.

Another common situation is when we have application code which requires more configuration data than we wish to expose through the northbound management interfaces. The application reads and use a number of configuration items that do not make sense to expose through the different management interfaces.