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