openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.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.annotations.VisibleForTesting;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Verify;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import io.netty.util.Timeout;
  17 import java.math.BigInteger;
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Map;
  21 import javax.annotation.Nonnull;
  22 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  23 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  24 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
  27 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  28 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  29 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
  30 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  31 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
  32 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  33 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  34 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  35 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
  36 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  37 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
  38 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  39 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  40 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  41 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
  42 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
  43 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  44 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  45 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowDescriptor;
  46 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
  47 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  48 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  49 import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleKeeper;
  50 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  51 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  52 import org.opendaylight.openflowplugin.extension.api.ConvertorMessageFromOFJava;
  53 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  54 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
  55 import org.opendaylight.openflowplugin.extension.api.exception.ConversionException;
  56 import org.opendaylight.openflowplugin.extension.api.path.MessagePath;
  57 import org.opendaylight.openflowplugin.impl.common.ItemLifeCycleSourceImpl;
  58 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
  59 import org.opendaylight.openflowplugin.impl.device.listener.MultiMsgCollectorImpl;
  60 import org.opendaylight.openflowplugin.impl.registry.flow.DeviceFlowRegistryImpl;
  61 import org.opendaylight.openflowplugin.impl.registry.flow.FlowRegistryKeyFactory;
  62 import org.opendaylight.openflowplugin.impl.registry.group.DeviceGroupRegistryImpl;
  63 import org.opendaylight.openflowplugin.impl.registry.meter.DeviceMeterRegistryImpl;
  64 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.ExperimenterMessageFromDevBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortReason;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.experimenter.types.rev151020.experimenter.core.message.ExperimenterMessageOfChoice;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsData;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.FlowCapableNodeConnectorStatisticsDataBuilder;
  92 import org.opendaylight.yangtools.yang.binding.DataObject;
  93 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  94 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  95 import org.slf4j.Logger;
  96 import org.slf4j.LoggerFactory;
  97
  98 /**
  99  *
 100  */
 101 public class DeviceContextImpl implements DeviceContext, ExtensionConverterProviderKeeper {
 102
 103     private static final Logger LOG = LoggerFactory.getLogger(DeviceContextImpl.class);
 104
 105     // TODO: drain factor should be parametrized
 106     private static final float REJECTED_DRAIN_FACTOR = 0.25f;
 107     // TODO: low water mark factor should be parametrized
 108     private static final float LOW_WATERMARK_FACTOR = 0.75f;
 109     // TODO: high water mark factor should be parametrized
 110     private static final float HIGH_WATERMARK_FACTOR = 0.95f;
 111
 112     private final ConnectionContext primaryConnectionContext;
 113     private final DeviceState deviceState;
 114     private final DataBroker dataBroker;
 115     private final Map<SwitchConnectionDistinguisher, ConnectionContext> auxiliaryConnectionContexts;
 116     private final TransactionChainManager transactionChainManager;
 117     private final DeviceFlowRegistry deviceFlowRegistry;
 118     private final DeviceGroupRegistry deviceGroupRegistry;
 119     private final DeviceMeterRegistry deviceMeterRegistry;
 120     private final PacketInRateLimiter packetInLimiter;
 121     private final MessageSpy messageSpy;
 122     private final ItemLifeCycleKeeper flowLifeCycleKeeper;
 123     private NotificationPublishService notificationPublishService;
 124     private final OutboundQueue outboundQueueProvider;
 125     private Timeout barrierTaskTimeout;
 126     private final MessageTranslator<PortGrouping, FlowCapableNodeConnector> portStatusTranslator;
 127     private final MessageTranslator<PacketInMessage, PacketReceived> packetInTranslator;
 128     private final MessageTranslator<FlowRemoved, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved> flowRemovedTranslator;
 129     private final TranslatorLibrary translatorLibrary;
 130     private final ItemLifeCycleRegistry itemLifeCycleSourceRegistry;
 131     private ExtensionConverterProvider extensionConverterProvider;
 132
 133     private final DeviceInfo deviceInfo;
 134
 135     private volatile CONTEXT_STATE contextState;
 136
 137     @VisibleForTesting
 138     DeviceContextImpl(@Nonnull final ConnectionContext primaryConnectionContext,
 139                       @Nonnull final DeviceState deviceState,
 140                       @Nonnull final DataBroker dataBroker,
 141                       @Nonnull final LifecycleConductor conductor,
 142                       @Nonnull final OutboundQueueProvider outboundQueueProvider,
 143                       @Nonnull final TranslatorLibrary translatorLibrary) {
 144         this.primaryConnectionContext = Preconditions.checkNotNull(primaryConnectionContext);
 145         this.deviceState = Preconditions.checkNotNull(deviceState);
 146         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 147         Preconditions.checkNotNull(conductor);
 148         this.outboundQueueProvider = Preconditions.checkNotNull(outboundQueueProvider);
 149         deviceInfo = primaryConnectionContext.getDeviceInfo();
 150         this.transactionChainManager = new TransactionChainManager(dataBroker, deviceInfo, conductor);
 151         auxiliaryConnectionContexts = new HashMap<>();
 152         deviceFlowRegistry = new DeviceFlowRegistryImpl(dataBroker);
 153         deviceGroupRegistry = new DeviceGroupRegistryImpl();
 154         deviceMeterRegistry = new DeviceMeterRegistryImpl();
 155         messageSpy = conductor.getMessageIntelligenceAgency();
 156
 157
 158         packetInLimiter = new PacketInRateLimiter(primaryConnectionContext.getConnectionAdapter(),
 159                 /*initial*/ 1000, /*initial*/2000, messageSpy, REJECTED_DRAIN_FACTOR);
 160
 161         this.translatorLibrary = translatorLibrary;
 162         portStatusTranslator = translatorLibrary.lookupTranslator(
 163                 new TranslatorKey(deviceInfo.getVersion(), PortGrouping.class.getName()));
 164         packetInTranslator = translatorLibrary.lookupTranslator(
 165                 new TranslatorKey(deviceInfo.getVersion(), PacketIn.class.getName()));
 166         flowRemovedTranslator = translatorLibrary.lookupTranslator(
 167                 new TranslatorKey(deviceInfo.getVersion(), FlowRemoved.class.getName()));
 168
 169         itemLifeCycleSourceRegistry = new ItemLifeCycleRegistryImpl();
 170         flowLifeCycleKeeper = new ItemLifeCycleSourceImpl();
 171         itemLifeCycleSourceRegistry.registerLifeCycleSource(flowLifeCycleKeeper);
 172         contextState = CONTEXT_STATE.INITIALIZATION;
 173     }
 174
 175     /**
 176      * This method is called from {@link DeviceManagerImpl} only. So we could say "posthandshake process finish"
 177      * and we are able to set a scheduler for an automatic transaction submitting by time (0,5sec).
 178      */
 179     void initialSubmitTransaction() {
 180         transactionChainManager.initialSubmitWriteTransaction();
 181     }
 182
 183     @Override
 184     public Long reserveXidForDeviceMessage() {
 185         return outboundQueueProvider.reserveEntry();
 186     }
 187
 188     @Override
 189     public void addAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
 190         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 191         auxiliaryConnectionContexts.put(connectionDistinguisher, connectionContext);
 192     }
 193
 194     private static SwitchConnectionDistinguisher createConnectionDistinguisher(final ConnectionContext connectionContext) {
 195         return new SwitchConnectionCookieOFImpl(connectionContext.getFeatures().getAuxiliaryId());
 196     }
 197
 198     @Override
 199     public void removeAuxiliaryConnectionContext(final ConnectionContext connectionContext) {
 200         final SwitchConnectionDistinguisher connectionDistinguisher = createConnectionDistinguisher(connectionContext);
 201         LOG.debug("auxiliary connection dropped: {}, nodeId:{}", connectionContext.getConnectionAdapter()
 202                 .getRemoteAddress(), deviceInfo.getNodeId());
 203         auxiliaryConnectionContexts.remove(connectionDistinguisher);
 204     }
 205
 206     @Override
 207     public DeviceState getDeviceState() {
 208         return deviceState;
 209     }
 210
 211     @Override
 212     public DeviceInfo getDeviceInfo() {
 213         return this.deviceInfo;
 214     }
 215
 216     @Override
 217     public ReadOnlyTransaction getReadTransaction() {
 218         return dataBroker.newReadOnlyTransaction();
 219     }
 220
 221     @Override
 222     public <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store,
 223                                                           final InstanceIdentifier<T> path, final T data) throws TransactionChainClosedException {
 224         transactionChainManager.writeToTransaction(store, path, data, false);
 225     }
 226
 227     @Override
 228     public <T extends DataObject> void writeToTransactionWithParentsSlow(LogicalDatastoreType store, InstanceIdentifier<T> path, T data) throws TransactionChainClosedException {
 229         transactionChainManager.writeToTransaction(store, path, data, true);
 230     }
 231
 232     @Override
 233     public <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path) throws TransactionChainClosedException {
 234         transactionChainManager.addDeleteOperationTotTxChain(store, path);
 235     }
 236
 237     @Override
 238     public boolean submitTransaction() {
 239         return transactionChainManager.submitWriteTransaction();
 240     }
 241
 242     @Override
 243     public ConnectionContext getPrimaryConnectionContext() {
 244         return primaryConnectionContext;
 245     }
 246
 247     @Override
 248     public ConnectionContext getAuxiliaryConnectiobContexts(final BigInteger cookie) {
 249         return auxiliaryConnectionContexts.get(new SwitchConnectionCookieOFImpl(cookie.longValue()));
 250     }
 251
 252     @Override
 253     public DeviceFlowRegistry getDeviceFlowRegistry() {
 254         return deviceFlowRegistry;
 255     }
 256
 257     @Override
 258     public DeviceGroupRegistry getDeviceGroupRegistry() {
 259         return deviceGroupRegistry;
 260     }
 261
 262     @Override
 263     public DeviceMeterRegistry getDeviceMeterRegistry() {
 264         return deviceMeterRegistry;
 265     }
 266
 267     @Override
 268     public void processReply(final OfHeader ofHeader) {
 269         if (ofHeader instanceof Error) {
 270             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 271         } else {
 272             messageSpy.spyMessage(ofHeader.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 273         }
 274     }
 275
 276     @Override
 277     public void processReply(final Xid xid, final List<MultipartReply> ofHeaderList) {
 278         for (final MultipartReply multipartReply : ofHeaderList) {
 279             messageSpy.spyMessage(multipartReply.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_FAILURE);
 280         }
 281     }
 282
 283     @Override
 284     public void processFlowRemovedMessage(final FlowRemoved flowRemoved) {
 285         //1. translate to general flow (table, priority, match, cookie)
 286         final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved flowRemovedNotification =
 287                 flowRemovedTranslator.translate(flowRemoved, deviceInfo, null);
 288         // Trigger off a notification
 289         notificationPublishService.offerNotification(flowRemovedNotification);
 290
 291         final ItemLifecycleListener itemLifecycleListener = flowLifeCycleKeeper.getItemLifecycleListener();
 292         if (itemLifecycleListener != null) {
 293             //2. create registry key
 294             final FlowRegistryKey flowRegKey = FlowRegistryKeyFactory.create(flowRemovedNotification);
 295             //3. lookup flowId
 296             final FlowDescriptor flowDescriptor = deviceFlowRegistry.retrieveIdForFlow(flowRegKey);
 297             //4. if flowId present:
 298             if (flowDescriptor != null) {
 299                 // a) construct flow path
 300                 final KeyedInstanceIdentifier<Flow, FlowKey> flowPath = getDeviceInfo().getNodeInstanceIdentifier()
 301                         .augmentation(FlowCapableNode.class)
 302                         .child(Table.class, flowDescriptor.getTableKey())
 303                         .child(Flow.class, new FlowKey(flowDescriptor.getFlowId()));
 304                 // b) notify listener
 305                 itemLifecycleListener.onRemoved(flowPath);
 306             } else {
 307                 LOG.debug("flow id not found: nodeId={} tableId={}, priority={}",
 308                         getDeviceInfo().getNodeId(), flowRegKey.getTableId(), flowRemovedNotification.getPriority());
 309             }
 310         }
 311     }
 312
 313     @Override
 314     public void processPortStatusMessage(final PortStatusMessage portStatus) {
 315         messageSpy.spyMessage(portStatus.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 316         final FlowCapableNodeConnector flowCapableNodeConnector = portStatusTranslator.translate(portStatus, deviceInfo, null);
 317
 318         final KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> iiToNodeConnector = provideIIToNodeConnector(portStatus.getPortNo(), portStatus.getVersion());
 319         try {
 320             if (portStatus.getReason().equals(PortReason.OFPPRADD) || portStatus.getReason().equals(PortReason.OFPPRMODIFY)) {
 321                 // because of ADD status node connector has to be created
 322                 final NodeConnectorBuilder nConnectorBuilder = new NodeConnectorBuilder().setKey(iiToNodeConnector.getKey());
 323                 nConnectorBuilder.addAugmentation(FlowCapableNodeConnectorStatisticsData.class, new FlowCapableNodeConnectorStatisticsDataBuilder().build());
 324                 nConnectorBuilder.addAugmentation(FlowCapableNodeConnector.class, flowCapableNodeConnector);
 325                 writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector, nConnectorBuilder.build());
 326             } else if (portStatus.getReason().equals(PortReason.OFPPRDELETE)) {
 327                 addDeleteToTxChain(LogicalDatastoreType.OPERATIONAL, iiToNodeConnector);
 328             }
 329             submitTransaction();
 330         } catch (final Exception e) {
 331             LOG.warn("Error processing port status message: {}", e.getMessage());
 332         }
 333     }
 334
 335     private KeyedInstanceIdentifier<NodeConnector, NodeConnectorKey> provideIIToNodeConnector(final long portNo, final short version) {
 336         final InstanceIdentifier<Node> iiToNodes = deviceInfo.getNodeInstanceIdentifier();
 337         final BigInteger dataPathId = deviceInfo.getDatapathId();
 338         final NodeConnectorId nodeConnectorId = NodeStaticReplyTranslatorUtil.nodeConnectorId(dataPathId.toString(), portNo, version);
 339         return iiToNodes.child(NodeConnector.class, new NodeConnectorKey(nodeConnectorId));
 340     }
 341
 342     @Override
 343     public void processPacketInMessage(final PacketInMessage packetInMessage) {
 344         messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH);
 345         final ConnectionAdapter connectionAdapter = getPrimaryConnectionContext().getConnectionAdapter();
 346         final PacketReceived packetReceived = packetInTranslator.translate(packetInMessage, deviceInfo, null);
 347
 348         if (packetReceived == null) {
 349             LOG.debug("Received a null packet from switch {}", connectionAdapter.getRemoteAddress());
 350             messageSpy.spyMessage(packetInMessage.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_SRC_FAILURE);
 351             return;
 352         } else {
 353             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_TRANSLATE_OUT_SUCCESS);
 354         }
 355
 356         if (!packetInLimiter.acquirePermit()) {
 357             LOG.debug("Packet limited");
 358             // TODO: save packet into emergency slot if possible
 359             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PACKET_IN_LIMIT_REACHED_AND_DROPPED);
 360             return;
 361         }
 362
 363         final ListenableFuture<?> offerNotification = notificationPublishService.offerNotification(packetReceived);
 364         if (NotificationPublishService.REJECTED.equals(offerNotification)) {
 365             LOG.debug("notification offer rejected");
 366             messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 367             packetInLimiter.drainLowWaterMark();
 368             packetInLimiter.releasePermit();
 369             return;
 370         }
 371
 372         Futures.addCallback(offerNotification, new FutureCallback<Object>() {
 373             @Override
 374             public void onSuccess(final Object result) {
 375                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_PUBLISHED_SUCCESS);
 376                 packetInLimiter.releasePermit();
 377             }
 378
 379             @Override
 380             public void onFailure(final Throwable t) {
 381                 messageSpy.spyMessage(packetReceived.getImplementedInterface(), MessageSpy.STATISTIC_GROUP.FROM_SWITCH_NOTIFICATION_REJECTED);
 382                 LOG.debug("notification offer failed: {}", t.getMessage());
 383                 LOG.trace("notification offer failed..", t);
 384                 packetInLimiter.releasePermit();
 385             }
 386         });
 387     }
 388
 389     @Override
 390     public void processExperimenterMessage(final ExperimenterMessage notification) {
 391         // lookup converter
 392         final ExperimenterDataOfChoice vendorData = notification.getExperimenterDataOfChoice();
 393         final MessageTypeKey<? extends ExperimenterDataOfChoice> key = new MessageTypeKey<>(
 394                 deviceInfo.getVersion(),
 395                 (Class<? extends ExperimenterDataOfChoice>) vendorData.getImplementedInterface());
 396         final ConvertorMessageFromOFJava<ExperimenterDataOfChoice, MessagePath> messageConverter = extensionConverterProvider.getMessageConverter(key);
 397         if (messageConverter == null) {
 398             LOG.warn("custom converter for {}[OF:{}] not found",
 399                     notification.getExperimenterDataOfChoice().getImplementedInterface(),
 400                     deviceInfo.getVersion());
 401             return;
 402         }
 403         // build notification
 404         final ExperimenterMessageOfChoice messageOfChoice;
 405         try {
 406             messageOfChoice = messageConverter.convert(vendorData, MessagePath.MESSAGE_NOTIFICATION);
 407             final ExperimenterMessageFromDevBuilder experimenterMessageFromDevBld = new ExperimenterMessageFromDevBuilder()
 408                 .setNode(new NodeRef(deviceInfo.getNodeInstanceIdentifier()))
 409                     .setExperimenterMessageOfChoice(messageOfChoice);
 410             // publish
 411             notificationPublishService.offerNotification(experimenterMessageFromDevBld.build());
 412         } catch (final ConversionException e) {
 413             LOG.error("Conversion of experimenter notification failed", e);
 414         }
 415     }
 416
 417     @Override
 418     public TranslatorLibrary oook() {
 419         return translatorLibrary;
 420     }
 421
 422     @Override
 423     public synchronized void close() {
 424         LOG.debug("closing deviceContext: {}, nodeId:{}",
 425                 getPrimaryConnectionContext().getConnectionAdapter().getRemoteAddress(),
 426                 getDeviceInfo().getNodeId());
 427         // NOOP
 428         throw new UnsupportedOperationException("Autocloseble.close will be removed soon");
 429     }
 430
 431     @Override
 432     public void setCurrentBarrierTimeout(final Timeout timeout) {
 433         barrierTaskTimeout = timeout;
 434     }
 435
 436     @Override
 437     public Timeout getBarrierTaskTimeout() {
 438         return barrierTaskTimeout;
 439     }
 440
 441     @Override
 442     public void setNotificationPublishService(final NotificationPublishService notificationPublishService) {
 443         this.notificationPublishService = notificationPublishService;
 444     }
 445
 446     @Override
 447     public MessageSpy getMessageSpy() {
 448         return messageSpy;
 449     }
 450
 451     @Override
 452     public void onPublished() {
 453         Verify.verify(CONTEXT_STATE.INITIALIZATION.equals(contextState));
 454         contextState = CONTEXT_STATE.WORKING;
 455         primaryConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 456         for (final ConnectionContext switchAuxConnectionContext : auxiliaryConnectionContexts.values()) {
 457             switchAuxConnectionContext.getConnectionAdapter().setPacketInFiltering(false);
 458         }
 459     }
 460
 461     @Override
 462     public MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext) {
 463         return new MultiMsgCollectorImpl(this, requestContext);
 464     }
 465
 466     @Override
 467     public void updatePacketInRateLimit(final long upperBound) {
 468         packetInLimiter.changeWaterMarks((int) (LOW_WATERMARK_FACTOR * upperBound), (int) (HIGH_WATERMARK_FACTOR * upperBound));
 469     }
 470
 471     @Override
 472     public ItemLifeCycleRegistry getItemLifeCycleSourceRegistry() {
 473         return itemLifeCycleSourceRegistry;
 474     }
 475
 476     @Override
 477     public void setExtensionConverterProvider(final ExtensionConverterProvider extensionConverterProvider) {
 478         this.extensionConverterProvider = extensionConverterProvider;
 479     }
 480
 481     @Override
 482     public ExtensionConverterProvider getExtensionConverterProvider() {
 483         return extensionConverterProvider;
 484     }
 485
 486     @Override
 487     public synchronized void shutdownConnection() {
 488         LOG.debug("Shutdown method for node {}", deviceInfo.getNodeId());
 489         if (CONTEXT_STATE.TERMINATION.equals(contextState)) {
 490             LOG.debug("DeviceCtx for Node {} is in termination process.", deviceInfo.getNodeId());
 491             return;
 492         }
 493         contextState = CONTEXT_STATE.TERMINATION;
 494
 495         if (ConnectionContext.CONNECTION_STATE.RIP.equals(getPrimaryConnectionContext().getConnectionState())) {
 496             LOG.debug("ConnectionCtx for Node {} is in RIP state.", deviceInfo.getNodeId());
 497             return;
 498         }
 499         /* Terminate Auxiliary Connection */
 500         for (final ConnectionContext connectionContext : auxiliaryConnectionContexts.values()) {
 501             LOG.debug("Closing auxiliary connection {}", connectionContext.getNodeId());
 502             connectionContext.closeConnection(false);
 503         }
 504         /* Terminate Primary Connection */
 505         getPrimaryConnectionContext().closeConnection(true);
 506         /* Close all Group Registry */
 507         deviceGroupRegistry.close();
 508         deviceFlowRegistry.close();
 509         deviceMeterRegistry.close();
 510     }
 511
 512     @Override
 513     public ListenableFuture<Void> shuttingDownDataStoreTransactions() {
 514         return transactionChainManager.shuttingDown();
 515     }
 516
 517     @VisibleForTesting
 518     TransactionChainManager getTransactionChainManager() {
 519         return this.transactionChainManager;
 520     }
 521
 522     @Override
 523     public CONTEXT_STATE getState() {
 524         return this.contextState;
 525     }
 526 }