com.tailf.dp

Interface DpValpointCallback

All Known Implementing Classes:

ValidateCallbackProxy

public interface DpValpointCallback

This interface is used for the user valpoint callbacks.

See Also:

Dp.registerAnnotatedCallbacks(Object)

Method Summary

Methods

Modifier and Type	Method and Description
void	validate(DpTrans trans, ConfObject[] kp, ConfValue newval) The validate() callback should validate the values and throw a DpCallbackException if the validation fails.
String	valpoint() The name of the valpoint.

Method Detail

validate

void validate(DpTrans trans,
            ConfObject[] kp,
            ConfValue newval)
              throws DpCallbackException,
                     DpCallbackWarningException

The validate() callback should validate the values and throw a DpCallbackException if the validation fails. There is also a possibility to throw a DpCallbackWarningException with message set to a string describing the warning. The warnings will get propagated to the transaction engine, and depending on where the transaction originates, ConfD/NCS may or may not act on the warnings. If the transaction originates from the CLI or the Web UI, ConfD/NCS will interactively present the user with a choice - whereby the transaction can be aborted.

If the transaction originates from NETCONF - which does not have any interactive capabilities, the warnings are ignored. The warnings are primarily intended to alert inexperienced users that attempt to make - dangerous - configuration changes. There can be multiple warnings from multiple validation points in the same transaction.

Parameters:

trans - The transaction

kp - The keypath

newval - The new value to validate

Throws:

DpCallbackException - If the validation fails

DPCallbackWarningException - If a warning should be propagated to the originator of the transaction.

DpCallbackWarningException

valpoint

String valpoint()

The name of the valpoint.