BGPCEP-754: Start using default import policy
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / spi / AbstractImportPolicy.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.spi;
9
10 import javax.annotation.Nonnull;
11 import javax.annotation.Nullable;
12 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
13
14 /**
15  * Defines the internal hooks invoked when a new route appears.
16  */
17 public abstract class AbstractImportPolicy {
18     /**
19      * Transform incoming attributes according to policy.
20      *
21      * @param attributes received attributes
22      * @return Filtered attributes, or null if the advertisement should be ignored.
23      */
24     @Nullable public abstract ContainerNode effectiveAttributes(@Nonnull ContainerNode attributes);
25 }