Bug 5596 Created lifecycle service
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / rpc / RpcContextImpl.java
index b450077582f1238fc11ac25b8d23bdf75a1f1b1e..1a8cb845f1452b8760ae60369c48f0bf7b4e0fe8 100644 (file)
@@ -7,38 +7,58 @@
  */
 package org.opendaylight.openflowplugin.impl.rpc;
 
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.Iterators;
+import java.util.Iterator;
+import java.util.Map.Entry;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.Semaphore;
-
-import com.google.common.base.Preconditions;
 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
-import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
-import org.opendaylight.openflowplugin.api.openflow.rpc.ItemLifeCycleSource;
+import org.opendaylight.openflowplugin.api.openflow.device.XidSequencer;
 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.RpcService;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class RpcContextImpl implements RpcContext {
+class RpcContextImpl implements RpcContext {
     private static final Logger LOG = LoggerFactory.getLogger(RpcContextImpl.class);
     private final RpcProviderRegistry rpcProviderRegistry;
-    private final DeviceContext deviceContext;
     private final MessageSpy messageSpy;
     private final Semaphore tracker;
+    private final XidSequencer xidSequencer;
+    private boolean isStatisticsRpcEnabled;
 
     // TODO: add private Sal salBroker
     private final ConcurrentMap<Class<?>, RoutedRpcRegistration<?>> rpcRegistrations = new ConcurrentHashMap<>();
+    private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
+    private CONTEXT_STATE state;
+    private final DeviceInfo deviceInfo;
+
+    RpcContextImpl(final DeviceInfo deviceInfo,
+                   final RpcProviderRegistry rpcProviderRegistry,
+                   final XidSequencer xidSequencer,
+                   final MessageSpy messageSpy,
+                   final int maxRequests,
+                   final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier) {
+        this.xidSequencer = Preconditions.checkNotNull(xidSequencer);
+        this.messageSpy = Preconditions.checkNotNull(messageSpy);
+        this.rpcProviderRegistry = Preconditions.checkNotNull(rpcProviderRegistry);
+        this.nodeInstanceIdentifier = nodeInstanceIdentifier;
 
-    public RpcContextImpl(final MessageSpy messageSpy, final RpcProviderRegistry rpcProviderRegistry, final DeviceContext deviceContext, final int maxRequests) {
-        this.messageSpy = messageSpy;
-        this.rpcProviderRegistry = rpcProviderRegistry;
-        this.deviceContext = Preconditions.checkNotNull(deviceContext);
         tracker = new Semaphore(maxRequests, true);
+        setState(CONTEXT_STATE.WORKING);
+        this.deviceInfo = deviceInfo;
     }
 
     /**
@@ -48,31 +68,22 @@ public class RpcContextImpl implements RpcContext {
     @Override
     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
                                                                         final S serviceInstance) {
+        LOG.trace("Try to register service {} for device {}.", serviceClass, nodeInstanceIdentifier);
         if (! rpcRegistrations.containsKey(serviceClass)) {
             final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
-            routedRpcReg.registerPath(NodeContext.class, deviceContext.getDeviceState().getNodeInstanceIdentifier());
+            routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
             rpcRegistrations.put(serviceClass, routedRpcReg);
-        }
-        LOG.debug("Registration of service {} for device {}.", serviceClass, deviceContext.getDeviceState().getNodeInstanceIdentifier());
-
-        if (serviceInstance instanceof ItemLifeCycleSource) {
-            // TODO: collect registration for selective unregistering in case of tearing down only one rpc
-            deviceContext.getItemLifeCycleSourceRegistry().registerLifeCycleSource((ItemLifeCycleSource) serviceInstance);
+            LOG.debug("Registration of service {} for device {}.", serviceClass, nodeInstanceIdentifier);
         }
     }
 
     @Override
-    public <S extends RpcService> S lookupRpcService(Class<S> serviceClass) {
-        S service = null;
-        for (RoutedRpcRegistration<?> rpcRegistration : rpcRegistrations.values()) {
-            final RpcService rpcService = rpcRegistration.getInstance();
-            if (serviceClass.isInstance(rpcService)) {
-                service = (S) rpcService;
-                break;
-            }
-        }
-        return service;
+    public <S extends RpcService> S lookupRpcService(final Class<S> serviceClass) {
+        RoutedRpcRegistration<?> registration = rpcRegistrations.get(serviceClass);
+        final RpcService rpcService = registration.getInstance();
+        return (S) rpcService;
     }
+
     /**
      * Unregisters all services.
      *
@@ -80,11 +91,20 @@ public class RpcContextImpl implements RpcContext {
      */
     @Override
     public void close() {
-        for (final RoutedRpcRegistration<?> rpcRegistration : rpcRegistrations.values()) {
-            rpcRegistration.unregisterPath(NodeContext.class, deviceContext.getDeviceState().getNodeInstanceIdentifier());
-            rpcRegistration.close();
-            LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType(),
-                    deviceContext.getDeviceState().getNodeInstanceIdentifier());
+        if (CONTEXT_STATE.TERMINATION.equals(getState())){
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("RpcContext is already in TERMINATION state.");
+            }
+        } else {
+            setState(CONTEXT_STATE.TERMINATION);
+            for (final Iterator<Entry<Class<?>, RoutedRpcRegistration<?>>> iterator = Iterators
+                    .consumingIterator(rpcRegistrations.entrySet().iterator()); iterator.hasNext(); ) {
+                final RoutedRpcRegistration<?> rpcRegistration = iterator.next().getValue();
+                rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
+                rpcRegistration.close();
+                LOG.debug("Closing RPC Registration of service {} for device {}.", rpcRegistration.getServiceType(),
+                        nodeInstanceIdentifier);
+            }
         }
     }
 
@@ -94,20 +114,22 @@ public class RpcContextImpl implements RpcContext {
             LOG.trace("Device queue {} at capacity", this);
             return null;
         } else {
-            LOG.info("Acquired semaphore for {}, available permits:{} ", deviceContext.getDeviceState().getNodeId(), tracker.availablePermits());
+            LOG.trace("Acquired semaphore for {}, available permits:{} ", nodeInstanceIdentifier.getKey().getId(), tracker.availablePermits());
         }
 
-        final Long xid = deviceContext.reservedXidForDeviceMessage();
+        final Long xid = xidSequencer.reserveXidForDeviceMessage();
         if (xid == null) {
-            LOG.error("Xid cannot be reserved for new RequestContext, node:{}", deviceContext.getDeviceState().getNodeId());
+            LOG.warn("Xid cannot be reserved for new RequestContext, node:{}", nodeInstanceIdentifier.getKey().getId());
+            tracker.release();
+            return null;
         }
 
-        return new AbstractRequestContext<T>(deviceContext.reservedXidForDeviceMessage()) {
+        return new AbstractRequestContext<T>(xid) {
             @Override
             public void close() {
                 tracker.release();
                 final long xid = getXid().getValue();
-                LOG.info("Removed request context with xid {}", xid);
+                LOG.trace("Removed request context with xid {}", xid);
                 messageSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
             }
         };
@@ -115,11 +137,47 @@ public class RpcContextImpl implements RpcContext {
 
     @Override
     public <S extends RpcService> void unregisterRpcServiceImplementation(final Class<S> serviceClass) {
-        LOG.debug("Unregistration serviceClass {} for Node {}", serviceClass, deviceContext.getDeviceState().getNodeId());
+        LOG.trace("Try to unregister serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
         final RoutedRpcRegistration<?> rpcRegistration = rpcRegistrations.remove(serviceClass);
         if (rpcRegistration != null) {
-            rpcRegistration.unregisterPath(NodeContext.class, deviceContext.getDeviceState().getNodeInstanceIdentifier());
+            rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
             rpcRegistration.close();
+            LOG.debug("Unregistration serviceClass {} for Node {}", serviceClass, nodeInstanceIdentifier.getKey().getId());
         }
     }
+
+    @VisibleForTesting
+    boolean isEmptyRpcRegistrations() {
+        return this.rpcRegistrations.isEmpty();
+    }
+
+    @Override
+    public void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled) {
+        this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
+    }
+
+    @Override
+    public boolean isStatisticsRpcEnabled() {
+        return isStatisticsRpcEnabled;
+    }
+
+    @Override
+    public CONTEXT_STATE getState() {
+        return this.state;
+    }
+
+    @Override
+    public void setState(CONTEXT_STATE state) {
+        this.state = state;
+    }
+
+    @Override
+    public ServiceGroupIdentifier getServiceIdentifier() {
+        return this.deviceInfo.getServiceIdentifier();
+    }
+
+    @Override
+    public DeviceInfo getDeviceInfo() {
+        return this.deviceInfo;
+    }
 }