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