diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/net/flow/FlowRuleProvider.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/flow/FlowRuleProvider.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/flow/FlowRuleProvider.java | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/flow/FlowRuleProvider.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/flow/FlowRuleProvider.java new file mode 100644 index 00000000..ac2895eb --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/flow/FlowRuleProvider.java @@ -0,0 +1,58 @@ +/* + * Copyright 2014-2015 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.net.flow; + +import org.onosproject.core.ApplicationId; +import org.onosproject.net.provider.Provider; + +/** + * Abstraction of a flow rule provider. + */ +public interface FlowRuleProvider extends Provider { + + /** + * Instructs the provider to apply the specified flow rules to their + * respective devices. + * @param flowRules one or more flow rules + * throws SomeKindOfException that indicates which ones were applied and + * which ones failed + */ + void applyFlowRule(FlowRule... flowRules); + + /** + * Instructs the provider to remove the specified flow rules to their + * respective devices. + * @param flowRules one or more flow rules + * throws SomeKindOfException that indicates which ones were applied and + * which ones failed + */ + void removeFlowRule(FlowRule... flowRules); + + /** + * Removes rules by their id. + * @param id the id to remove + * @param flowRules one or more flow rules + */ + void removeRulesById(ApplicationId id, FlowRule... flowRules); + + /** + * Installs a batch of flow rules. Each flowrule is associated to an + * operation which results in either addition, removal or modification. + * @param batch a batch of flow rules + */ + void executeBatch(FlowRuleBatchOperation batch); + +} |