Thomas Vachuska | c4ee737 | 2016-02-02 16:10:09 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Thomas Vachuska | c4ee737 | 2016-02-02 16:10:09 -0800 | [diff] [blame] | 3 | * |
| 4 | * 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 |
| 7 | * |
| 8 | * 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. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.net.flow; |
| 18 | |
| 19 | import org.onosproject.net.driver.HandlerBehaviour; |
| 20 | |
| 21 | import java.util.Collection; |
| 22 | |
| 23 | /** |
| 24 | * Flow rule programmable device behaviour. |
| 25 | */ |
| 26 | public interface FlowRuleProgrammable extends HandlerBehaviour { |
| 27 | |
| 28 | /** |
| 29 | * Retrieves the collection of flow rule entries currently installed on the device. |
| 30 | * |
| 31 | * @return collection of flow rules |
| 32 | */ |
| 33 | Collection<FlowEntry> getFlowEntries(); |
| 34 | |
| 35 | /** |
| 36 | * Applies the specified collection of flow rules to the device. |
| 37 | * |
| 38 | * @param rules flow rules to be added |
| 39 | * @return collection of flow rules that were added successfully |
| 40 | */ |
| 41 | Collection<FlowRule> applyFlowRules(Collection<FlowRule> rules); |
| 42 | |
| 43 | /** |
| 44 | * Removes the specified collection of flow rules from the device. |
| 45 | * |
| 46 | * @param rules flow rules to be removed |
| 47 | * @return collection of flow rules that were removed successfully |
| 48 | */ |
| 49 | Collection<FlowRule> removeFlowRules(Collection<FlowRule> rules); |
| 50 | |
| 51 | } |