Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.flow.instructions; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 17 | |
| 18 | /** |
| 19 | * Abstraction of a single traffic treatment step. |
| 20 | */ |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 21 | public interface Instruction { |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Represents the type of traffic treatment. |
| 25 | */ |
| 26 | public enum Type { |
| 27 | /** |
| 28 | * Signifies that the traffic should be dropped. |
| 29 | */ |
| 30 | DROP, |
| 31 | |
| 32 | /** |
| 33 | * Signifies that the traffic should be output to a port. |
| 34 | */ |
| 35 | OUTPUT, |
| 36 | |
| 37 | /** |
| 38 | * Signifies that.... (do we need this?) |
| 39 | */ |
| 40 | GROUP, |
| 41 | |
| 42 | /** |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 43 | * Signifies that the traffic should be modified in L0 way. |
| 44 | */ |
| 45 | L0MODIFICATION, |
| 46 | |
| 47 | /** |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame] | 48 | * Signifies that the traffic should be modified in L2 way. |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 49 | */ |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame] | 50 | L2MODIFICATION, |
| 51 | |
| 52 | /** |
| 53 | * Signifies that the traffic should be modified in L3 way. |
| 54 | */ |
| 55 | L3MODIFICATION |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | // TODO: Create factory class 'Instructions' that will have various factory |
| 59 | // to create specific instructions. |
| 60 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 61 | /** |
alshabib | 89e43ef | 2014-09-16 10:36:34 -0700 | [diff] [blame] | 62 | * Returns the type of instruction. |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 63 | * @return type of instruction |
| 64 | */ |
| 65 | public Type type(); |
| 66 | |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 67 | } |