import io.netty.util.Timeout;
import java.math.BigInteger;
-import java.util.Map;
+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.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.flow.registry.FlowRegistry;
-import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
+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.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
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
* 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 <mbobak@cisco.com> on 25.2.2015.
*/
-public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, TranslatorLibrarian, OutstandingMessageExtractor, DeviceReplyProcessor {
+public interface DeviceContext extends AutoCloseable,
+ OpenFlowPluginTimer,
+ MessageHandler,
+ DeviceReplyProcessor,
+ DeviceDisconnectedHandler {
/**
*/
<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.
ReadTransaction getReadTransaction();
- /**
- * Method provides capabilities of connected device.
- *
- * @return
- */
- TableFeatures getCapabilities();
-
/**
* Method provides current devices connection context.
*
ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
/**
- * Method generates unique XID value.
+ * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
+ *
* @return
*/
- Xid getNextXid();
+ DeviceFlowRegistry getDeviceFlowRegistry();
/**
- * @return readonly map of outstanding requests
- */
- Map<Long, RequestContext> getRequests();
-
- /**
- * Method writes request context into request context map. This method
- * is ment to be used by {@link org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava}
+ * Method exposes device group registry used for storing group ids.
*
- * @param xid
- * @param requestFutureContext
+ * @return
*/
- void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
+ DeviceGroupRegistry getDeviceGroupRegistry();
/**
- * Method that attaches anyMessageTypeListener to connection adapters as message listener.
+ * Method exposes device meter registry used for storing meter ids.
*
- * @param openflowMessageListenerFacade
- */
- void attachOpenflowMessageListener(OpenflowMessageListenerFacade openflowMessageListenerFacade);
-
- /**
- * Method returns registered {@link org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade}
* @return
*/
- OpenflowMessageListenerFacade getOpenflowMessageListenerFacade();
+ DeviceMeterRegistry getDeviceMeterRegistry();
+
/**
- * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
- * @return
+ * @return translator library
*/
- FlowRegistry getFlowRegistry();
+ TranslatorLibrary oook();
/**
* store cancellable timeout handler of currently running barrier task
* @return cancellable timeout handle of currently running barrier task
*/
Timeout getBarrierTaskTimeout();
+
+ /**
+ * Sets notification service
+ *
+ * @param notificationService
+ */
+ void setNotificationService(NotificationService notificationService);
+
+ void setNotificationPublishService(NotificationPublishService notificationPublishService);
+
+ 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);
+
+ 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();
+
}