2 * Copyright (c) 2015 Cisco Systems, Inc. All rights reserved.
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
8 package org.opendaylight.lispflowmapping.implementation;
10 import java.util.concurrent.Future;
12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
13 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
14 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
15 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
16 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
17 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
18 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
19 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
20 import org.opendaylight.lispflowmapping.implementation.mdsal.AuthenticationKeyDataListener;
21 import org.opendaylight.lispflowmapping.implementation.mdsal.DataStoreBackEnd;
22 import org.opendaylight.lispflowmapping.implementation.mdsal.MappingDataListener;
23 import org.opendaylight.lispflowmapping.implementation.util.DSBEInputUtil;
24 import org.opendaylight.lispflowmapping.implementation.util.RPCInputConvertorUtil;
25 import org.opendaylight.lispflowmapping.interfaces.dao.ILispDAO;
26 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddKeyInput;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddKeysInput;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddMappingInput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.AddMappingsInput;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetAllKeysOutput;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetAllMappingsOutput;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetKeyInput;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetKeyOutput;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetKeyOutputBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetKeysInput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetKeysOutput;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetMappingInput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetMappingOutput;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetMappingOutputBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetMappingsInput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetMappingsOutput;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.OdlMappingserviceService;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.RemoveKeyInput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.RemoveKeysInput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.RemoveMappingInput;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.RemoveMappingsInput;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.SiteId;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateKeyInput;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateKeysInput;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateMappingInput;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.UpdateMappingsInput;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.container.MappingAuthkey;
57 import org.opendaylight.yangtools.yang.common.RpcError;
58 import org.opendaylight.yangtools.yang.common.RpcResult;
59 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
63 import com.google.common.base.Preconditions;
64 import com.google.common.util.concurrent.Futures;
67 * Dispatcher of API calls that implements the RPC and Java APIs in mappingservice.yang and IMappingService
68 * respectively. It also coordinates and acts as container for all objects in charge of
69 * - saving and updating md-sal datastore stored mappings
70 * - monitoring md-sal datastore mapping updates and pushing them to the in memory mapping-system
71 * - in memory mapping-system
73 * @author Lorand Jakab
74 * @author Florin Coras
77 public class MappingService implements OdlMappingserviceService, IMappingService, BindingAwareProvider, AutoCloseable {
78 protected static final Logger LOG = LoggerFactory.getLogger(MappingService.class);
79 private static final String NOT_FOUND_TAG = "data-missing";
80 private static final String DATA_EXISTS_TAG = "data-exists";
82 private MappingSystem mappingSystem;
83 private DataStoreBackEnd dsbe;
84 private RpcRegistration<OdlMappingserviceService> mappingServiceRpc;
85 private AuthenticationKeyDataListener keyListener;
86 private MappingDataListener mappingListener;
89 private DataBroker dataBroker;
90 private RpcProviderRegistry rpcRegistry;
91 private BindingAwareBroker bindingAwareBroker;
92 private NotificationPublishService notificationPublishService;
94 private boolean overwritePolicy = ConfigIni.getInstance().mappingOverwriteIsSet();
95 private boolean notificationPolicy = ConfigIni.getInstance().smrIsSet();
96 private boolean iterateMask = true;
98 public MappingService() {
99 LOG.debug("MappingService created!");
102 public void setDataBroker(DataBroker dataBroker) {
103 this.dataBroker = dataBroker;
106 public void setRpcProviderRegistry(RpcProviderRegistry rpc) {
107 this.rpcRegistry = rpc;
110 public void setBindingAwareBroker(BindingAwareBroker broker) {
111 this.bindingAwareBroker = broker;
114 public void setNotificationPublishService(NotificationPublishService nps) {
115 this.notificationPublishService = nps;
118 public void setDaoService(ILispDAO dao) {
123 public void setMappingOverwrite(boolean overwrite) {
124 this.overwritePolicy = overwrite;
125 if (mappingSystem != null) {
126 mappingSystem.setOverwritePolicy(overwrite);
130 public void initialize() {
131 bindingAwareBroker.registerProvider(this);
133 mappingServiceRpc = rpcRegistry.addRpcImplementation(OdlMappingserviceService.class, this);
134 dsbe = new DataStoreBackEnd(dataBroker);
136 mappingSystem = new MappingSystem(dao, iterateMask, notificationPolicy, overwritePolicy);
137 mappingSystem.setDataStoreBackEnd(dsbe);
138 mappingSystem.initialize();
140 keyListener = new AuthenticationKeyDataListener(dataBroker, mappingSystem);
141 mappingListener = new MappingDataListener(dataBroker, mappingSystem, notificationPublishService);
145 public Future<RpcResult<Void>> addKey(AddKeyInput input) {
146 Preconditions.checkNotNull(input, "add-key RPC input must be not null!");
147 LOG.trace("RPC received to add the following key: " + input.toString());
149 RpcResultBuilder<Void> rpcResultBuilder;
151 MappingAuthkey key = mappingSystem.getAuthenticationKey(input.getEid());
154 String message = "Key already exists! Please use update-key if you want to change it.";
155 rpcResultBuilder = RpcResultBuilder.<Void>failed()
156 .withError(RpcError.ErrorType.PROTOCOL, DATA_EXISTS_TAG, message);
157 return Futures.immediateFuture(rpcResultBuilder.build());
160 dsbe.addAuthenticationKey(RPCInputConvertorUtil.toAuthenticationKey(input));
161 rpcResultBuilder = RpcResultBuilder.success();
163 return Futures.immediateFuture(rpcResultBuilder.build());
167 public Future<RpcResult<Void>> addMapping(AddMappingInput input) {
168 Preconditions.checkNotNull(input, "add-mapping RPC input must be not null!");
169 LOG.trace("RPC received to add the following mapping: " + input.toString());
171 dsbe.addMapping(RPCInputConvertorUtil.toMapping(input));
173 RpcResultBuilder<Void> rpcResultBuilder;
175 rpcResultBuilder = RpcResultBuilder.success();
177 return Futures.immediateFuture(rpcResultBuilder.build());
181 public Future<RpcResult<GetKeyOutput>> getKey(GetKeyInput input) {
182 Preconditions.checkNotNull(input, "get-key RPC input must be not null!");
183 LOG.trace("RPC received to get the following key: " + input.toString());
185 RpcResultBuilder<GetKeyOutput> rpcResultBuilder;
187 MappingAuthkey key = mappingSystem.getAuthenticationKey(input.getEid());
190 String message = "Key was not found in the mapping database";
191 rpcResultBuilder = RpcResultBuilder.<GetKeyOutput>failed()
192 .withError(RpcError.ErrorType.APPLICATION, NOT_FOUND_TAG, message);
194 rpcResultBuilder = RpcResultBuilder.success(new GetKeyOutputBuilder().setMappingAuthkey(key));
197 return Futures.immediateFuture(rpcResultBuilder.build());
201 public Future<RpcResult<GetMappingOutput>> getMapping(GetMappingInput input) {
202 Preconditions.checkNotNull(input, "get-mapping RPC input must be not null!");
203 LOG.trace("RPC received to get the following mapping: " + input.toString());
205 RpcResultBuilder<GetMappingOutput> rpcResultBuilder;
207 MappingRecord reply = (MappingRecord) mappingSystem.getMapping(input.getEid());
210 String message = "No mapping was found in the mapping database";
211 rpcResultBuilder = RpcResultBuilder.<GetMappingOutput>failed()
212 .withError(RpcError.ErrorType.APPLICATION, NOT_FOUND_TAG, message);
214 rpcResultBuilder = RpcResultBuilder.success(new GetMappingOutputBuilder().setMappingRecord(reply));
217 return Futures.immediateFuture(rpcResultBuilder.build());
221 public Future<RpcResult<Void>> removeKey(RemoveKeyInput input) {
222 Preconditions.checkNotNull(input, "remove-key RPC input must be not null!");
223 LOG.trace("RPC received to remove the following key: " + input.toString());
225 RpcResultBuilder<Void> rpcResultBuilder;
227 dsbe.removeAuthenticationKey(RPCInputConvertorUtil.toAuthenticationKey(input));
229 rpcResultBuilder = RpcResultBuilder.success();
231 return Futures.immediateFuture(rpcResultBuilder.build());
235 public Future<RpcResult<Void>> removeMapping(RemoveMappingInput input) {
236 Preconditions.checkNotNull(input, "remove-mapping RPC input must be not null!");
237 LOG.trace("RPC received to remove the following mapping: " + input.toString());
239 RpcResultBuilder<Void> rpcResultBuilder;
241 dsbe.removeMapping(RPCInputConvertorUtil.toMapping(input));
243 rpcResultBuilder = RpcResultBuilder.success();
245 return Futures.immediateFuture(rpcResultBuilder.build());
249 public Future<RpcResult<Void>> updateKey(UpdateKeyInput input) {
250 Preconditions.checkNotNull(input, "update-key RPC input must be not null!");
251 LOG.trace("RPC received to update the following key: " + input.toString());
253 RpcResultBuilder<Void> rpcResultBuilder;
255 MappingAuthkey key = mappingSystem.getAuthenticationKey(input.getEid());
258 String message = "Key doesn't exist! Please use add-key if you want to create a new authentication key.";
259 rpcResultBuilder = RpcResultBuilder.<Void>failed()
260 .withError(RpcError.ErrorType.PROTOCOL, NOT_FOUND_TAG, message);
261 return Futures.immediateFuture(rpcResultBuilder.build());
264 dsbe.updateAuthenticationKey(RPCInputConvertorUtil.toAuthenticationKey(input));
265 rpcResultBuilder = RpcResultBuilder.success();
267 return Futures.immediateFuture(rpcResultBuilder.build());
271 public Future<RpcResult<Void>> updateMapping(UpdateMappingInput input) {
272 LOG.trace("RPC received to update the following mapping: " + input.toString());
273 Preconditions.checkNotNull(input, "update-mapping RPC input must be not null!");
275 RpcResultBuilder<Void> rpcResultBuilder;
277 dsbe.updateMapping(RPCInputConvertorUtil.toMapping(input));
279 rpcResultBuilder = RpcResultBuilder.success();
281 return Futures.immediateFuture(rpcResultBuilder.build());
285 public Future<RpcResult<Void>> removeKeys(RemoveKeysInput input) {
286 // TODO Auto-generated method stub
291 public Future<RpcResult<Void>> removeMappings(RemoveMappingsInput input) {
292 // TODO Auto-generated method stub
297 public Future<RpcResult<GetKeysOutput>> getKeys(GetKeysInput input) {
298 // TODO Auto-generated method stub
303 public Future<RpcResult<Void>> addMappings(AddMappingsInput input) {
304 // TODO Auto-generated method stub
309 public Future<RpcResult<Void>> updateKeys(UpdateKeysInput input) {
310 // TODO Auto-generated method stub
315 public Future<RpcResult<Void>> removeAllMappings() {
316 // TODO Auto-generated method stub
321 public Future<RpcResult<Void>> removeAllKeys() {
322 // TODO Auto-generated method stub
327 public Future<RpcResult<GetAllKeysOutput>> getAllKeys() {
328 // TODO Auto-generated method stub
333 public Future<RpcResult<Void>> updateMappings(UpdateMappingsInput input) {
334 // TODO Auto-generated method stub
339 public Future<RpcResult<Void>> addKeys(AddKeysInput input) {
340 // TODO Auto-generated method stub
345 public Future<RpcResult<GetAllMappingsOutput>> getAllMappings() {
346 // TODO Auto-generated method stub
351 public Future<RpcResult<GetMappingsOutput>> getMappings(
352 GetMappingsInput input) {
353 // TODO Auto-generated method stub
358 public void addMapping(MappingOrigin origin, Eid key, SiteId siteId, Object data) {
359 // SB registrations are first written to the MappingSystem and only afterwards are persisted to the datastore
360 if (origin.equals(MappingOrigin.Southbound)) {
361 mappingSystem.addMapping(origin, siteId, key, data);
363 dsbe.addMapping(DSBEInputUtil.toMapping(origin, key, siteId, (MappingRecord) data));
368 public Object getMapping(MappingOrigin origin, Eid key) {
369 return mappingSystem.getMapping(origin, key);
373 public Object getMapping(Eid key) {
374 return mappingSystem.getMapping(key);
378 public Object getMapping(Eid srcKey, Eid dstKey) {
379 return mappingSystem.getMapping(srcKey, dstKey);
383 public void removeMapping(MappingOrigin origin, Eid key) {
384 dsbe.removeMapping(DSBEInputUtil.toMapping(origin, key));
388 public void addAuthenticationKey(Eid key, MappingAuthkey authKey) {
389 dsbe.addAuthenticationKey(DSBEInputUtil.toAuthenticationKey(key, authKey));
393 public MappingAuthkey getAuthenticationKey(Eid key) {
394 return mappingSystem.getAuthenticationKey(key);
398 public void removeAuthenticationKey(Eid key) {
399 dsbe.removeAuthenticationKey(DSBEInputUtil.toAuthenticationKey(key, null));
403 public void addData(MappingOrigin origin, Eid key, String subKey, Object data) {
404 mappingSystem.addData(origin, key, subKey, data);
408 public Object getData(MappingOrigin origin, Eid key, String subKey) {
409 return mappingSystem.getData(origin, key, subKey);
413 public void removeData(MappingOrigin origin, Eid key, String subKey) {
414 mappingSystem.removeData(origin, key, subKey);
418 public String printMappings() {
419 return mappingSystem.printMappings();
423 public void onSessionInitiated(ProviderContext session) {
424 LOG.info("Mapping Service provider session initializing!");
428 public void close() throws Exception {
429 LOG.info("Mapping Service is being destroyed!");
430 mappingServiceRpc.close();
431 keyListener.closeDataChangeListener();
432 mappingListener.closeDataChangeListener();
436 public void cleanCachedMappings() {
437 mappingSystem.cleanCaches();
438 dsbe.removeAllMappings();