BUG-7608: Clarify DOMRpc routing/invocation/listener interactions

[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / md / sal / dom / api / DOMRpcService.java

diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java
index 48f6ab6500e0e4f1d8ab185431a71a513cfe9b40..c84e2d3ad0a6216d1def8b687f5e003f8effe031 100644 (file)
--- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java
+++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java
@@ -31,21 +31,26 @@ public interface DOMRpcService extends DOMService {
      *         or report a subclass of {@link DOMRpcException} reporting a transport
      *         error.
      */
-    @Nonnull CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull SchemaPath type, @Nullable NormalizedNode<?, ?> input);
+    @Nonnull CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull SchemaPath type,
+            @Nullable NormalizedNode<?, ?> input);
 
     /**
      * Register a {@link DOMRpcAvailabilityListener} with this service to receive notifications
      * about RPC implementations becoming (un)available. The listener will be invoked with the
      * current implementations reported and will be kept uptodate as implementations come and go.
      *
-     * Users should note that using a listener does not necessarily mean that {@link #invokeRpc(SchemaPath, NormalizedNode)}
-     * will not report a failure due to {@link DOMRpcImplementationNotAvailableException} and
-     * need to be ready to handle it. Implementations are encouraged to take reasonable precautions
-     * to prevent this scenario from occurring.
+     * <p>
+     * Users should note that using a listener does not necessarily mean that
+     * {@link #invokeRpc(SchemaPath, NormalizedNode)} will not report a failure due to
+     * {@link DOMRpcImplementationNotAvailableException} and need to be ready to handle it.
+     *
+     * <p>
+     * Implementations of this interface are encouraged to take reasonable precautions to prevent this scenario from
+     * occurring.
      *
      * @param listener {@link DOMRpcAvailabilityListener} instance to register
-     * @return A {@link DOMRpcAvailabilityListenerRegistration} representing this registration. Performing
-     *         a {@link DOMRpcAvailabilityListenerRegistration#close()} will cancel it. Returned object
+     * @return A {@link ListenerRegistration} representing this registration. Performing
+     *         a {@link ListenerRegistration#close()} will cancel it. Returned object
      *         is guaranteed to be non-null.
      */
     @Nonnull <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(@Nonnull T listener);