opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/routing/RouteChange.java

   1 /*
   2  * Copyright (c) 2013 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.common.api.routing;
   9
  10 import java.util.Map;
  11 import java.util.Set;
  12
  13 /**
  14  * Event representing change in RPC routing table.
  15  *
  16  *
  17  * @param <C> Type, which is used to represent Routing context.
  18  * @param <P> Type of data tree path, which is used to identify route.
  19  */
  20 public interface RouteChange<C, P> {
  21
  22     /**
  23      * Returns a map of removed routes in associated routing contexts.
  24      *
  25      * <p>
  26      * This map represents routes, which were withdrawn from broker local
  27      * routing table and broker may need to forward RPC to other broker
  28      * in order to process RPC request.
  29      *
  30      * @return Map of contexts and removed routes
  31      */
  32     Map<C,Set<P>> getRemovals();
  33
  34     /**
  35      * Returns a map of announced routes in associated routing contexts.
  36      *
  37      * <p>
  38      * This map represents routes, which were announced by broker
  39      * and are present in broker's local routing table. This routes
  40      * are processed by implementations which are registered
  41      * to originating broker.
  42      *
  43      * @return Map of contexts and announced routes
  44      */
  45     Map<C, Set<P>> getAnnouncements();
  46 }