X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=openflowplugin-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fopenflowplugin%2Fapi%2Fopenflow%2Fdevice%2FDeviceContext.java;h=413131105b20f17b2c972a0a15f1f410f8118ec6;hb=9899c3134d7cc24e9c8d57b34d9c19b111e00e33;hp=f6adb9ef01a4701e17dd7dde4708f2f23c95f2e0;hpb=d3b898504281f4fd249f6e47944cb82a86427ea8;p=openflowplugin.git

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 f6adb9ef01..676c21c780 100644
--- 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
@@ -8,30 +8,21 @@
 
 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 org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
-import org.opendaylight.controller.md.sal.binding.api.NotificationService;
-import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
+import org.opendaylight.openflowplugin.api.openflow.OFPContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.OutstandingMessageExtractor;
-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.lifecycle.LifecycleService;
+import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
-import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
 
 /**
- * <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
@@ -44,32 +35,30 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  * 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>
- * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  */
-public interface DeviceContext extends AutoCloseable,
-        OpenFlowPluginTimer,
-        MessageHandler,
-        TranslatorLibrarian,
-        OutstandingMessageExtractor,
+public interface DeviceContext extends
+        OFPContext,
+        AutoCloseable,
         DeviceReplyProcessor,
-        DeviceDisconnectedHandler {
+        TxFacade,
+        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
+     * @param connectionContext new connection context
      */
-    void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
+    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 removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
-
+    void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
 
     /**
      * Method provides state of device represented by this device context.
@@ -79,123 +68,69 @@ public interface DeviceContext extends AutoCloseable,
     DeviceState getDeviceState();
 
     /**
-     * Method creates put operation using provided data in underlying transaction chain.
-     */
-    <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
-
-    /**
-     * Method creates delete operation for provided path in underlying transaction chain.
-     */
-    <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
-
-    /**
-     * Method exposes transaction created for device
-     * represented by this context. This read only transaction has a fresh dataStore snapshot.
-     * There is a possibility to get different data set from  DataStore
-     * as write transaction in this context.
+     * Method has to close TxManager ASAP we are notified about Closed Connection
+     * @return sync. future for Slave and MD-SAL completition for Master
      */
-    ReadTransaction getReadTransaction();
-
+    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
-     */
-    ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
-
-
-    /**
-     * @param xid key
-     * @return request by xid
+     * @return current devices auxiliary connection contexts
      */
-    RequestContext<?> lookupRequest(Xid xid);
+    ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
 
-    /**
-     * @return number of outstanding requests in map
-     */
-    int getNumberOfOutstandingRequests();
 
     /**
-     * Method writes request context into request context map. This method
-     * is ment to be used by org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava.
-     *
-     * @param xid
-     * @param requestFutureContext
+     * @return translator library
      */
-    void hookRequestCtx(Xid xid, RequestContext<?> requestFutureContext);
+    TranslatorLibrary oook();
 
     /**
-     * Method removes request context from request context map.
-     *
-     * @param xid
-     */
-    RequestContext<?> unhookRequestCtx(Xid xid);
-
-    /**
-     * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
-     *
-     * @return
+     * store cancellable timeout handler of currently running barrier task
      */
-    DeviceFlowRegistry getDeviceFlowRegistry();
+    void setCurrentBarrierTimeout(Timeout timeout);
 
     /**
-     * Method exposes device group registry used for storing group ids.
-     *
-     * @return
+     * @return cancellable timeout handle of currently running barrier task
      */
-    DeviceGroupRegistry getDeviceGroupRegistry();
+    Timeout getBarrierTaskTimeout();
 
-    /**
-     * Method exposes device meter registry used for storing meter ids.
-     *
-     * @return
-     */
-    DeviceMeterRegistry getDeviceMeterRegistry();
+    void setNotificationPublishService(NotificationPublishService notificationPublishService);
 
+    MessageSpy getMessageSpy();
 
-    /**
-     * store cancellable timeout handler of currently running barrier task
-     */
-    void setCurrentBarrierTimeout(Timeout timeout);
+    MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
 
     /**
-     * @return cancellable timeout handle of currently running barrier task
+     * indicates that device context is fully published (e.g.: packetIn messages should be passed)
      */
-    Timeout getBarrierTaskTimeout();
+    void onPublished();
 
     /**
-     * Sets notification service
+     * change packetIn rate limiter borders
      *
-     * @param notificationService
+     * @param upperBound max amount of outstanding packetIns
      */
-    void setNotificationService(NotificationService notificationService);
-
-    void setNotificationPublishService(NotificationPublishService notificationPublishService);
-
-    MessageSpy getMessageSpy();
-
-    void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler);
+    void updatePacketInRateLimit(long upperBound);
 
     /**
-     * Method sets reference to handler used for cleanup after device context about to be closed.
+     * @return registry point for item life cycle sources of device
      */
-    void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
+    ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 
-    void startGatheringOperationsToOneTransaction();
+    @Override
+    void close();
 
-    void commitOperationsGatheredInOneTransaction();
+    void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
 
-    MultiMsgCollector getMultiMsgCollector();
+    void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
 
-    Long getReservedXid();
+    void replaceConnectionContext(ConnectionContext connectionContext);
 
+    boolean isSkipTableFeatures();
 }