X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fdom%2Fapi%2FDOMRpcAvailabilityListener.java;h=2131cf16340e097226b3b9ec2274978896f5a036;hb=e38f06caf5cf5d4b4861315b42fecf7842b4ec05;hp=77d42a43c994edca187aa8cde354ffb6f881a983;hpb=c31509c7a6630e54a9f9749a643fed5e1a1ad380;p=controller.git diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcAvailabilityListener.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcAvailabilityListener.java index 77d42a43c9..2131cf1634 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcAvailabilityListener.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcAvailabilityListener.java @@ -9,11 +9,44 @@ package org.opendaylight.controller.md.sal.dom.api; import java.util.Collection; import java.util.EventListener; -import javax.annotation.Nonnull; +import org.eclipse.jdt.annotation.NonNull; /** - * An {@link EventListener} used to track RPC implementations becoming (un)available - * to a {@link DOMRpcService}. + * An {@link EventListener} used to track RPC implementations becoming (un)available a {@link DOMRpcService}. Note that + * the reported {@link DOMRpcIdentifier}s form an identifier space shared between RFC7950 actions and RFC6020 RPCs, + * the former being also known as 'Routed RPCs'. + * + *
+ * Interpretation of DOMRpcIdentifiers has to be evaluated in the context of one of these types, which need to be + * determined by matching {@link DOMRpcIdentifier#getType()} against a + * {@link org.opendaylight.yangtools.yang.model.api.SchemaContext}, which determines actual semantics of + * {@link DOMRpcIdentifier#getContextReference()}. Corresponding SchemaNode is required to be a known sub-interface + * of {@link org.opendaylight.yangtools.yang.model.api.OperationDefinition}. + * + *
+ * For RFC6020 RPCs, reported context reference is always non-null and empty. It indicates an RPC implementation has + * been registered and invocations can be reasonably (with obvious distributed system caveats coming from asynchronous + * events) expected to succeed. + * + *
+ * For RFC7950 actions with a non-empty context-reference, the indication is the same as for RFC6020 RPCs. + * + *
+ * For RFC7950 actions with an empty context-reference, the indication is that the corresponding actions are + * potentially available, but are subject to dynamic lifecycle of their context references. This includes two primary + * use cases: + *
+ * Second use case will not be providing further events, but rather will attempt to map any incoming invocation onto
+ * some other RPC or action, or similar, which can separately fail. If a sub-request fails, such implementations are
+ * required do report {@link DOMRpcImplementationNotAvailableException} as the invocation result, with the underlying
+ * failure being linked as a cause.
*/
public interface DOMRpcAvailabilityListener extends EventListener {
/**
@@ -21,12 +54,25 @@ public interface DOMRpcAvailabilityListener extends EventListener {
*
* @param rpcs RPC types newly available
*/
- void onRpcAvailable(@Nonnull Collection