blob: ff0bbe11442bb959298bdd8e4cc8839c63a765f2 [file] [log] [blame]
Thomas Vachuska83e090e2014-10-22 14:25:35 -07001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2014-present Open Networking Foundation
Thomas Vachuska83e090e2014-10-22 14:25:35 -07003 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07004 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
Thomas Vachuska83e090e2014-10-22 14:25:35 -07007 *
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07008 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
Thomas Vachuska83e090e2014-10-22 14:25:35 -070015 */
Brian O'Connorabafb502014-12-02 22:26:20 -080016package org.onosproject.net.flow;
tombe988312014-09-19 18:38:47 -070017
Srikanth Vavilapalli95810f52015-09-14 15:49:56 -070018import java.util.List;
19
Brian O'Connorabafb502014-12-02 22:26:20 -080020import org.onosproject.net.DeviceId;
Ray Milkey7bf273c2017-09-27 16:15:15 -070021import org.onosproject.net.flow.oldbatch.FlowRuleBatchEvent;
22import org.onosproject.net.flow.oldbatch.FlowRuleBatchOperation;
Brian O'Connorabafb502014-12-02 22:26:20 -080023import org.onosproject.store.Store;
tombe988312014-09-19 18:38:47 -070024
25/**
tome4729872014-09-23 00:37:37 -070026 * Manages inventory of flow rules; not intended for direct use.
tombe988312014-09-19 18:38:47 -070027 */
Madan Jampani117aaae2014-10-23 10:04:05 -070028public interface FlowRuleStore extends Store<FlowRuleBatchEvent, FlowRuleStoreDelegate> {
tombe988312014-09-19 18:38:47 -070029
30 /**
tom9b4030d2014-10-06 10:39:03 -070031 * Returns the number of flow rule in the store.
32 *
33 * @return number of flow rules
34 */
35 int getFlowRuleCount();
36
37 /**
alshabiba68eb962014-09-24 20:34:13 -070038 * Returns the stored flow.
tom9b4030d2014-10-06 10:39:03 -070039 *
alshabiba68eb962014-09-24 20:34:13 -070040 * @param rule the rule to look for
41 * @return a flow rule
42 */
alshabib1c319ff2014-10-04 20:29:09 -070043 FlowEntry getFlowEntry(FlowRule rule);
alshabiba68eb962014-09-24 20:34:13 -070044
45 /**
tombe988312014-09-19 18:38:47 -070046 * Returns the flow entries associated with a device.
47 *
48 * @param deviceId the device ID
49 * @return the flow entries
50 */
alshabib1c319ff2014-10-04 20:29:09 -070051 Iterable<FlowEntry> getFlowEntries(DeviceId deviceId);
tombe988312014-09-19 18:38:47 -070052
53 /**
Thomas Vachuska4b420772014-10-30 16:46:17 -070054 * // TODO: Better description of method behavior.
alshabib219ebaa2014-09-22 15:41:24 -070055 * Stores a new flow rule without generating events.
tombe988312014-09-19 18:38:47 -070056 *
57 * @param rule the flow rule to add
Sho SHIMIZUbe63b232015-06-30 10:57:58 -070058 * @deprecated in Cardinal Release
tombe988312014-09-19 18:38:47 -070059 */
Brian O'Connor72cb19a2015-01-16 16:14:41 -080060 @Deprecated
Madan Jampani117aaae2014-10-23 10:04:05 -070061 void storeFlowRule(FlowRule rule);
62
63 /**
64 * Stores a batch of flow rules.
Thomas Vachuska4b420772014-10-30 16:46:17 -070065 *
Madan Jampani117aaae2014-10-23 10:04:05 -070066 * @param batchOperation batch of flow rules.
Yuta HIGUCHI885868f2014-11-13 19:12:07 -080067 * A batch can contain flow rules for a single device only.
Brian O'Connor72cb19a2015-01-16 16:14:41 -080068 *
Madan Jampani117aaae2014-10-23 10:04:05 -070069 */
Brian O'Connor72cb19a2015-01-16 16:14:41 -080070 void storeBatch(FlowRuleBatchOperation batchOperation);
Madan Jampani117aaae2014-10-23 10:04:05 -070071
72 /**
73 * Invoked on the completion of a storeBatch operation.
Thomas Vachuska4b420772014-10-30 16:46:17 -070074 *
75 * @param event flow rule batch event
Madan Jampani117aaae2014-10-23 10:04:05 -070076 */
77 void batchOperationComplete(FlowRuleBatchEvent event);
alshabib219ebaa2014-09-22 15:41:24 -070078
79 /**
alshabib1c319ff2014-10-04 20:29:09 -070080 * Marks a flow rule for deletion. Actual deletion will occur
81 * when the provider indicates that the flow has been removed.
alshabib219ebaa2014-09-22 15:41:24 -070082 *
83 * @param rule the flow rule to delete
84 */
Madan Jampani117aaae2014-10-23 10:04:05 -070085 void deleteFlowRule(FlowRule rule);
tombe988312014-09-19 18:38:47 -070086
87 /**
88 * Stores a new flow rule, or updates an existing entry.
89 *
90 * @param rule the flow rule to add or update
91 * @return flow_added event, or null if just an update
92 */
alshabib1c319ff2014-10-04 20:29:09 -070093 FlowRuleEvent addOrUpdateFlowRule(FlowEntry rule);
tombe988312014-09-19 18:38:47 -070094
95 /**
alshabib1c319ff2014-10-04 20:29:09 -070096 * @param rule the flow entry to remove
tombe988312014-09-19 18:38:47 -070097 * @return flow_removed event, or null if nothing removed
98 */
alshabib1c319ff2014-10-04 20:29:09 -070099 FlowRuleEvent removeFlowRule(FlowEntry rule);
Srikanth Vavilapalli95810f52015-09-14 15:49:56 -0700100
101 /**
Charles Chan93fa7272016-01-26 22:27:02 -0800102 * Marks a flow rule as PENDING_ADD during retry.
103 *
104 * Emits flow_update event if the state is changed
105 *
106 * @param rule the flow rule that is retrying
107 * @return flow_updated event, or null if nothing updated
108 */
109 FlowRuleEvent pendingFlowRule(FlowEntry rule);
110
111 /**
Charles Chan0c7c43b2016-01-14 17:39:20 -0800112 * Removes all flow entries of given device from store.
113 *
114 * @param deviceId device id
115 */
Victor Silva139bca42016-08-18 11:46:35 -0300116 default void purgeFlowRule(DeviceId deviceId) {}
117
118 /**
119 * Removes all flow entries from store.
120 */
121 void purgeFlowRules();
Charles Chan0c7c43b2016-01-14 17:39:20 -0800122
123 /**
Srikanth Vavilapalli95810f52015-09-14 15:49:56 -0700124 * Updates the flow table statistics of the specified device using
125 * the given statistics.
126 *
127 * @param deviceId device identifier
128 * @param tableStats list of table statistics
129 * @return ready to send event describing what occurred;
130 */
131 FlowRuleEvent updateTableStatistics(DeviceId deviceId,
132 List<TableStatisticsEntry> tableStats);
133
134 /**
135 * Returns the flow table statistics associated with a device.
136 *
137 * @param deviceId the device ID
138 * @return the flow table statistics
139 */
140 Iterable<TableStatisticsEntry> getTableStatistics(DeviceId deviceId);
Patryk Konopka7e40c012017-06-06 13:38:06 +0200141
142 /**
143 * Returns number of flow rules in ADDED state for specified device.
144 *
145 * @param deviceId the device ID
146 * @return number of flow rules in ADDED state
147 */
148 long getActiveFlowRuleCount(DeviceId deviceId);
tombe988312014-09-19 18:38:47 -0700149}