Merge "Bug-4957: Make async operational DS Read"
[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / device / DeviceContext.java
index f6788e1ac951801ad460330268ebf27cb595251c..d0c282d0ab42896d54dfeec212584903234fd00a 100644 (file)
@@ -8,24 +8,31 @@
 
 package org.opendaylight.openflowplugin.api.openflow.device;
 
+import javax.annotation.CheckForNull;
+import com.google.common.util.concurrent.ListenableFuture;
 import io.netty.util.Timeout;
 import java.math.BigInteger;
-import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
+import java.util.List;
+
+import io.netty.util.Timeout;
+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.ReadOnlyTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
 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.OutstandingMessageExtractor;
-import org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade;
+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.ofpspecific.MessageSpy;
-import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
+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.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
@@ -48,11 +55,9 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  */
 public interface DeviceContext extends AutoCloseable,
         OpenFlowPluginTimer,
-        MessageHandler,
-        TranslatorLibrarian,
-        OutstandingMessageExtractor,
         DeviceReplyProcessor,
-        DeviceDisconnectedHandler {
+        DeviceDisconnectedHandler,
+        PortNumberCache {
 
 
     /**
@@ -77,6 +82,17 @@ public interface DeviceContext extends AutoCloseable,
      */
     DeviceState getDeviceState();
 
+    /**
+     * 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}
+     */
+    ListenableFuture<Void> onClusterRoleChange(@CheckForNull OfpRole role);
+
     /**
      * Method creates put operation using provided data in underlying transaction chain.
      */
@@ -87,13 +103,20 @@ public interface DeviceContext extends AutoCloseable,
      */
     <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
 
+    /**
+     * Method submits Transaction to DataStore.
+     * @return transaction is submitted successfully
+     */
+    boolean submitTransaction();
+
     /**
      * 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.
+     * @return readOnlyTransaction - Don't forget to close it after finish reading
      */
-    ReadTransaction getReadTransaction();
+    ReadOnlyTransaction getReadTransaction();
 
 
     /**
@@ -110,54 +133,6 @@ public interface DeviceContext extends AutoCloseable,
      */
     ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
 
-    /**
-     * Method generates unique XID value.
-     *
-     * @return
-     */
-    Xid getNextXid();
-
-    /**
-     * @param xid key
-     * @return request by xid
-     */
-    RequestContext lookupRequest(Xid xid);
-
-    /**
-     * @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
-     */
-    void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
-
-    /**
-     * Method removes request context from request context map.
-     *
-     * @param xid
-     */
-    RequestContext unhookRequestCtx(Xid xid);
-
-    /**
-     * Method that attaches anyMessageTypeListener to connection adapters as message listener.
-     *
-     * @param openflowMessageListenerFacade
-     */
-    void attachOpenflowMessageListener(OpenflowMessageListenerFacade openflowMessageListenerFacade);
-
-    /**
-     * Method returns registered {@link org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade}
-     *
-     * @return
-     */
-    OpenflowMessageListenerFacade getOpenflowMessageListenerFacade();
-
     /**
      * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
      *
@@ -180,6 +155,11 @@ public interface DeviceContext extends AutoCloseable,
     DeviceMeterRegistry getDeviceMeterRegistry();
 
 
+    /**
+     * @return translator library
+     */
+    TranslatorLibrary oook();
+
     /**
      * store cancellable timeout handler of currently running barrier task
      */
@@ -195,20 +175,43 @@ public interface DeviceContext extends AutoCloseable,
      *
      * @param notificationService
      */
-    void setNotificationService(NotificationProviderService notificationService);
+    void setNotificationService(NotificationService notificationService);
 
-    MessageSpy getMessageSpy();
+    void setNotificationPublishService(NotificationPublishService notificationPublishService);
 
-    void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler);
+    MessageSpy getMessageSpy();
 
     /**
      * Method sets reference to handler used for cleanup after device context about to be closed.
      */
     void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
 
-    void startGatheringOperationsToOneTransaction();
+    MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
+
+    Long getReservedXid();
+
+    /**
+     * indicates that device context is fully published (e.g.: packetIn messages should be passed)
+     */
+    void onPublished();
+
+    /**
+     * change packetIn rate limiter borders
+     *
+     * @param upperBound max amount of outstanding packetIns
+     */
+    void updatePacketInRateLimit(long upperBound);
+
+    /**
+     * @return registry point for item life cycle sources of device
+     */
+    ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
+
+    void setRpcContext(RpcContext rpcContext);
 
-    void commitOperationsGatheredInOneTransaction();
+    RpcContext getRpcContext();
 
+    @Override
+    void close();
 }