Package | Description |
---|---|
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.dp.services |
Service callback specific context and utilities.
|
Modifier and Type | Class and Description |
---|---|
class |
DpActionTrans
The action transaction context.
|
class |
DpValidateTrans
The validate transaction context.
|
Modifier and Type | Method and Description |
---|---|
void |
DpTransCallback.abort(DpTrans trans)
This callback is responsible for
undoing whatever was done in the prepare() phase.
|
void |
DpTransCallback.commit(DpTrans trans)
This callback is responsible for
undoing whatever was done in the prepare() phase.
|
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.
|
Object |
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.
|
void |
DpTransCallback.finish(DpTrans trans)
This callback is responsible for
releasing resources allocated in the init() phase.
|
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).
|
ConfObject |
DpDataCallback.getCase(DpTrans trans,
ConfObject[] kp,
ConfObject[] choice)
This callback method needs to return the currently chosen 'case' for a
'choice' construct.
|
ConfValue |
DpDataCallback.getElem(DpTrans trans,
ConfObject[] kp)
This callback method needs to return a specific leaf value.
|
ConfKey |
DpDataCallback.getIteratorKey(DpTrans trans,
ConfObject[] kp,
Object obj)
The following callback is used with the iterators above.
|
ConfObject[] |
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 a
List of objects is requested rather than a single instance. |
ConfObject[] |
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.
|
void |
DpTransCallback.init(DpTrans trans)
The callback must indicate which WORKER_SOCKET
should be used for future communications in this transaction.
|
void |
DpTransValidateCallback.init(DpTrans trans) |
Iterator<? extends Object> |
DpDataCallback.iterator(DpTrans trans,
ConfObject[] kp)
This callback makes it possible for ConfD/NCS to traverse a set of list
entries.
|
DpDataFindNextIterator |
DpDataCallback.iterator(DpTrans trans,
ConfObject[] kp,
ConfFindNextType type,
ConfKey key)
This iterator method is a specialization of
DpDataCallback.iterator(DpTrans, ConfObject[])
in that it returns an extended iterator i.e. |
DpDataFindNextIterator |
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.
|
Iterator<? extends Object> |
DpDataCallback.iterator(DpTrans trans,
ConfObject[] kp,
DpListFilter filter)
Variant of iterator that may receive a DpListFilter which can be used to
filter the list.
|
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.
|
void |
DpTransCallback.prepare(DpTrans trans)
If we have multiple sources of data it is highly recommended
that the callback is 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 |
DpTransValidateCallback.stop(DpTrans trans) |
void |
DpTransCallback.transLock(DpTrans trans)
This callback is invoked when the validation phase of the transaction
starts.
|
void |
DpTransCallback.transUnlock(DpTrans trans)
This callback is called when the validation of the transaction
failed, or the validation is triggered explicitly (i.e.
|
void |
DpValpointCallback.validate(DpTrans trans,
ConfObject[] kp,
ConfValue newval)
The validate() callback should validate the values and throw a
DpCallbackException if the validation fails. |
int |
DpDataCallback.writeAll(DpTrans trans,
ConfObject[] kp)
This callback method sets the currently chosen 'case' for a 'choice'
construct.
|
void |
DpTransCallback.writeStart(DpTrans trans)
This callback is invoked when the validation succeeded and the
write phase of the transaction starts.
|
Modifier and Type | Method and Description |
---|---|
void |
TransCallbackProxy.abort(DpTrans trans) |
void |
TransCallbackProxy.commit(DpTrans trans) |
int |
DataCallbackProxy.create(DpTrans trans,
ConfObject[] kp) |
boolean |
DataCallbackProxy.existsOptional(DpTrans trans,
ConfObject[] kp) |
void |
TransCallbackProxy.finish(DpTrans trans) |
int |
DataCallbackProxy.getAttrs(DpTrans trans,
ConfObject[] kp,
List<ConfAttributeValue> attrList) |
ConfObject |
DataCallbackProxy.getCase(DpTrans trans,
ConfObject[] kp,
ConfObject[] choice) |
ConfValue |
DataCallbackProxy.getElem(DpTrans trans,
ConfObject[] kp) |
ConfKey |
DataCallbackProxy.getIteratorKey(DpTrans trans,
ConfObject[] kp,
Object obj) |
ConfObject[] |
DataCallbackProxy.getIteratorObject(DpTrans trans,
ConfObject[] kp,
Object obj) |
List<ConfObject[]> |
DataCallbackProxy.getIteratorObjectList(DpTrans trans,
ConfObject[] kp,
Object obj,
Iterator<? extends Object> iterator) |
ConfObject[] |
DataCallbackProxy.getObject(DpTrans trans,
ConfObject[] kp) |
void |
TransCallbackProxy.init(DpTrans trans) |
void |
TransValidateCallbackProxy.init(DpTrans trans) |
Iterator<Object> |
DataCallbackProxy.iterator(DpTrans trans,
ConfObject[] kp) |
DpDataFindNextIterator |
DataCallbackProxy.iterator(DpTrans trans,
ConfObject[] kp,
ConfFindNextType type,
ConfKey key) |
DpDataFindNextIterator |
DataCallbackProxy.iterator(DpTrans trans,
ConfObject[] kp,
ConfFindNextType type,
ConfKey key,
DpListFilter filter) |
Iterator<Object> |
DataCallbackProxy.iterator(DpTrans trans,
ConfObject[] kp,
DpListFilter filter) |
int |
DataCallbackProxy.moveAfter(DpTrans trans,
ConfObject[] kp,
ConfKey prevkey) |
int |
DataCallbackProxy.numInstances(DpTrans trans,
ConfObject[] kp) |
void |
TransCallbackProxy.prepare(DpTrans trans) |
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 |
TransValidateCallbackProxy.stop(DpTrans trans) |
void |
TransCallbackProxy.transLock(DpTrans trans) |
void |
TransCallbackProxy.transUnlock(DpTrans trans) |
void |
ValidateCallbackProxy.validate(DpTrans trans,
ConfObject[] kp,
ConfValue newval) |
int |
DataCallbackProxy.writeAll(DpTrans trans,
ConfObject[] kp) |
void |
TransCallbackProxy.writeStart(DpTrans trans) |
Constructor and Description |
---|
ServiceModificationContextImpl(DpTrans dpTrans,
Dp dp,
ConfEObject eObject)
Internally used constructor
|