bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AbstractExportPolicy.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.protocol.bgp.rib.impl;
   9
  10 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  11 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  12
  13 /**
  14  * Defines the internal hooks invoked when a route is being distributed
  15  * to a peer.
  16  */
  17 abstract class AbstractExportPolicy {
  18     /**
  19      * Transform outgoing attributes according to policy.
  20      *
  21      * @param sourceRole role of the peer which originated the routes
  22      * @param attributes outgoing attributes
  23      * @return Filtered attributes, or null if the advertisement should be ignored.
  24      */
  25     abstract ContainerNode effectiveAttributes(PeerRole sourceRole, ContainerNode attributes);
  26 }