Replace Preconditions.CheckNotNull per RequireNonNull
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / config / RibImpl.java
1 /*
2  * Copyright (c) 2016 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
9 package org.opendaylight.protocol.bgp.rib.impl.config;
10
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getAfiSafiWithDefault;
13 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getClusterIdentifier;
14 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.toTableTypes;
15
16 import com.google.common.base.Preconditions;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.util.List;
20 import java.util.Map;
21 import java.util.Set;
22 import java.util.stream.Collectors;
23 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
24 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
25 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
26 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
27 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
28 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
29 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
30 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
31 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
32 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
33 import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
34 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
35 import org.opendaylight.protocol.bgp.rib.impl.RIBImpl;
36 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
37 import org.opendaylight.protocol.bgp.rib.impl.spi.BgpDeployer;
38 import org.opendaylight.protocol.bgp.rib.impl.spi.CodecsRegistry;
39 import org.opendaylight.protocol.bgp.rib.impl.spi.ImportPolicyPeerTracker;
40 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
41 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
42 import org.opendaylight.protocol.bgp.rib.impl.stats.rib.impl.BGPRenderStats;
43 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
44 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
45 import org.opendaylight.protocol.bgp.rib.spi.state.BGPRIBState;
46 import org.opendaylight.protocol.bgp.rib.spi.state.BGPRIBStateConsumer;
47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base.Config;
49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Global;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpId;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
59 import org.opendaylight.yangtools.concepts.ListenerRegistration;
60 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
62 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
63 import org.osgi.framework.ServiceRegistration;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
66
67 public final class RibImpl implements RIB, BGPRIBStateConsumer, AutoCloseable {
68
69     private static final Logger LOG = LoggerFactory.getLogger(RibImpl.class);
70
71     private final RIBExtensionConsumerContext extensions;
72     private final BGPDispatcher dispatcher;
73     private final BindingCodecTreeFactory codecTreeFactory;
74     private final DOMDataBroker domBroker;
75     private final DOMSchemaService domSchemaService;
76     private RIBImpl ribImpl;
77     private ServiceRegistration<?> serviceRegistration;
78     private ListenerRegistration<SchemaContextListener> schemaContextRegistration;
79     private final ClusterSingletonServiceProvider provider;
80     private List<AfiSafi> afiSafi;
81     private AsNumber asNumber;
82     private Ipv4Address routerId;
83
84     private ClusterIdentifier clusterId;
85
86     public RibImpl(final ClusterSingletonServiceProvider provider, final RIBExtensionConsumerContext contextProvider,
87         final BGPDispatcher dispatcher, final BindingCodecTreeFactory codecTreeFactory, final DOMDataBroker domBroker,
88         final DOMSchemaService domSchemaService) {
89         this.provider = requireNonNull(provider);
90         this.extensions = contextProvider;
91         this.dispatcher = dispatcher;
92         this.codecTreeFactory = codecTreeFactory;
93         this.domBroker = domBroker;
94         this.domSchemaService = domSchemaService;
95     }
96
97     void start(final Global global, final String instanceName, final BGPTableTypeRegistryConsumer tableTypeRegistry,
98         final BgpDeployer.WriteConfiguration configurationWriter) {
99         Preconditions.checkState(this.ribImpl == null, "Previous instance %s was not closed.", this);
100         this.ribImpl = createRib(global, instanceName, tableTypeRegistry, configurationWriter);
101         this.schemaContextRegistration = this.domSchemaService.registerSchemaContextListener(this.ribImpl);
102     }
103
104     Boolean isGlobalEqual(final Global global) {
105         final List<AfiSafi> globalAfiSafi = getAfiSafiWithDefault(global.getAfiSafis(), true);
106         final Config globalConfig = global.getConfig();
107         final AsNumber globalAs = globalConfig.getAs();
108         final Ipv4Address globalRouterId = global.getConfig().getRouterId();
109         final ClusterIdentifier globalClusterId = getClusterIdentifier(globalConfig);
110         return this.afiSafi.containsAll(globalAfiSafi) && globalAfiSafi.containsAll(this.afiSafi)
111             && globalAs.equals(this.asNumber)
112             && globalRouterId.getValue().equals(this.routerId.getValue())
113             && globalClusterId.getValue().equals(this.clusterId.getValue());
114     }
115
116     @Override
117     public KeyedInstanceIdentifier<Rib, RibKey> getInstanceIdentifier() {
118         return this.ribImpl.getInstanceIdentifier();
119     }
120
121     @Override
122     public AsNumber getLocalAs() {
123         return this.ribImpl.getLocalAs();
124     }
125
126     @Override
127     public BgpId getBgpIdentifier() {
128         return this.ribImpl.getBgpIdentifier();
129     }
130
131     @Override
132     public Set<? extends BgpTableType> getLocalTables() {
133         return this.ribImpl.getLocalTables();
134     }
135
136     @Override
137     public BGPDispatcher getDispatcher() {
138         return this.ribImpl.getDispatcher();
139     }
140
141     @Override
142     public DOMTransactionChain createPeerChain(final TransactionChainListener listener) {
143         return this.ribImpl.createPeerChain(listener);
144     }
145
146     @Override
147     public RIBExtensionConsumerContext getRibExtensions() {
148         return this.ribImpl.getRibExtensions();
149     }
150
151     @Override
152     public RIBSupportContextRegistry getRibSupportContext() {
153         return this.ribImpl.getRibSupportContext();
154     }
155
156     @Override
157     public YangInstanceIdentifier getYangRibId() {
158         return this.ribImpl.getYangRibId();
159     }
160
161     @Override
162     public CodecsRegistry getCodecsRegistry() {
163         return this.ribImpl.getCodecsRegistry();
164     }
165
166     @Override
167     public DOMDataTreeChangeService getService() {
168         return this.ribImpl.getService();
169     }
170
171     public ListenableFuture<Void> closeServiceInstance() {
172         if (this.ribImpl != null) {
173             return this.ribImpl.closeServiceInstance();
174         }
175         return Futures.immediateFuture(null);
176     }
177
178     @Override
179     public void close() {
180         if (this.ribImpl != null) {
181             try {
182                 this.ribImpl.close();
183             } catch (final Exception e) {
184                 LOG.warn("Failed to close {} rib instance", this, e);
185             }
186             this.ribImpl = null;
187         }
188         if (this.schemaContextRegistration != null) {
189             this.schemaContextRegistration.close();
190             this.schemaContextRegistration = null;
191         }
192         if (this.serviceRegistration != null) {
193             try {
194                 this.serviceRegistration.unregister();
195             } catch(final IllegalStateException e) {
196                 LOG.warn("Failed to unregister {} service instance", this, e);
197             }
198             this.serviceRegistration = null;
199         }
200     }
201
202     void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
203         this.serviceRegistration = serviceRegistration;
204     }
205
206     @Override
207     public BGPRenderStats getRenderStats() {
208         return this.ribImpl.getRenderStats();
209     }
210
211     @Override
212     public ImportPolicyPeerTracker getImportPolicyPeerTracker() {
213         return this.ribImpl.getImportPolicyPeerTracker();
214     }
215
216     @Override
217     public ExportPolicyPeerTracker getExportPolicyPeerTracker(final TablesKey tablesKey) {
218         return this.ribImpl.getExportPolicyPeerTracker(tablesKey);
219     }
220
221     @Override
222     public Set<TablesKey> getLocalTablesKeys() {
223         return this.ribImpl.getLocalTablesKeys();
224     }
225
226     @Override
227     public ServiceGroupIdentifier getRibIServiceGroupIdentifier() {
228         return this.ribImpl.getRibIServiceGroupIdentifier();
229     }
230
231     @Override
232     public String toString() {
233         return this.ribImpl != null ? this.ribImpl.toString() : null;
234     }
235
236     private RIBImpl createRib(final Global global, final String bgpInstanceName,
237         final BGPTableTypeRegistryConsumer tableTypeRegistry, final BgpDeployer.WriteConfiguration configurationWriter) {
238         this.afiSafi = getAfiSafiWithDefault(global.getAfiSafis(), true);
239         final Config globalConfig = global.getConfig();
240         this.asNumber = globalConfig.getAs();
241         this.routerId = globalConfig.getRouterId();
242         this.clusterId = getClusterIdentifier(globalConfig);
243         final Map<TablesKey, PathSelectionMode> pathSelectionModes = OpenConfigMappingUtil.toPathSelectionMode(this.afiSafi, tableTypeRegistry).entrySet()
244                 .stream().collect(Collectors.toMap(entry -> new TablesKey(entry.getKey().getAfi(), entry.getKey().getSafi()), Map.Entry::getValue));
245         return new RIBImpl(this.provider, new RibId(bgpInstanceName), this.asNumber, new BgpId(this.routerId), this.clusterId,
246                 this.extensions, this.dispatcher, this.codecTreeFactory, this.domBroker, toTableTypes(this.afiSafi, tableTypeRegistry), pathSelectionModes,
247                 this.extensions.getClassLoadingStrategy(), configurationWriter);
248     }
249
250     @Override
251     public ClusterSingletonServiceRegistration registerClusterSingletonService(final ClusterSingletonService clusterSingletonService) {
252         return this.ribImpl.registerClusterSingletonService(clusterSingletonService);
253     }
254
255     @Override
256     public BGPRIBState getRIBState() {
257         return this.ribImpl.getRIBState();
258     }
259 }