alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.flow.instructions; |
| 2 | |
| 3 | import org.onlab.packet.MACAddress; |
alshabib | 7b79549 | 2014-09-16 14:38:39 -0700 | [diff] [blame] | 4 | import org.onlab.packet.VLANID; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 5 | |
| 6 | /** |
| 7 | * Abstraction of a single traffic treatment step. |
| 8 | * @param <T> the type parameter for the instruction |
| 9 | */ |
| 10 | public abstract class L2ModificationInstruction implements Instruction { |
| 11 | |
| 12 | /** |
| 13 | * Represents the type of traffic treatment. |
| 14 | */ |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 15 | public enum L2SubType { |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 16 | /** |
| 17 | * Ether src modification. |
| 18 | */ |
| 19 | L2_SRC, |
| 20 | |
| 21 | /** |
| 22 | * Ether dst modification. |
| 23 | */ |
| 24 | L2_DST, |
| 25 | |
| 26 | /** |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 27 | * VLAN id modification. |
| 28 | */ |
| 29 | VLAN_ID, |
| 30 | |
| 31 | /** |
| 32 | * VLAN priority modification. |
| 33 | */ |
| 34 | VLAN_PCP |
| 35 | } |
| 36 | |
| 37 | // TODO: Create factory class 'Instructions' that will have various factory |
| 38 | // to create specific instructions. |
| 39 | |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 40 | public abstract L2SubType subtype(); |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 41 | |
| 42 | @Override |
| 43 | public Type type() { |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 44 | return Type.L2MODIFICATION; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Represents a L2 src/dst modification instruction. |
| 49 | */ |
| 50 | public static final class ModEtherInstruction extends L2ModificationInstruction { |
| 51 | |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 52 | private final L2SubType subtype; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 53 | private final MACAddress mac; |
| 54 | |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 55 | public ModEtherInstruction(L2SubType subType, MACAddress addr) { |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 56 | this.subtype = subType; |
| 57 | this.mac = addr; |
| 58 | } |
| 59 | |
| 60 | @Override |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 61 | public L2SubType subtype() { |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 62 | return this.subtype; |
| 63 | } |
| 64 | |
| 65 | public MACAddress mac() { |
| 66 | return this.mac; |
| 67 | } |
| 68 | |
| 69 | } |
| 70 | |
| 71 | /** |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 72 | * Represents a VLAN id modification instruction. |
| 73 | */ |
| 74 | public static final class ModVlanIdInstruction extends L2ModificationInstruction { |
| 75 | |
alshabib | 7b79549 | 2014-09-16 14:38:39 -0700 | [diff] [blame] | 76 | public final VLANID vlanId; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 77 | |
alshabib | 7b79549 | 2014-09-16 14:38:39 -0700 | [diff] [blame] | 78 | public ModVlanIdInstruction(VLANID vlanId) { |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 79 | this.vlanId = vlanId; |
| 80 | } |
| 81 | |
| 82 | @Override |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 83 | public L2SubType subtype() { |
alshabib | 7410fea | 2014-09-16 13:48:39 -0700 | [diff] [blame] | 84 | return L2SubType.VLAN_ID; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 85 | } |
| 86 | |
alshabib | 7b79549 | 2014-09-16 14:38:39 -0700 | [diff] [blame] | 87 | public VLANID vlanId() { |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 88 | return this.vlanId; |
| 89 | } |
| 90 | |
| 91 | } |
| 92 | |
alshabib | 7410fea | 2014-09-16 13:48:39 -0700 | [diff] [blame] | 93 | /** |
| 94 | * Represents a VLAN PCP modification instruction. |
| 95 | */ |
| 96 | public static final class ModVlanPcpInstruction extends L2ModificationInstruction { |
| 97 | |
| 98 | public final Byte vlanPcp; |
| 99 | |
| 100 | public ModVlanPcpInstruction(Byte vlanPcp) { |
| 101 | this.vlanPcp = vlanPcp; |
| 102 | } |
| 103 | |
| 104 | @Override |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame^] | 105 | public L2SubType subtype() { |
alshabib | 7410fea | 2014-09-16 13:48:39 -0700 | [diff] [blame] | 106 | return L2SubType.VLAN_PCP; |
| 107 | } |
| 108 | |
| 109 | public Byte vlanPcp() { |
| 110 | return this.vlanPcp; |
| 111 | } |
| 112 | |
| 113 | } |
| 114 | |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 115 | |
| 116 | } |