Encapsulate OpenFlowPlugin configuration

[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 c5baf45cf6dade2d5cfdbc072af403f4efb421ee..87e25b08b55b762a0df3c13caa58a8a55ae5fb99 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
@@ -9,20 +9,22 @@
 package org.opendaylight.openflowplugin.api.openflow.device;
 
 import com.google.common.util.concurrent.ListenableFuture;
-import io.netty.util.Timeout;
-import java.math.BigInteger;
 import java.util.List;
+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.ContextChainStateListener;
 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
 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.openflow.protocol.rev130731.OfHeader;
+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
@@ -35,33 +37,14 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
  * 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{
-
-    /**
-     * Method close all auxiliary connections and primary connection.
-     */
-    void shutdownConnection();
-
-    /**
-     * Method add auxiliary connection contexts to this context representing single device connection.
-     *
-     * @param connectionContext
-     */
-    void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
-
-    /**
-     * Method removes auxiliary connection context from this context representing single device connection.
-     *
-     * @param connectionContext
-     */
-    void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
+        DeviceRegistry,
+        RequestContextStack,
+        ContextChainStateListener {
 
     /**
      * Method provides state of device represented by this device context.
@@ -70,68 +53,53 @@ 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
-     */
-    ListenableFuture<Void> shuttingDownDataStoreTransactions();
-
-    /**
-     * Method provides current devices connection context.
-     *
-     * @return
+     * Getter.
+     * @return current devices connection context
      */
     ConnectionContext getPrimaryConnectionContext();
 
     /**
-     * Method provides current devices auxiliary connection contexts.
-     *
-     * @return
-     */
-    ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
-
-
-    /**
+     * Getter.
      * @return translator library
      */
     TranslatorLibrary oook();
 
-    /**
-     * store cancellable timeout handler of currently running barrier task
-     */
-    void setCurrentBarrierTimeout(Timeout timeout);
-
-    /**
-     * @return cancellable timeout handle of currently running barrier task
-     */
-    Timeout getBarrierTaskTimeout();
-
     void setNotificationPublishService(NotificationPublishService notificationPublishService);
 
     MessageSpy getMessageSpy();
 
-    MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
+    <T extends OfHeader> MultiMsgCollector<T> getMultiMsgCollector(RequestContext<List<T>> requestContext);
 
     /**
-     * indicates that device context is fully published (e.g.: packetIn messages should be passed)
+     * indicates that device context is fully published (e.g.: packetIn messages should be passed).
      */
     void onPublished();
 
     /**
-     * change packetIn rate limiter borders
-     *
+     * change packetIn rate limiter borders.
      * @param upperBound max amount of outstanding packetIns
      */
     void updatePacketInRateLimit(long upperBound);
 
     /**
+     * Getter.
      * @return registry point for item life cycle sources of device
      */
     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 
-    @Override
-    void close();
+    /**
+     * Setter for sal role service.
+     * @param salRoleService Role Service
+     */
+    void setSalRoleService(@Nonnull SalRoleService salRoleService);
+
+    /**
+     * Make device slave.
+     * @return listenable future from sal role service
+     */
+    ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave();
+
+    boolean canUseSingleLayerSerialization();
 }