getCapabilities method is not needed - removed

[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 8301c075a8425448be91dec53f2dbbe0c70cb7ec..956569b21fb14d77ed83916e1bd88db8a780f3f2 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
@@ -8,26 +8,30 @@
 
 package org.opendaylight.openflowplugin.api.openflow.device;
 
-import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
-
 import io.netty.util.Timeout;
 import java.math.BigInteger;
-import java.util.Map;
 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
 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.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.statistics.ofpspecific.MessageSpy;
 import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
 /**
+ * <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
@@ -40,10 +44,16 @@ 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/>
+ * </p>
  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  */
-public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, TranslatorLibrarian, OutstandingMessageExtractor, DeviceReplyProcessor {
+public interface DeviceContext extends AutoCloseable,
+        OpenflowPluginTimer,
+        MessageHandler,
+        TranslatorLibrarian,
+        OutstandingMessageExtractor,
+        DeviceReplyProcessor,
+        DeviceDisconnectedHandler {
 
 
     /**
@@ -87,13 +97,6 @@ public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, Tran
     ReadTransaction getReadTransaction();
 
 
-    /**
-     * Method provides capabilities of connected device.
-     *
-     * @return
-     */
-    TableFeatures getCapabilities();
-
     /**
      * Method provides current devices connection context.
      *
@@ -110,24 +113,38 @@ public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, Tran
 
     /**
      * Method generates unique XID value.
+     *
      * @return
      */
     Xid getNextXid();
 
     /**
-     * @return readonly map of outstanding requests
+     * @param xid key
+     * @return request by xid
      */
-    Map<Long, RequestContext> getRequests();
+    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 {@link org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava}
+     * 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.
      *
@@ -137,16 +154,33 @@ public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, Tran
 
     /**
      * 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.
+     *
      * @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();
+
+
     /**
      * store cancellable timeout handler of currently running barrier task
      */
@@ -159,9 +193,19 @@ public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, Tran
 
     /**
      * Sets notification service
+     *
      * @param notificationService
      */
     void setNotificationService(NotificationProviderService notificationService);
 
+    MessageSpy getMessageSpy();
+
+    void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler);
+
+    /**
+     * Method sets reference to handler used for cleanup after device context about to be closed.
+     */
+    void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
+
 }