c02764b2f761b30f049b8dde93e5d1ad4589d4ea
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / device / DeviceManagerImpl.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.openflowplugin.impl.device;
9
10 import com.google.common.base.Preconditions;
11 import com.google.common.util.concurrent.FutureCallback;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.ListenableFuture;
14 import io.netty.util.HashedWheelTimer;
15 import java.math.BigInteger;
16 import java.util.ArrayList;
17 import java.util.Arrays;
18 import java.util.Collection;
19 import java.util.Collections;
20 import java.util.Iterator;
21 import java.util.List;
22 import java.util.concurrent.ScheduledThreadPoolExecutor;
23 import java.util.concurrent.TimeUnit;
24 import javax.annotation.CheckForNull;
25 import javax.annotation.Nonnull;
26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
27 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
28 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
29 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
31 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
32 import org.opendaylight.openflowplugin.api.ConnectionException;
33 import org.opendaylight.openflowplugin.api.OFConstants;
34 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
35 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
36 import org.opendaylight.openflowplugin.api.openflow.connection.ThrottledNotificationsOfferer;
37 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
38 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
39 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
40 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
41 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
42 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
43 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
44 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
45 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
46 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
47 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
48 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
49 import org.opendaylight.openflowplugin.impl.common.MultipartRequestInputFactory;
50 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
51 import org.opendaylight.openflowplugin.impl.connection.OutboundQueueProviderImpl;
52 import org.opendaylight.openflowplugin.impl.connection.ThrottledNotificationsOffererImpl;
53 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
54 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
55 import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsData;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.FlowTableStatisticsDataBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.Capabilities;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.CapabilitiesV10;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.MultipartReplyBody;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyGroupFeaturesCase;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyMeterFeaturesCase;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortDescCase;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableFeaturesCase;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDesc;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.group.features._case.MultipartReplyGroupFeatures;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter.features._case.MultipartReplyMeterFeatures;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.MultipartReplyPortDesc;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table.features._case.MultipartReplyTableFeatures;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
94 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
95 import org.opendaylight.yangtools.yang.common.RpcError;
96 import org.opendaylight.yangtools.yang.common.RpcResult;
97 import org.slf4j.Logger;
98 import org.slf4j.LoggerFactory;
99
100 /**
101  *
102  */
103 public class DeviceManagerImpl implements DeviceManager, AutoCloseable {
104
105     private static final Logger LOG = LoggerFactory.getLogger(DeviceManagerImpl.class);
106
107     private static final long TICK_DURATION = 10; // 0.5 sec.
108     private ScheduledThreadPoolExecutor spyPool;
109     private final int spyRate = 10;
110
111     private final DataBroker dataBroker;
112     private final HashedWheelTimer hashedWheelTimer;
113     private RequestContextStack emptyRequestContextStack;
114     private TranslatorLibrary translatorLibrary;
115     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
116     private NotificationService notificationService;
117     private NotificationPublishService notificationPublishService;
118     private ThrottledNotificationsOfferer<PacketInMessage> throttledNotificationsOfferer;
119
120     private final List<DeviceContext> deviceContexts = new ArrayList<DeviceContext>();
121     private final MessageIntelligenceAgency messageIntelligenceAgency;
122
123     private final long barrierNanos = TimeUnit.MILLISECONDS.toNanos(500);
124     private final int maxQueueDepth = 25600;
125
126     public DeviceManagerImpl(@Nonnull final DataBroker dataBroker,
127                              @Nonnull final MessageIntelligenceAgency messageIntelligenceAgency) {
128         this.dataBroker = Preconditions.checkNotNull(dataBroker);
129         hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, 500);
130         /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
131         final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
132         tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), new NodesBuilder().build());
133         tx.submit();
134
135         this.messageIntelligenceAgency = messageIntelligenceAgency;
136
137         emptyRequestContextStack = new RequestContextStack() {
138             @Override
139             public <T> RequestContext<T> createRequestContext() {
140                 return new AbstractRequestContext<T>() {
141                     @Override
142                     public void close() {
143                         //NOOP
144                     }
145                 };
146             }
147         };
148     }
149
150     @Override
151     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
152         deviceInitPhaseHandler = handler;
153     }
154
155     @Override
156     public void onDeviceContextLevelUp(final DeviceContext deviceContext) {
157         // final phase - we have to add new Device to MD-SAL DataStore
158         Preconditions.checkNotNull(deviceContext);
159         ((DeviceContextImpl) deviceContext).submitTransaction();
160     }
161
162     @Override
163     public void deviceConnected(@CheckForNull final ConnectionContext connectionContext) {
164         Preconditions.checkArgument(connectionContext != null);
165
166         final Short version = connectionContext.getFeatures().getVersion();
167         OutboundQueueProvider outboundQueueProvider = new OutboundQueueProviderImpl(version);
168         connectionContext.getConnectionAdapter().registerOutboundQueueHandler(outboundQueueProvider, maxQueueDepth, barrierNanos);
169         connectionContext.setOutboundQueueProvider(outboundQueueProvider);
170
171         final DeviceState deviceState = new DeviceStateImpl(connectionContext.getFeatures(), connectionContext.getNodeId());
172
173         final DeviceContext deviceContext = new DeviceContextImpl(connectionContext, deviceState, dataBroker, hashedWheelTimer, messageIntelligenceAgency, throttledNotificationsOfferer);
174
175         deviceContext.setNotificationService(notificationService);
176         deviceContext.setNotificationPublishService(notificationPublishService);
177         deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, deviceState.getNodeInstanceIdentifier(), new NodeBuilder().setId(deviceState.getNodeId()).build());
178
179         connectionContext.setDeviceDisconnectedHandler(deviceContext);
180         deviceContext.setTranslatorLibrary(translatorLibrary);
181         deviceContext.addDeviceContextClosedHandler(this);
182
183         final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
184                 connectionContext.getConnectionAdapter(), deviceContext);
185
186         final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture;
187
188
189
190         if (OFConstants.OFP_VERSION_1_0 == version) {
191             final CapabilitiesV10 capabilitiesV10 = connectionContext.getFeatures().getCapabilitiesV10();
192
193             DeviceStateUtil.setDeviceStateBasedOnV10Capabilities(deviceState, capabilitiesV10);
194
195             deviceFeaturesFuture = createDeviceFeaturesForOF10(deviceContext, deviceState);
196             // create empty tables after device description is processed
197             chainTableTrunkWriteOF10(deviceContext, deviceFeaturesFuture);
198
199             for (final PortGrouping port : connectionContext.getFeatures().getPhyPort()) {
200                 final short ofVersion = deviceContext.getDeviceState().getVersion();
201                 final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
202                 final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = deviceContext.oook().lookupTranslator(translatorKey);
203                 final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, deviceContext, null);
204
205                 final BigInteger dataPathId = deviceContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
206                 final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), port.getPortNo(), ofVersion);
207                 final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
208                 ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
209                 ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
210                 final NodeConnector connector = ncBuilder.build();
211                 final InstanceIdentifier<NodeConnector> connectorII = deviceState.getNodeInstanceIdentifier().child(NodeConnector.class, connector.getKey());
212                 deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
213             }
214         } else if (OFConstants.OFP_VERSION_1_3 == version) {
215             final Capabilities capabilities = connectionContext.getFeatures().getCapabilities();
216             LOG.debug("Setting capabilities for device {}", deviceContext.getDeviceState().getNodeId());
217             DeviceStateUtil.setDeviceStateBasedOnV13Capabilities(deviceState, capabilities);
218             deviceFeaturesFuture = createDeviceFeaturesForOF13(deviceContext, deviceState);
219         } else {
220             deviceFeaturesFuture = Futures.immediateFailedFuture(new ConnectionException("Unsupported version " + version));
221         }
222
223         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
224             @Override
225             public void onSuccess(final List<RpcResult<List<MultipartReply>>> result) {
226                 deviceContext.getDeviceState().setValid(true);
227                 deviceInitPhaseHandler.onDeviceContextLevelUp(deviceContext);
228             }
229
230             @Override
231             public void onFailure(final Throwable t) {
232                 // FIXME : remove session
233                 LOG.trace("Device capabilities gathering future failed.");
234                 LOG.trace("more info in exploration failure..", t);
235             }
236         });
237     }
238
239     private static void chainTableTrunkWriteOF10(final DeviceContext deviceContext, final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture) {
240         Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
241             @Override
242             public void onSuccess(final List<RpcResult<List<MultipartReply>>> results) {
243                 boolean allSucceeded = true;
244                 for (final RpcResult<List<MultipartReply>> rpcResult : results) {
245                     allSucceeded &= rpcResult.isSuccessful();
246                 }
247                 if (allSucceeded) {
248                     createEmptyFlowCapableNodeInDs(deviceContext);
249                     makeEmptyTables(deviceContext, deviceContext.getDeviceState().getNodeInstanceIdentifier(),
250                             deviceContext.getDeviceState().getFeatures().getTables());
251                 }
252             }
253
254             @Override
255             public void onFailure(final Throwable t) {
256                 //NOOP
257             }
258         });
259     }
260
261     private ListenableFuture<RpcResult<List<MultipartReply>>> processReplyDesc(final DeviceContext deviceContext,
262                                                                                final DeviceState deviceState) {
263
264         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(MultipartType.OFPMPDESC,
265                 deviceContext,
266                 deviceState.getNodeInstanceIdentifier(),
267                 deviceState.getVersion());
268         return replyDesc;
269     }
270
271     private ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF10(final DeviceContext deviceContext,
272                                                                                                 final DeviceState deviceState) {
273         return Futures.allAsList(Arrays.asList(processReplyDesc(deviceContext, deviceState)));
274     }
275
276     private ListenableFuture<List<RpcResult<List<MultipartReply>>>> createDeviceFeaturesForOF13(final DeviceContext deviceContext,
277                                                                                                 final DeviceState deviceState) {
278         final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = processReplyDesc(deviceContext, deviceState);
279
280         final ListenableFuture<RpcResult<List<MultipartReply>>> replyMeterFeature = getNodeStaticInfo(MultipartType.OFPMPMETERFEATURES,
281                 deviceContext,
282                 deviceState.getNodeInstanceIdentifier(),
283                 deviceState.getVersion());
284
285         final ListenableFuture<RpcResult<List<MultipartReply>>> replyGroupFeatures = getNodeStaticInfo(MultipartType.OFPMPGROUPFEATURES,
286                 deviceContext,
287                 deviceState.getNodeInstanceIdentifier(),
288                 deviceState.getVersion());
289
290         final ListenableFuture<RpcResult<List<MultipartReply>>> replyTableFeatures = getNodeStaticInfo(MultipartType.OFPMPTABLEFEATURES,
291                 deviceContext,
292                 deviceState.getNodeInstanceIdentifier(),
293                 deviceState.getVersion());
294
295         final ListenableFuture<RpcResult<List<MultipartReply>>> replyPortDescription = getNodeStaticInfo(MultipartType.OFPMPPORTDESC,
296                 deviceContext,
297                 deviceState.getNodeInstanceIdentifier(),
298                 deviceState.getVersion());
299
300         return Futures.allAsList(Arrays.asList(replyDesc,
301                 replyMeterFeature,
302                 replyGroupFeatures,
303 //                        replyTableFeatures,
304                 replyPortDescription));
305
306     }
307
308     @Override
309     public TranslatorLibrary oook() {
310         return translatorLibrary;
311     }
312
313     @Override
314     public void setTranslatorLibrary(final TranslatorLibrary translatorLibrary) {
315         this.translatorLibrary = translatorLibrary;
316     }
317
318     private ListenableFuture<RpcResult<List<MultipartReply>>> getNodeStaticInfo(final MultipartType type, final DeviceContext deviceContext,
319                                                                                 final InstanceIdentifier<Node> nodeII, final short version) {
320
321         final OutboundQueue queue = deviceContext.getPrimaryConnectionContext().getOutboundQueueProvider();
322         Long reservedXid = queue.reserveEntry();
323         final Xid xid = new Xid(reservedXid);
324
325         final RequestContext<List<MultipartReply>> requestContext = emptyRequestContextStack.createRequestContext();
326         requestContext.setXid(xid);
327
328         LOG.trace("Hooking xid {} to device context - precaution.", requestContext.getXid().getValue());
329         deviceContext.hookRequestCtx(requestContext.getXid(), requestContext);
330
331         final ListenableFuture<RpcResult<List<MultipartReply>>> requestContextFuture = requestContext.getFuture();
332
333         final MultiMsgCollector multiMsgCollector = deviceContext.getMultiMsgCollector();
334         multiMsgCollector.registerMultipartXid(xid.getValue());
335         queue.commitEntry(reservedXid, MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type), new FutureCallback<OfHeader>() {
336             @Override
337             public void onSuccess(final OfHeader ofHeader) {
338                 if (ofHeader instanceof MultipartReply) {
339                     MultipartReply multipartReply = (MultipartReply) ofHeader;
340                     multiMsgCollector.addMultipartMsg(multipartReply);
341                 } else {
342                     if (null != ofHeader) {
343                         LOG.info("Unexpected response type received {}.", ofHeader.getClass());
344                     } else {
345                         LOG.info("Response received is null.");
346                     }
347                 }
348
349             }
350
351             @Override
352             public void onFailure(final Throwable t) {
353                 LOG.info("Fail response from OutboundQueue.");
354             }
355         });
356
357         Futures.addCallback(requestContextFuture, new FutureCallback<RpcResult<List<MultipartReply>>>() {
358             @Override
359             public void onSuccess(final RpcResult<List<MultipartReply>> rpcResult) {
360                 final List<MultipartReply> result = rpcResult.getResult();
361                 if (result != null) {
362                     LOG.info("Static node {} info: {} collected", nodeII.toString(), type);
363                     translateAndWriteReply(type, deviceContext, nodeII, result);
364                 } else {
365                     final Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
366                     while (rpcErrorIterator.hasNext()) {
367                         final RpcError rpcError = rpcErrorIterator.next();
368                         LOG.info("Failed to retrieve static node {} info: {}", type, rpcError.getMessage());
369                         if (null != rpcError.getCause()) {
370                             LOG.trace("Detailed error:", rpcError.getCause());
371                         }
372                     }
373                     if (MultipartType.OFPMPTABLEFEATURES.equals(type)) {
374                         makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
375                     }
376                 }
377             }
378
379             @Override
380             public void onFailure(final Throwable throwable) {
381                 LOG.info("Request of type {} for static info of node {} failed.", type, nodeII);
382             }
383         });
384
385
386 /*
387         final ListenableFuture<RpcResult<Void>> rpcFuture = JdkFutureAdapters.listenInPoolThread(deviceContext.getPrimaryConnectionContext().getConnectionAdapter()
388                 .multipartRequest(MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type)));
389         final OFJResult2RequestCtxFuture OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture(requestContext, deviceContext);
390         OFJResult2RequestCtxFuture.processResultFromOfJava(rpcFuture);
391 */
392
393         return requestContext.getFuture();
394     }
395
396     // FIXME : remove after ovs tableFeatures fix
397     private static void makeEmptyTables(final DeviceContext dContext, final InstanceIdentifier<Node> nodeII, final Short nrOfTables) {
398         LOG.debug("About to create {} empty tables.", nrOfTables);
399         for (int i = 0; i < nrOfTables; i++) {
400             final short tId = (short) i;
401             final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class, new TableKey(tId));
402             final TableBuilder tableBuilder = new TableBuilder().setId(tId).addAugmentation(FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
403             dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
404         }
405     }
406
407     private static void translateAndWriteReply(final MultipartType type, final DeviceContext dContext,
408                                                final InstanceIdentifier<Node> nodeII, final Collection<MultipartReply> result) {
409         for (final MultipartReply reply : result) {
410             final MultipartReplyBody body = reply.getMultipartReplyBody();
411             switch (type) {
412                 case OFPMPDESC:
413                     Preconditions.checkArgument(body instanceof MultipartReplyDescCase);
414                     final MultipartReplyDesc replyDesc = ((MultipartReplyDescCase) body).getMultipartReplyDesc();
415                     final FlowCapableNode fcNode = NodeStaticReplyTranslatorUtil.nodeDescTranslator(replyDesc);
416                     final InstanceIdentifier<FlowCapableNode> fNodeII = nodeII.augmentation(FlowCapableNode.class);
417                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, fcNode);
418                     break;
419
420                 case OFPMPTABLEFEATURES:
421                     Preconditions.checkArgument(body instanceof MultipartReplyTableFeaturesCase);
422                     final MultipartReplyTableFeatures tableFeatures = ((MultipartReplyTableFeaturesCase) body).getMultipartReplyTableFeatures();
423                     final List<TableFeatures> tables = NodeStaticReplyTranslatorUtil.nodeTableFeatureTranslator(tableFeatures);
424                     for (final TableFeatures table : tables) {
425                         final Short tableId = table.getTableId();
426                         final InstanceIdentifier<Table> tableII = nodeII.augmentation(FlowCapableNode.class).child(Table.class, new TableKey(tableId));
427                         final TableBuilder tableBuilder = new TableBuilder().setId(tableId).setTableFeatures(Collections.singletonList(table));
428                         tableBuilder.addAugmentation(FlowTableStatisticsData.class, new FlowTableStatisticsDataBuilder().build());
429                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, tableII, tableBuilder.build());
430                     }
431                     break;
432
433                 case OFPMPMETERFEATURES:
434                     Preconditions.checkArgument(body instanceof MultipartReplyMeterFeaturesCase);
435                     final MultipartReplyMeterFeatures meterFeatures = ((MultipartReplyMeterFeaturesCase) body).getMultipartReplyMeterFeatures();
436                     final NodeMeterFeatures mFeature = NodeStaticReplyTranslatorUtil.nodeMeterFeatureTranslator(meterFeatures);
437                     final InstanceIdentifier<NodeMeterFeatures> mFeatureII = nodeII.augmentation(NodeMeterFeatures.class);
438                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, mFeatureII, mFeature);
439                     if (0L < mFeature.getMeterFeatures().getMaxMeter().getValue()) {
440                         dContext.getDeviceState().setMeterAvailable(true);
441                     }
442                     break;
443
444                 case OFPMPGROUPFEATURES:
445                     Preconditions.checkArgument(body instanceof MultipartReplyGroupFeaturesCase);
446                     final MultipartReplyGroupFeatures groupFeatures = ((MultipartReplyGroupFeaturesCase) body).getMultipartReplyGroupFeatures();
447                     final NodeGroupFeatures gFeature = NodeStaticReplyTranslatorUtil.nodeGroupFeatureTranslator(groupFeatures);
448                     final InstanceIdentifier<NodeGroupFeatures> gFeatureII = nodeII.augmentation(NodeGroupFeatures.class);
449                     dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, gFeatureII, gFeature);
450                     break;
451
452                 case OFPMPPORTDESC:
453                     Preconditions.checkArgument(body instanceof MultipartReplyPortDescCase);
454                     final MultipartReplyPortDesc portDesc = ((MultipartReplyPortDescCase) body).getMultipartReplyPortDesc();
455                     for (final PortGrouping port : portDesc.getPorts()) {
456                         final short ofVersion = dContext.getDeviceState().getVersion();
457                         final TranslatorKey translatorKey = new TranslatorKey(ofVersion, PortGrouping.class.getName());
458                         final MessageTranslator<PortGrouping, FlowCapableNodeConnector> translator = dContext.oook().lookupTranslator(translatorKey);
459                         final FlowCapableNodeConnector fcNodeConnector = translator.translate(port, dContext, null);
460
461                         final BigInteger dataPathId = dContext.getPrimaryConnectionContext().getFeatures().getDatapathId();
462                         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), port.getPortNo(), ofVersion);
463                         final NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder().setId(nodeConnectorId);
464                         ncBuilder.addAugmentation(FlowCapableNodeConnector.class, fcNodeConnector);
465                         ncBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
466                         final NodeConnector connector = ncBuilder.build();
467
468                         final InstanceIdentifier<NodeConnector> connectorII = nodeII.child(NodeConnector.class, connector.getKey());
469                         dContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, connectorII, connector);
470                     }
471
472                     break;
473
474                 default:
475                     throw new IllegalArgumentException("Unnexpected MultipartType " + type);
476             }
477         }
478     }
479
480     @Override
481     public void setNotificationService(final NotificationService notificationServiceParam) {
482         notificationService = notificationServiceParam;
483     }
484
485     @Override
486     public void setNotificationPublishService(final NotificationPublishService notificationService) {
487         this.notificationPublishService = notificationService;
488     }
489
490     @Override
491     public void close() throws Exception {
492         for (final DeviceContext deviceContext : deviceContexts) {
493             deviceContext.close();
494         }
495         if (throttledNotificationsOfferer != null) {
496             throttledNotificationsOfferer.close();
497         }
498     }
499
500     private static void createEmptyFlowCapableNodeInDs(final DeviceContext deviceContext) {
501         final FlowCapableNodeBuilder flowCapableNodeBuilder = new FlowCapableNodeBuilder();
502         final InstanceIdentifier<FlowCapableNode> fNodeII = deviceContext.getDeviceState().getNodeInstanceIdentifier().augmentation(FlowCapableNode.class);
503         deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, fNodeII, flowCapableNodeBuilder.build());
504     }
505
506     @Override
507     public void onDeviceContextClosed(final DeviceContext deviceContext) {
508         deviceContexts.remove(deviceContext);
509     }
510
511     @Override
512     public void initialize() {
513         spyPool = new ScheduledThreadPoolExecutor(1);
514         spyPool.scheduleAtFixedRate(messageIntelligenceAgency, spyRate, spyRate, TimeUnit.SECONDS);
515
516         throttledNotificationsOfferer = new ThrottledNotificationsOffererImpl<>(notificationPublishService, messageIntelligenceAgency);
517     }
518 }