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 |
| 78 | if (flagsStr.contains("DISCARD_FIRST_HOP_ENTRY")) |
| 79 | this.flags |= DISCARD_FIRST_HOP_ENTRY; |
| 80 | if (flagsStr.contains("KEEP_ONLY_FIRST_HOP_ENTRY")) |
| 81 | this.flags |= KEEP_ONLY_FIRST_HOP_ENTRY; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Test whether the DISCARD_FIRST_HOP_ENTRY flag is set. |
| 86 | * |
| 87 | * @return true if the DISCARD_FIRST_HOP_ENTRY flag is set, |
| 88 | * otherwise false. |
| 89 | */ |
| 90 | public boolean isDiscardFirstHopEntry() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 91 | return ((flags & DISCARD_FIRST_HOP_ENTRY) != 0); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Test whether the KEEP_ONLY_FIRST_HOP_ENTRY flag is set. |
| 96 | * |
| 97 | * @return true if the KEEP_ONLY_FIRST_HOP_ENTRY flag is set, |
| 98 | * otherwise false. |
| 99 | */ |
| 100 | public boolean isKeepOnlyFirstHopEntry() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 101 | return ((flags & KEEP_ONLY_FIRST_HOP_ENTRY) != 0); |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Convert the Flow Path Flags to a string. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 106 | * <p/> |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 107 | * The string has the following form: |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 108 | * [flags=DISCARD_FIRST_HOP_ENTRY,KEEP_ONLY_FIRST_HOP_ENTRY] |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 109 | * |
| 110 | * @return the Flow Path flags as a string. |
| 111 | */ |
Pavlin Radoslavov | 426d516 | 2013-12-11 12:46:58 -0800 | [diff] [blame] | 112 | @Override |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 113 | public String toString() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 114 | String flagsStr = null; |
| 115 | String ret = "[flags="; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 116 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 117 | // Test all flags |
| 118 | if ((this.flags & DISCARD_FIRST_HOP_ENTRY) != 0) { |
| 119 | flagsStr += "DISCARD_FIRST_HOP_ENTRY"; |
| 120 | } |
| 121 | if ((this.flags & KEEP_ONLY_FIRST_HOP_ENTRY) != 0) { |
| 122 | if (flagsStr != null) |
| 123 | flagsStr += ","; |
| 124 | flagsStr += "KEEP_ONLY_FIRST_HOP_ENTRY"; |
| 125 | } |
| 126 | if (flagsStr != null) |
| 127 | ret += flagsStr; |
| 128 | ret += "]"; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 129 | |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame^] | 130 | return ret; |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 131 | } |
pingping-lin | ba5c52f | 2014-02-11 16:52:01 -0800 | [diff] [blame] | 132 | |
Pavlin Radoslavov | 204b286 | 2013-07-12 14:15:36 -0700 | [diff] [blame] | 133 | } |