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 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.ReadTransaction;
+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.MultiMsgCollector;
-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.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;
*/
public interface DeviceContext extends AutoCloseable,
OpenFlowPluginTimer,
- MessageHandler,
- TranslatorLibrarian,
- OutstandingMessageExtractor,
DeviceReplyProcessor,
- DeviceDisconnectedHandler {
+ DeviceDisconnectedHandler,
+ PortNumberCache {
/**
*/
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.
*/
*/
<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();
/**
*/
ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
-
- /**
- * @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 exposes flow registry used for storing flow ids identified by calculated flow hash.
*
DeviceMeterRegistry getDeviceMeterRegistry();
+ /**
+ * @return translator library
+ */
+ TranslatorLibrary oook();
+
/**
* store cancellable timeout handler of currently running barrier task
*/
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);
- void startGatheringOperationsToOneTransaction();
+ MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
- void commitOperationsGatheredInOneTransaction();
+ Long getReservedXid();
- public MultiMsgCollector getMultiMsgCollector();
+ /**
+ * indicates that device context is fully published (e.g.: packetIn messages should be passed)
+ */
+ void onPublished();
- Long getReservedXid();
+ /**
+ * 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();
}