| package net.onrc.onos.datagrid; |
| |
| import java.util.Collection; |
| |
| import net.floodlightcontroller.core.module.IFloodlightService; |
| import net.onrc.onos.intent.Intent; |
| import net.onrc.onos.ofcontroller.flowmanager.IFlowEventHandlerService; |
| import net.onrc.onos.ofcontroller.proxyarp.ArpReplyNotification; |
| import net.onrc.onos.ofcontroller.proxyarp.IArpReplyEventHandler; |
| import net.onrc.onos.ofcontroller.proxyarp.IPacketOutEventHandler; |
| import net.onrc.onos.ofcontroller.proxyarp.PacketOutNotification; |
| import net.onrc.onos.ofcontroller.topology.TopologyElement; |
| import net.onrc.onos.ofcontroller.util.Dpid; |
| import net.onrc.onos.ofcontroller.util.FlowEntry; |
| import net.onrc.onos.ofcontroller.util.FlowEntryId; |
| import net.onrc.onos.ofcontroller.util.FlowId; |
| import net.onrc.onos.ofcontroller.util.FlowPath; |
| import net.onrc.onos.ofcontroller.util.Pair; |
| |
| /** |
| * Interface for providing Datagrid Service to other modules. |
| */ |
| public interface IDatagridService extends IFloodlightService { |
| /** |
| * Create an event channel. |
| * |
| * If the channel already exists, just return it. |
| * NOTE: The channel is started automatically. |
| * |
| * @param channelName the event channel name. |
| * @param typeK the type of the Key in the Key-Value store. |
| * @param typeV the type of the Value in the Key-Value store. |
| * @return the event channel for the channel name. |
| */ |
| <K, V> IEventChannel<K, V> createChannel(String channelName, |
| Class<K> typeK, Class<V> typeV); |
| |
| /** |
| * Add event channel listener. |
| * |
| * NOTE: The channel is started automatically right after the listener |
| * is added. |
| * |
| * @param channelName the event channel name. |
| * @param listener the listener to add. |
| * @param typeK the type of the Key in the Key-Value store. |
| * @param typeV the type of the Value in the Key-Value store. |
| * @return the event channel for the channel name. |
| */ |
| <K, V> IEventChannel<K, V> addListener(String channelName, |
| IEventChannelListener<K, V> listener, |
| Class<K> typeK, Class<V> typeV); |
| |
| /** |
| * Remove event channel listener. |
| * |
| * @param channelName the event channel name. |
| * @param listener the listener to remove. |
| */ |
| <K, V> void removeListener(String channelName, |
| IEventChannelListener<K, V> listener); |
| |
| /* |
| * register all the intents as one batch |
| */ |
| void registerIntent(Collection<Intent> intents); |
| /** |
| * Register Flow Event Handler Service for receiving Flow-related |
| * notifications. |
| * |
| * NOTE: Only a single Flow Event Handler Service can be registered. |
| * |
| * @param flowEventHandlerService the Flow Event Handler Service to register. |
| */ |
| void registerFlowEventHandlerService(IFlowEventHandlerService flowEventHandlerService); |
| |
| /** |
| * De-register Flow Event Handler Service for receiving Flow-related |
| * notifications. |
| * |
| * NOTE: Only a single Flow Event Handler Service can be registered. |
| * |
| * @param flowEventHandlerService the Flow Event Handler Service to |
| * de-register. |
| */ |
| void deregisterFlowEventHandlerService(IFlowEventHandlerService flowEventHandlerService); |
| |
| /** |
| * Register event handler for packet-out events. |
| * |
| * @param packetOutEventHandler The packet-out event handler to register. |
| */ |
| public void registerPacketOutEventHandler(IPacketOutEventHandler packetOutEventHandler); |
| |
| /** |
| * Deregister event handler service for packet-out events. |
| * |
| * @param packetOutEventHandler The packet-out event handler to deregister. |
| */ |
| public void deregisterPacketOutEventHandler(IPacketOutEventHandler packetOutEventHandler); |
| |
| /** |
| * Register event handler for ARP reply events. |
| * |
| * @param packetOutEventHandler The ARP reply event handler to register. |
| */ |
| public void registerArpReplyEventHandler(IArpReplyEventHandler arpReplyEventHandler); |
| |
| /** |
| * Deregister event handler service for ARP reply events. |
| * |
| * @param packetOutEventHandler The ARP reply event handler to deregister. |
| */ |
| public void deregisterArpReplyEventHandler(IArpReplyEventHandler arpReplyEventHandler); |
| |
| /** |
| * Get all Flows that are currently in the datagrid. |
| * |
| * @return all Flows that are currently in the datagrid. |
| */ |
| Collection<FlowPath> getAllFlows(); |
| |
| /** |
| * Get a Flow for a given Flow ID. |
| * |
| * @param flowId the Flow ID of the Flow to get. |
| * @return the Flow if found, otherwise null. |
| */ |
| FlowPath getFlow(FlowId flowId); |
| |
| /** |
| * Send a notification that a Flow is added. |
| * |
| * @param flowPath the Flow that is added. |
| */ |
| void notificationSendFlowAdded(FlowPath flowPath); |
| |
| /** |
| * Send a notification that a Flow is removed. |
| * |
| * @param flowId the Flow ID of the Flow that is removed. |
| */ |
| void notificationSendFlowRemoved(FlowId flowId); |
| |
| /** |
| * Send a notification that a Flow is updated. |
| * |
| * @param flowPath the Flow that is updated. |
| */ |
| void notificationSendFlowUpdated(FlowPath flowPath); |
| |
| /** |
| * Send a notification that all Flows are removed. |
| */ |
| void notificationSendAllFlowsRemoved(); |
| |
| /** |
| * Get all Flow Entries that are currently in the datagrid. |
| * |
| * @return all Flow Entries that are currently in the datagrid. |
| */ |
| Collection<FlowEntry> getAllFlowEntries(); |
| |
| /** |
| * Get a Flow Entry for a given Flow Entry ID. |
| * |
| * @param flowEntryId the Flow Entry ID of the Flow Entry to get. |
| * @return the Flow Entry if found, otherwise null. |
| */ |
| FlowEntry getFlowEntry(FlowEntryId flowEntryId); |
| |
| /** |
| * Send a notification that a FlowEntry is added. |
| * |
| * @param flowEntry the FlowEntry that is added. |
| */ |
| void notificationSendFlowEntryAdded(FlowEntry flowEntry); |
| |
| /** |
| * Send a notification that a FlowEntry is removed. |
| * |
| * @param flowEntryId the FlowEntry ID of the FlowEntry that is removed. |
| */ |
| void notificationSendFlowEntryRemoved(FlowEntryId flowEntryId); |
| |
| /** |
| * Send a notification that a FlowEntry is updated. |
| * |
| * @param flowEntry the FlowEntry that is updated. |
| */ |
| void notificationSendFlowEntryUpdated(FlowEntry flowEntry); |
| |
| /** |
| * Send a notification that all Flow Entries are removed. |
| */ |
| void notificationSendAllFlowEntriesRemoved(); |
| |
| /** |
| * Get all Flow IDs that are currently in the datagrid. |
| * |
| * @return all Flow IDs that ae currently in the datagrid. |
| */ |
| Collection<Pair<FlowId, Dpid>> getAllFlowIds(); |
| |
| /** |
| * Send a notification that a FlowId is added. |
| * |
| * @param flowId the FlowId that is added. |
| * @param dpid the Source Switch Dpid. |
| */ |
| void notificationSendFlowIdAdded(FlowId flowId, Dpid dpid); |
| |
| /** |
| * Send a notification that a FlowId is removed. |
| * |
| * @param flowId the FlowId that is removed. |
| */ |
| void notificationSendFlowIdRemoved(FlowId flowId); |
| |
| /** |
| * Send a notification that a FlowId is updated. |
| * |
| * @param flowId the FlowId that is updated. |
| * @param dpid the Source Switch Dpid. |
| */ |
| void notificationSendFlowIdUpdated(FlowId flowId, Dpid dpid); |
| |
| /** |
| * Send a notification that all Flow IDs are removed. |
| */ |
| void notificationSendAllFlowIdsRemoved(); |
| |
| /** |
| * Get all Flow Entry IDs that are currently in the datagrid. |
| * |
| * @return all Flow Entry IDs that ae currently in the datagrid. |
| */ |
| Collection<Pair<FlowEntryId, Dpid>> getAllFlowEntryIds(); |
| |
| /** |
| * Send a notification that a FlowEntryId is added. |
| * |
| * @param flowEntryId the FlowEntryId that is added. |
| * @param dpid the Switch Dpid. |
| */ |
| void notificationSendFlowEntryIdAdded(FlowEntryId flowEntryId, Dpid dpid); |
| |
| /** |
| * Send a notification that a FlowEntryId is removed. |
| * |
| * @param flowEntryId the FlowEntryId that is removed. |
| */ |
| void notificationSendFlowEntryIdRemoved(FlowEntryId flowEntryId); |
| |
| /** |
| * Send a notification that a FlowEntryId is updated. |
| * |
| * @param flowEntryId the FlowEntryId that is updated. |
| * @param dpid the Switch Dpid. |
| */ |
| void notificationSendFlowEntryIdUpdated(FlowEntryId flowEntryId, |
| Dpid dpid); |
| |
| /** |
| * Send a notification that all Flow Entry IDs are removed. |
| */ |
| void notificationSendAllFlowEntryIdsRemoved(); |
| |
| /** |
| * Get all Topology Elements that are currently in the datagrid. |
| * |
| * @return all Topology Elements that are currently in the datagrid. |
| */ |
| Collection<TopologyElement> getAllTopologyElements(); |
| |
| /** |
| * Send a notification that a Topology Element is added. |
| * |
| * @param topologyElement the Topology Element that is added. |
| */ |
| void notificationSendTopologyElementAdded(TopologyElement topologyElement); |
| |
| /** |
| * Send a notification that a Topology Element is removed. |
| * |
| * @param topologyElement the Topology Element that is removed. |
| */ |
| void notificationSendTopologyElementRemoved(TopologyElement topologyElement); |
| |
| /** |
| * Send a notification that a Topology Element is updated. |
| * |
| * @param topologyElement the Topology Element that is updated. |
| */ |
| void notificationSendTopologyElementUpdated(TopologyElement topologyElement); |
| |
| /** |
| * Send a notification that all Topology Elements are removed. |
| */ |
| void notificationSendAllTopologyElementsRemoved(); |
| |
| /** |
| * Send a packet-out notification to other ONOS instances. This informs |
| * other instances that they should send this packet out some of the ports |
| * they control. Not all notifications are applicable to all instances |
| * (i.e. some notifications specify a single port to send the packet out), |
| * so each instance must determine whether it needs to take action when it |
| * receives the notification. |
| * |
| * @param packetOutNotification The packet notification to send |
| */ |
| public void sendPacketOutNotification(PacketOutNotification packetOutNotification); |
| |
| /** |
| * Send notification to other ONOS instances that an ARP reply has been |
| * received. |
| * @param arpReply The notification of the ARP reply |
| */ |
| public void sendArpReplyNotification(ArpReplyNotification arpReply); |
| } |