Merge "Bug 6110: Fixed bugs in statistics manager due to race condition." into stable...

[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / device / DeviceContext.java

diff --git a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java
index eeabba0e55d8ffbbc9fed227b98f916f0e08ee75..b5aa65fb614fde450934fa9382f2478eb6253f0f 100644 (file)
--- a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java
+++ b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java
@@ -12,25 +12,21 @@ import com.google.common.util.concurrent.ListenableFuture;
 import io.netty.util.Timeout;
 import java.math.BigInteger;
 import java.util.List;
-import javax.annotation.CheckForNull;
-
+import javax.annotation.Nonnull;
 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
-import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
-import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
+import org.opendaylight.yangtools.yang.common.RpcResult;
 
 /**
- * <p>
  * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
  * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
  * These attach to a particular Device Context in such a way, that there is at most one primary
@@ -43,39 +39,13 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpR
  * which is enforced by keeping a cap on the number of outstanding requests a particular Request
  * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
  * a request to the switch will fail immediately, with proper error indication.
- * </p>
  */
-public interface DeviceContext extends AutoCloseable,
+public interface DeviceContext extends
+        OFPContext,
         DeviceReplyProcessor,
         TxFacade,
-        XidSequencer,
-        OFPContext,
-        DeviceRegistry{
-
-    /**
-     * distinguished device context states
-     */
-    enum DEVICE_CONTEXT_STATE {
-        /**
-         * initial phase of talking to switch
-         */
-        INITIALIZATION,
-        /**
-         * standard phase - interacting with switch
-         */
-        WORKING,
-        /**
-         * termination phase of talking to switch
-         */
-        TERMINATION
-    }
-
-    /**
-     * Method returns current device context state.
-     *
-     * @return {@link DeviceContext.DEVICE_CONTEXT_STATE}
-     */
-    DEVICE_CONTEXT_STATE getDeviceContextState();
+        DeviceRegistry,
+        RequestContextStack{
 
     /**
      * Method close all auxiliary connections and primary connection.
@@ -84,15 +54,13 @@ public interface DeviceContext extends AutoCloseable,
 
     /**
      * Method add auxiliary connection contexts to this context representing single device connection.
-     *
-     * @param connectionContext
+     * @param connectionContext new connection context
      */
     void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
 
     /**
      * Method removes auxiliary connection context from this context representing single device connection.
-     *
-     * @param connectionContext
+     * @param connectionContext connection which need to be removed
      */
     void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
 
@@ -103,8 +71,6 @@ public interface DeviceContext extends AutoCloseable,
      */
     DeviceState getDeviceState();
 
-    DeviceInfo getDeviceInfo();
-
     /**
      * Method has to close TxManager ASAP we are notified about Closed Connection
      * @return sync. future for Slave and MD-SAL completition for Master
@@ -112,18 +78,14 @@ public interface DeviceContext extends AutoCloseable,
     ListenableFuture<Void> shuttingDownDataStoreTransactions();
 
     /**
-     * Method provides current devices connection context.
-     *
-     * @return
+     * @return current devices connection context
      */
     ConnectionContext getPrimaryConnectionContext();
 
     /**
-     * Method provides current devices auxiliary connection contexts.
-     *
-     * @return
+     * @return current devices auxiliary connection contexts
      */
-    ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
+    ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
 
 
     /**
@@ -164,7 +126,30 @@ public interface DeviceContext extends AutoCloseable,
      */
     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 
-    @Override
-    void close();
+    void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
+
+    void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
+
+    void replaceConnectionContext(ConnectionContext connectionContext);
+
+    boolean isSkipTableFeatures();
+
+    /**
+     * Setter for sal role service
+     * @param salRoleService
+     */
+    void setSalRoleService(@Nonnull final SalRoleService salRoleService);
+
+    /**
+     * Make device slave
+     * @return listenable future from sal role service
+     */
+    ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave();
+
+    void sendNodeAddedNotification();
+
+    void sendNodeRemovedNotification();
+
+    void cleanupDeviceData();
 }