opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcAvailabilityListener.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.md.sal.dom.api;
   9
  10 import java.util.Collection;
  11 import java.util.EventListener;
  12 import javax.annotation.Nonnull;
  13
  14 /**
  15  * An {@link EventListener} used to track RPC implementations becoming (un)available
  16  * to a {@link DOMRpcService}.
  17  */
  18 public interface DOMRpcAvailabilityListener extends EventListener {
  19     /**
  20      * Method invoked whenever an RPC type becomes available.
  21      *
  22      * @param rpcs RPC types newly available
  23      */
  24     void onRpcAvailable(@Nonnull Collection<DOMRpcIdentifier> rpcs);
  25
  26     /**
  27      * Method invoked whenever an RPC type becomes unavailable.
  28      *
  29      * @param rpcs RPC types which became unavailable
  30      */
  31     void onRpcUnavailable(@Nonnull Collection<DOMRpcIdentifier> rpcs);
  32
  33     /**
  34      * Implementation filtering method. This method is useful for forwarding RPC implementations,
  35      * which need to ensure they do not re-announce their own implementations. Without this method
  36      * a forwarder which registers an implementation would be notified of its own implementation,
  37      * potentially re-exporting it as local -- hence creating a forwarding loop.
  38      *
  39      * @param impl RPC implementation being registered
  40      * @return False if the implementation should not be reported, defaults to true.
  41      */
  42     default boolean acceptsImplementation(final DOMRpcImplementation impl) {
  43         return true;
  44     }
  45 }