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.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.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.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.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;
/**
+ * <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 MessageHandler, TranslatorLibrarian, OutstandingMessageExtractor, DeviceReplyProcessor {
+public interface DeviceContext extends AutoCloseable,
+ OpenFlowPluginTimer,
+ DeviceReplyProcessor,
+ DeviceDisconnectedHandler,
+ PortNumberCache {
/**
DeviceState getDeviceState();
/**
- * Method exposes possibility for write a child of {@link DataObject} to transaction for DataStore.
+ * 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.
*/
<T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
/**
- * Method exposes transaction created for device
- * represented by this context. This should be used as read only.
- * This read only transaction has a fresh dataStore snapshot and
- * here is a possibility to get different data set from DataStore
- * as have a write transaction in this context.
+ * Method creates delete operation for provided path in underlying transaction chain.
*/
- ReadTransaction getReadTransaction();
+ <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
/**
- * Method provides capabilities of connected device.
- *
- * @return
+ * Method submits Transaction to DataStore.
+ * @return transaction is submitted successfully
*/
- TableFeatures getCapabilities();
+ 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
+ */
+ ReadOnlyTransaction getReadTransaction();
+
/**
* Method provides current devices connection context.
*/
ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
- Xid getNextXid();
+ /**
+ * 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 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 meter registry used for storing meter ids.
*
- * @param xid
- * @param requestFutureContext
+ * @return
*/
- public void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
+ DeviceMeterRegistry getDeviceMeterRegistry();
+
+
+ /**
+ * @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();
+
+ /**
+ * Sets notification service
+ *
+ * @param notificationService
+ */
+ void setNotificationService(NotificationService notificationService);
+
+ void setNotificationPublishService(NotificationPublishService notificationPublishService);
+
+ MessageSpy getMessageSpy();
+
+ /**
+ * 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();
+
+ /**
+ * 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);
+
+ RpcContext getRpcContext();
+ @Override
+ void close();
}
Code Review / openflowplugin.git / blobdiff