Jonathan Hart | 23701d1 | 2014-04-03 10:45:48 -0700 | [diff] [blame] | 1 | package net.onrc.onos.core.util; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 2 | |
| 3 | import org.codehaus.jackson.annotate.JsonProperty; |
| 4 | |
| 5 | /** |
| 6 | * The class representing the Flow Path flags. |
| 7 | */ |
| 8 | public class FlowPathFlags { |
| 9 | private long flags; |
| 10 | |
| 11 | // Discard the first-hop Flow Entry |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 12 | public static final long DISCARD_FIRST_HOP_ENTRY = (1 << 0); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 13 | |
| 14 | // Keep only the first-hop Flow Entry |
pingping-lin | ba5c52f | 2014-02-11 16:52:01 -0800 | [diff] [blame] | 15 | public static final long KEEP_ONLY_FIRST_HOP_ENTRY = (1 << 1); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 16 | |
| 17 | /** |
| 18 | * Default constructor. |
| 19 | */ |
| 20 | public FlowPathFlags() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 21 | this.flags = 0; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 22 | } |
| 23 | |
| 24 | /** |
| 25 | * Constructor for given flags. |
| 26 | * |
| 27 | * @param flags the flags value to set. |
| 28 | */ |
| 29 | public FlowPathFlags(long flags) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 30 | this.flags = flags; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 31 | } |
| 32 | |
| 33 | /** |
| 34 | * Constructor for given flags as a string. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 35 | * <p/> |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 36 | * The string value should contain the name of each flags to set. E.g.: |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 37 | * "DISCARD_FIRST_HOP_ENTRY,KEEP_ONLY_FIRST_HOP_ENTRY" |
| 38 | * |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 39 | * @param flagsStr the string value of the flags to set. |
| 40 | */ |
| 41 | public FlowPathFlags(String flagsStr) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 42 | this.setFlagsStr(flagsStr); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Get the flags. |
| 47 | * |
| 48 | * @return the flags. |
| 49 | */ |
| 50 | @JsonProperty("flags") |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 51 | public long flags() { |
| 52 | return flags; |
| 53 | } |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 54 | |
| 55 | /** |
| 56 | * Set the flags. |
| 57 | * |
| 58 | * @param flags the flags value to set. |
| 59 | */ |
| 60 | @JsonProperty("flags") |
| 61 | public void setFlags(long flags) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 62 | this.flags = flags; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Set the flags as a string. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 67 | * <p/> |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 68 | * The string value should contain the name of each flags to set. E.g.: |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 69 | * "DISCARD_FIRST_HOP_ENTRY,KEEP_ONLY_FIRST_HOP_ENTRY" |
| 70 | * |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 71 | * @param flagsStr the string value of the flags to set. |
| 72 | */ |
| 73 | @JsonProperty("flagsStr") |
| 74 | public void setFlagsStr(String flagsStr) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 75 | this.flags = 0L; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 76 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 77 | // Test all flags |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 78 | if (flagsStr.contains("DISCARD_FIRST_HOP_ENTRY")) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 79 | this.flags |= DISCARD_FIRST_HOP_ENTRY; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 80 | } |
| 81 | if (flagsStr.contains("KEEP_ONLY_FIRST_HOP_ENTRY")) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 82 | this.flags |= KEEP_ONLY_FIRST_HOP_ENTRY; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 83 | } |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Test whether the DISCARD_FIRST_HOP_ENTRY flag is set. |
| 88 | * |
| 89 | * @return true if the DISCARD_FIRST_HOP_ENTRY flag is set, |
| 90 | * otherwise false. |
| 91 | */ |
| 92 | public boolean isDiscardFirstHopEntry() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 93 | return ((flags & DISCARD_FIRST_HOP_ENTRY) != 0); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Test whether the KEEP_ONLY_FIRST_HOP_ENTRY flag is set. |
| 98 | * |
| 99 | * @return true if the KEEP_ONLY_FIRST_HOP_ENTRY flag is set, |
| 100 | * otherwise false. |
| 101 | */ |
| 102 | public boolean isKeepOnlyFirstHopEntry() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 103 | return ((flags & KEEP_ONLY_FIRST_HOP_ENTRY) != 0); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Convert the Flow Path Flags to a string. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 108 | * <p/> |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 109 | * The string has the following form: |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 110 | * [flags=DISCARD_FIRST_HOP_ENTRY,KEEP_ONLY_FIRST_HOP_ENTRY] |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 111 | * |
| 112 | * @return the Flow Path flags as a string. |
| 113 | */ |
Pavlin Radoslavov | 426d516 | 2013-12-11 12:46:58 -0800 | [diff] [blame] | 114 | @Override |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 115 | public String toString() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 116 | String flagsStr = null; |
| 117 | String ret = "[flags="; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 118 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 119 | // Test all flags |
| 120 | if ((this.flags & DISCARD_FIRST_HOP_ENTRY) != 0) { |
| 121 | flagsStr += "DISCARD_FIRST_HOP_ENTRY"; |
| 122 | } |
| 123 | if ((this.flags & KEEP_ONLY_FIRST_HOP_ENTRY) != 0) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 124 | if (flagsStr != null) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 125 | flagsStr += ","; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 126 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 127 | flagsStr += "KEEP_ONLY_FIRST_HOP_ENTRY"; |
| 128 | } |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 129 | if (flagsStr != null) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 130 | ret += flagsStr; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 131 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 132 | ret += "]"; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 133 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 134 | return ret; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 135 | } |
pingping-lin | ba5c52f | 2014-02-11 16:52:01 -0800 | [diff] [blame] | 136 | |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 137 | } |