Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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.openflow.controller; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
| 20 | import org.onosproject.net.driver.HandlerBehaviour; |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 21 | import org.onosproject.net.flow.instructions.ExtensionTreatment; |
| 22 | import org.onosproject.net.flow.instructions.ExtensionTreatmentType; |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 23 | import org.projectfloodlight.openflow.protocol.OFFactory; |
| 24 | import org.projectfloodlight.openflow.protocol.action.OFAction; |
| 25 | |
| 26 | /** |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 27 | * Interprets extension treatments and converts them to/from OpenFlow objects. |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 28 | */ |
| 29 | @Beta |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 30 | public interface ExtensionTreatmentInterpreter extends HandlerBehaviour { |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 31 | |
| 32 | /** |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 33 | * Returns true if the given extension treatment is supported by this |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 34 | * driver. |
| 35 | * |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 36 | * @param extensionTreatmentType extension treatment type |
| 37 | * @return true if the extension is supported, otherwise false |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 38 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 39 | boolean supported(ExtensionTreatmentType extensionTreatmentType); |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 40 | |
| 41 | /** |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 42 | * Maps an extension treatment to an OpenFlow action. |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 43 | * |
| 44 | * @param factory OpenFlow factory |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 45 | * @param extensionTreatment extension treatment |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 46 | * @return OpenFlow action |
| 47 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 48 | OFAction mapInstruction(OFFactory factory, ExtensionTreatment extensionTreatment); |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 49 | |
| 50 | /** |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 51 | * Maps an OpenFlow action to an extension treatment. |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 52 | * |
| 53 | * @param action OpenFlow action |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 54 | * @return extension treatment |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 55 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 56 | ExtensionTreatment mapAction(OFAction action); |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 57 | |
| 58 | } |