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