Bug 5596 Cleaning part 1
[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / device / DeviceContext.java
index 79b84011b4c720689439c52e73c03cdd65952b36..c7dca5069ad58c2d8c97c429a833c8be21e2f2b1 100644 (file)
@@ -12,22 +12,14 @@ 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 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.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;
 
 /**
  * <p>
@@ -45,56 +37,30 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpR
  * a request to the switch will fail immediately, with proper error indication.
  * </p>
  */
-public interface DeviceContext extends AutoCloseable,
+public interface DeviceContext extends
+        OFPContext,
+        AutoCloseable,
         DeviceReplyProcessor,
-        PortNumberCache,
         TxFacade,
         XidSequencer,
-        OFPContext{
-
-    void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled);
-
-    /**
-     * 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{
 
     /**
      * Method close all auxiliary connections and primary connection.
      */
     void shutdownConnection();
 
+    void initialSubmitTransaction();
+
     /**
      * 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);
 
@@ -105,29 +71,6 @@ public interface DeviceContext extends AutoCloseable,
      */
     DeviceState getDeviceState();
 
-    DeviceInfo getDeviceInfo();
-
-    /**
-     * Method has to activate (MASTER) or deactivate (SLAVE) TransactionChainManager.
-     * TransactionChainManager represents possibility to write or delete Node subtree data
-     * for actual Controller Cluster Node. We are able to have an active TxManager only if
-     * newRole is {@link OfpRole#BECOMESLAVE}.
-     * Parameters are used as marker to be sure it is change to SLAVE from MASTER or from
-     * MASTER to SLAVE and the last parameter "cleanDataStore" is used for validation only.
-     * @param role - NewRole expect to be {@link OfpRole#BECOMESLAVE} or {@link OfpRole#BECOMEMASTER}
-     * @return RoleChangeTxChainManager future for activation/deactivation
-     * @deprecated replaced by method onDeviceTakeClusterLeadership and onDevicLostClusterLeadership
-     */
-    @Deprecated
-    ListenableFuture<Void> onClusterRoleChange(@CheckForNull OfpRole role);
-
-    /**
-     * Method has to activate TransactionChainManager and prepare all Contexts from Device Contects suite
-     * to Taking ClusterLeadership role {@link OfpRole#BECOMEMASTER} (e.g. Routed RPC registration, StatPolling ...)
-     * @return DeviceInitialization furure
-     */
-    ListenableFuture<Void> onDeviceTakeClusterLeadership();
-
     /**
      * Method has to close TxManager ASAP we are notified about Closed Connection
      * @return sync. future for Slave and MD-SAL completition for Master
@@ -135,40 +78,15 @@ 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);
 
-    /**
-     * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
-     *
-     * @return
-     */
-    DeviceFlowRegistry getDeviceFlowRegistry();
-
-    /**
-     * Method exposes device group registry used for storing group ids.
-     *
-     * @return
-     */
-    DeviceGroupRegistry getDeviceGroupRegistry();
-
-    /**
-     * Method exposes device meter registry used for storing meter ids.
-     *
-     * @return
-     */
-    DeviceMeterRegistry getDeviceMeterRegistry();
-
 
     /**
      * @return translator library
@@ -208,15 +126,10 @@ public interface DeviceContext extends AutoCloseable,
      */
     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 
-    void setRpcContext(RpcContext rpcContext);
-
-    RpcContext getRpcContext();
-
-    void setStatisticsContext(StatisticsContext statisticsContext);
-
-    StatisticsContext getStatisticsContext();
-
     @Override
     void close();
+
+    void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
+
 }