import io.netty.util.Timeout;
import java.math.BigInteger;
import java.util.List;
-import javax.annotation.CheckForNull;
-import javax.annotation.Nullable;
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.OFPContext;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
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.StatisticsContext;
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>
- * Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
*/
-public interface DeviceContext extends AutoCloseable,
- OpenFlowPluginTimer,
+public interface DeviceContext extends
+ OFPContext,
+ AutoCloseable,
DeviceReplyProcessor,
- PortNumberCache {
-
- /**
- * distinguished device context states
- */
- enum DEVICE_CONTEXT_STATE {
- /**
- * initial phase of talking to switch
- */
- INITIALIZATION,
- /**
- * standard phase - interacting with switch
- */
- WORKING,
- /**
- * termination phase of talking to switch
- */
- TERMINATION
- }
-
- /**
- * Method returns current device context state.
- *
- * @return {@link DeviceContext.DEVICE_CONTEXT_STATE}
- */
- DEVICE_CONTEXT_STATE getDeviceContextState();
+ TxFacade,
+ DeviceRegistry{
/**
* Method close all auxiliary connections and primary connection.
/**
* Method add auxiliary connection contexts to this context representing single device connection.
- *
- * @param connectionContext
+ * @param connectionContext new connection context
*/
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 removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
*/
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 oldRole - old role for quick validation for needed processing
- * @param role - NewRole expect to be {@link OfpRole#BECOMESLAVE} or {@link OfpRole#BECOMEMASTER}
- */
- @Deprecated
- ListenableFuture<Void> onClusterRoleChange(@Nullable OfpRole oldRole, @CheckForNull OfpRole role);
-
- /**
- * Method has to activate TransactionChainManager and prepare all Contexts from Device Contects suite
- * to Taking ClusterLeadership role {@link OfpRole#BECOMEMASTER} (e.g. Routed RPC registration, StatPolling ...)
- * @return DeviceInitialization furure
- */
- ListenableFuture<Void> onDeviceTakeClusterLeadership();
-
- /**
- * Method has to deactivate TransactionChainManager and prepare all Contexts from Device Contects suite
- * to Lost ClusterLeadership role {@link OfpRole#BECOMESLAVE} (e.g. Stop RPC rounting, stop StatPolling ...)
- * @return RoleChangeTxChainManager future for deactivation
- */
- ListenableFuture<Void> onDeviceLostClusterLeadership();
-
- /**
- * 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 submits Transaction to DataStore.
- * @return transaction is submitted successfully
- */
- boolean submitTransaction();
-
/**
* Method has to close TxManager ASAP we are notified about Closed Connection
* @return sync. future for Slave and MD-SAL completition for Master
ListenableFuture<Void> shuttingDownDataStoreTransactions();
/**
- * 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.
- *
- * @return
+ * @return current devices connection context
*/
ConnectionContext getPrimaryConnectionContext();
/**
- * Method provides current devices auxiliary connection contexts.
- *
- * @return
- */
- ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
-
- /**
- * 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
+ * @return current devices auxiliary connection contexts
*/
- DeviceMeterRegistry getDeviceMeterRegistry();
+ ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
/**
*/
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(DeviceTerminationPhaseHandler deviceContextClosedHandler);
-
MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
- /**
- * Method is reserved unique XID for Device Message.
- * Attention: OFJava expect the message, otherwise OutboundQueue could stop working.
- * @return Reserved XID
- */
- Long reservedXidForDeviceMessage();
-
/**
* indicates that device context is fully published (e.g.: packetIn messages should be passed)
*/
*/
ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
- void setRpcContext(RpcContext rpcContext);
+ @Override
+ void close();
- RpcContext getRpcContext();
+ void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
- void setStatisticsContext(StatisticsContext statisticsContext);
+ void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
- StatisticsContext getStatisticsContext();
+ void replaceConnectionContext(ConnectionContext connectionContext);
- @Override
- void close();
+ boolean isSkipTableFeatures();
}