public class DataCallbackProxy extends Object implements DpDataCallback
DpDataCallback
interface and delegates calls to the registered callback POJO with annotated
methodsM_ALL, M_CREATE, M_EXISTS_OPTIONAL, M_GET_ATTRS, M_GET_CASE, M_GET_ELEM, M_GET_NEXT, M_GET_NEXT_OBJECT, M_GET_OBJECT, M_MOVE_AFTER, M_NUM_INSTANCES, M_REMOVE, M_SET_ATTR, M_SET_CASE, M_SET_ELEM, M_WANT_FILTER, M_WRITE_ALL
Constructor and Description |
---|
DataCallbackProxy(Object backupObject,
String callPoint)
Constructor for Callback proxys.
|
Modifier and Type | Method and Description |
---|---|
void |
addActionCapability(DataCBType dataCBType)
Add action capability from annotated callType used to register
capabilities on the server
|
void |
addActionMethod(String name,
Method method)
Add callback action method to proxy
|
String |
callpoint()
The name of the callpoint
|
int |
create(DpTrans trans,
ConfObject[] kp)
This callback creates a new presence container, list entry or empty leaf.
|
boolean |
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.
|
int |
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).
|
Object |
getBackupObject()
Retrieve the callback POJO
|
String |
getCallPoint()
Retrieve the callback callpoint
|
ConfObject |
getCase(DpTrans trans,
ConfObject[] kp,
ConfObject[] choice)
This callback method needs to return the currently chosen 'case' for a
'choice' construct.
|
static DataCallbackProxy[] |
getDataCallbackProxys(String mountId,
Object obj)
Get array of proxy objects from registered POJO callback.
|
ConfValue |
getElem(DpTrans trans,
ConfObject[] kp)
This callback method needs to return a specific leaf value.
|
EnumSet<DpFlag> |
getFlags() |
ConfKey |
getIteratorKey(DpTrans trans,
ConfObject[] kp,
Object obj)
The following callback is used with the iterators above.
|
ConfObject[] |
getIteratorObject(DpTrans trans,
ConfObject[] kp,
Object obj)
The following callback is used with the iterators above.
|
List<ConfObject[]> |
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[] |
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.
|
Iterator<Object> |
iterator(DpTrans trans,
ConfObject[] kp)
This callback makes it possible for ConfD/NCS to traverse a set of list
entries.
|
DpDataFindNextIterator |
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 |
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<Object> |
iterator(DpTrans trans,
ConfObject[] kp,
DpListFilter filter)
Variant of iterator that may receive a DpListFilter which can be used to
filter the list.
|
int |
mask()
Mask of flags for each method that is supported by this callback:
DpDataCallback.M_EXISTS_OPTIONAL
DpDataCallback.M_GET_ELEM
DpDataCallback.M_GET_NEXT
DpDataCallback.M_SET_ELEM
DpDataCallback.M_CREATE
DpDataCallback.M_REMOVE
DpDataCallback.M_NUM_INSTANCES
DpDataCallback.M_GET_OBJECT
DpDataCallback.M_GET_NEXT_OBJECT
DpDataCallback.M_GET_CASE
DpDataCallback.M_SET_CASE
DpDataCallback.M_GET_ATTRS
DpDataCallback.M_SET_ATTR
DpDataCallback.M_MOVE_AFTER
DpDataCallback.M_WRITE_ALL
DpDataCallback.M_WANT_FILTER
|
int |
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 |
numInstances(DpTrans trans,
ConfObject[] kp)
This callback can optionally be implemented.
|
int |
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 |
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 |
setCase(DpTrans trans,
ConfObject[] kp,
ConfObject[] choice,
ConfTag caseval)
This callback method sets the currently chosen 'case' for a 'choice'
construct.
|
int |
setElem(DpTrans trans,
ConfObject[] kp,
ConfValue newval)
This callback writes a data leaf.
|
int |
writeAll(DpTrans trans,
ConfObject[] kp)
This callback method sets the currently chosen 'case' for a 'choice'
construct.
|
public Object getBackupObject()
public String getCallPoint()
public void addActionMethod(String name, Method method)
name
- canonical action namemethod
- registered callback methodpublic void addActionCapability(DataCBType dataCBType)
dataCBType
- action typepublic String callpoint()
DpDataCallback
callpoint
in interface DpDataCallback
public int create(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
create
in interface DpDataCallback
trans
- Transactionkp
- The keypathConf.REPLY_OK
or Conf.REPLY_ACCUMULATE
DpCallbackException
- Callback method failed.public boolean existsOptional(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
Additionally, the getElem() callback cannot be used as an existence test by requesting a key leaf for entries in operational data lists without keys, or for leaf-list entries (unless the deprecated leafListAsLeaf() flag is used), since there are no key leafs in those cases.
In all the above cases, we need to implement the existsOptional() callback method.
existsOptional
in interface DpDataCallback
trans
- Transactionkp
- The keypathtrue
or false
DpCallbackException
- Callback method failed.public ConfObject getCase(DpTrans trans, ConfObject[] kp, ConfObject[] choice) throws DpCallbackException
DpDataCallback
getCase
in interface DpDataCallback
trans
- Transactionkp
- The keypathchoice
- The choice name(s) as an array of ConfTagDpCallbackException
- Callback method failed.public ConfValue getElem(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
The callback must return a ConfValue
on
success. The implementation of getElem
must
be prepared to return all the leafs including the key(s).
When ConfD/NCS invokes getElem
on a key leaf it is
an existence test. The application should verify whether the
object exists or not. If an object doesn't exists this method
must return null.
getElem
in interface DpDataCallback
trans
- Transactionkp
- The keypath structured as a reversed array of
ConfTag
and/or
ConfKey
objectsDpCallbackException
- Callback method failure.public ConfKey getIteratorKey(DpTrans trans, ConfObject[] kp, Object obj) throws DpCallbackException
DpDataCallback
getIteratorKey
in interface DpDataCallback
trans
- Transactionkp
- The keypathobj
- The object returned by the iteratorDpCallbackException
- Callback method failed.public ConfObject[] getIteratorObject(DpTrans trans, ConfObject[] kp, Object obj) throws DpCallbackException
DpDataCallback
getIteratorObject
method will be invoked and it must
return either of the following:
ConfValue
s describing the object
ConfXMLParam
s describing the
object
ConfNoExists
element. Each list contained within
the object must also be represented by a single ConfNoExists, regardless
of whether it contains any elements or not. If a ConfXMLParam array is
used, lists and missing values should simply be omitted from the array.getIteratorObject
in interface DpDataCallback
trans
- Transactionkp
- The keypathobj
- The object returned by the iteratorDpCallbackException
- Callback method failed.public ConfObject[] getObject(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
getObject
in interface DpDataCallback
trans
- Transactionkp
- The keypathDpCallbackException
- Callback method failed.public Iterator<Object> iterator(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
This method is a specific java construct which is actually not
registered on the server side. Instead it is a mandatory tool for the
GET_NEXT/GET_NEXT_OBJECT functionality to work. If either the
DpDataCallback.getIteratorKey(DpTrans, ConfObject[], Object)
or the DpDataCallback.getIteratorObject(DpTrans, ConfObject[], Object)
is
registered this method must also be registered.
The Iterator is stored internally by Dp
and
when a GET_NEXT/GET_NEXT_OBJECT request is issued the iterator
is called to get the next element in the list.
Note that the iterator is free to return any POJO Object and it is instead the responsibility of the getIteratorKey or getIteratorObject to render the return values.
iterator
in interface DpDataCallback
trans
- DpTrans object for current transactionkp
- Keypath for the list that is subject for traversalDpCallbackException
- if Callback method failed.public Iterator<Object> iterator(DpTrans trans, ConfObject[] kp, DpListFilter filter) throws DpCallbackException
DpDataCallback
iterator
in interface DpDataCallback
trans
- DpTrans object for current transactionkp
- Keypath for the list that is subject for traversalfilter
- DpListFilter instance for filtering elements, or null
if no filtering is requestedDpCallbackException
- if Callback method failed.public DpDataFindNextIterator iterator(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key) throws DpCallbackException
DpDataCallback
DpDataCallback.iterator(DpTrans, ConfObject[])
in that it returns an extended iterator i.e. DpFindNextIterator.
This iterator does the same job as the normal Java Iterator
but it also has a
DpDataFindNextIterator.findNext(DpTrans,
ConfObject[], ConfFindNextType, ConfKey)
method that is called if FIND_NEXT/FIND_NEXT_OBJECT is called.
Note that this iterator is expected to be able to traverse using
next()/hasNext() functions after a initial findNext(...) has been
called and it will take precedence over the standard iterator method.iterator
in interface DpDataCallback
trans
- DpTrans object for current transactionkp
- Keypath for the list that is subject for traversaltype
- ConfFindNextType
describing the findNext behaviorkey
- ConfKey which constitutes the search criteriaDpCallbackException
- if Callback method failed.public DpDataFindNextIterator iterator(DpTrans trans, ConfObject[] kp, ConfFindNextType type, ConfKey key, DpListFilter filter) throws DpCallbackException
DpDataCallback
iterator
in interface DpDataCallback
trans
- DpTrans object for current transactionkp
- Keypath for the list that is subject for traversaltype
- ConfFindNextType
describing the findNext behaviorkey
- ConfKey which constitutes the search criteriafilter
- DpListFilter instance for filtering elements, or null
if no filtering is requestedDpCallbackException
- if Callback method failed.public int mask()
DpDataCallback
DpDataCallback.M_EXISTS_OPTIONAL
DpDataCallback.M_GET_ELEM
DpDataCallback.M_GET_NEXT
DpDataCallback.M_SET_ELEM
DpDataCallback.M_CREATE
DpDataCallback.M_REMOVE
DpDataCallback.M_NUM_INSTANCES
DpDataCallback.M_GET_OBJECT
DpDataCallback.M_GET_NEXT_OBJECT
DpDataCallback.M_GET_CASE
DpDataCallback.M_SET_CASE
DpDataCallback.M_GET_ATTRS
DpDataCallback.M_SET_ATTR
DpDataCallback.M_MOVE_AFTER
DpDataCallback.M_WRITE_ALL
DpDataCallback.M_WANT_FILTER
mask
in interface DpDataCallback
public int numInstances(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
numInstances
in interface DpDataCallback
trans
- Transactionkp
- The keypathDpCallbackException
- Callback method failed.public int remove(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
remove
in interface DpDataCallback
trans
- Transactionkp
- The keypathConf.REPLY_OK
or Conf.REPLY_ACCUMULATE
DpCallbackException
- Callback method failed.public int setCase(DpTrans trans, ConfObject[] kp, ConfObject[] choice, ConfTag caseval) throws DpCallbackException
DpDataCallback
setCase
in interface DpDataCallback
trans
- Transactionkp
- The keypathchoice
- The choice name(s) as an array of ConfTagcaseval
- The name of the caseConf.REPLY_OK
DpCallbackException
- Callback method failed.public int setElem(DpTrans trans, ConfObject[] kp, ConfValue newval) throws DpCallbackException
DpDataCallback
setElem
in interface DpDataCallback
trans
- Transactionkp
- The keypathnewval
- The new value to be setConf.REPLY_OK
or Conf.REPLY_ACCUMULATE
DpCallbackException
- Callback method failed.public int getAttrs(DpTrans trans, ConfObject[] kp, List<ConfAttributeValue> attrList) throws DpCallbackException
DpDataCallback
ConfAttributeType.TAGS
(values are ConfList of ConfBuf)
ConfAttributeType.ANNOTATION
(value is ConfBuf)
ConfAttributeType.INACTIVE
(not used)
ConfAttributeType.ORIGIN
(value is Confidentityref)
The attrs parameter is an list of ConfAttributeValue objects with
attributeType set to requested attribute and attributeValue set to null.
If the list is empty all attributes are requested.
If the node given by kp does not exist, the callback should throw an
IllegalArgumentException, otherwise it should set values to the elements
of the attrs list, or even add attributes if the list was empty.
Must return Conf.REPLY_OK
on success or
Conf.REPLY_DELAYED_RESPONSE
.
On error a DpCallbackException
should be throwngetAttrs
in interface DpDataCallback
trans
- current transactionkp
- keypath for node to set attributes onattrList
- list of ConfAttributeValue to populate as resultConf.REPLY_OK
or
Conf.REPLY_DELAYED_RESPONSE
on successful callDpCallbackException
- on unsuccessful callpublic int setAttr(DpTrans trans, ConfObject[] kp, ConfAttributeValue attr) throws DpCallbackException
DpDataCallback
setAttr
in interface DpDataCallback
trans
- current transactionkp
- keypath for node to set attributes onattr
- ConfAttributeValue to set valueDpCallbackException
public int moveAfter(DpTrans trans, ConfObject[] kp, ConfKey prevkey) throws DpCallbackException
DpDataCallback
moveAfter
in interface DpDataCallback
trans
- current transactionkp
- keypath for entry to moveprevkey
- position to entry which should be before the entry to moveConf.REPLY_OK
DpCallbackException
public int writeAll(DpTrans trans, ConfObject[] kp) throws DpCallbackException
DpDataCallback
writeAll
in interface DpDataCallback
trans
- Transactionkp
- The keypathConf.REPLY_OK
DpCallbackException
- Callback method failed.public List<ConfObject[]> getIteratorObjectList(DpTrans trans, ConfObject[] kp, Object obj, Iterator<? extends Object> iterator) throws DpCallbackException
DpDataCallback
This callback is used in place of getIteratorObject when a
List
of objects is requested rather than a single instance.
This is of interest when lists are big and performance requires larger
chunks to be sent at once.
The first object from the iterator is already retrieved and delivered
in the obj
parameter. It is mandatory to put this object
first in the list. An arbitrary number of additional objects can then be
retrieved using the iterator.
The returned list should contain either ConfValue
arrays or
ConfXMLParam
arrays. See
DpDataCallback.getIteratorObject(com.tailf.dp.DpTrans, com.tailf.conf.ConfObject[], java.lang.Object)
for more information on how to format
the return values.
It is important to return all objects retrieved by the iterator. Any item that is retrieved but not returned will be lost.
To override the global object cache timeout for the response, return
an object of the type NextObjectList
<ConfObject[]>, for
example an instance of NextObjectArrayList
<ConfObject[]>
where you have set the desired timeout via the
NextObjectArrayList.setTimeout(int)
method.
For backwards compatibility reasons, you can return a List<ConfObject[]> instance of a class that doesn't implement the NextObjectList interface, in which case the default object cache timeout will be in effect for the response.
Also for backwards compatibility reasons, it is acceptable for this
method to return a List<ConfValue
[]> instead of a
List<ConfObject[]>.
getIteratorObjectList
in interface DpDataCallback
trans
- Transactionkp
- The keypathobj
- The first object returned by the iteratoriterator
- The iterator to optionally retrieve more objects fromDpCallbackException
- Callback method failspublic static DataCallbackProxy[] getDataCallbackProxys(String mountId, Object obj) throws DpCallbackException
obj
- registered Callback POJODpCallbackException