Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 1 | package net.onrc.onos.core.topology; |
| 2 | |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 3 | import static com.google.common.base.Preconditions.checkNotNull; |
| 4 | |
| 5 | import java.io.Serializable; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 6 | import java.nio.ByteBuffer; |
| 7 | import java.nio.charset.StandardCharsets; |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 8 | import java.util.Comparator; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 9 | import java.util.Objects; |
| 10 | |
| 11 | import net.floodlightcontroller.core.IFloodlightProviderService.Role; |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 12 | import net.onrc.onos.core.topology.web.serializers.MastershipDataSerializer; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 13 | import net.onrc.onos.core.util.Dpid; |
Pavlin Radoslavov | 53b208a | 2014-07-28 13:16:11 -0700 | [diff] [blame] | 14 | import net.onrc.onos.core.util.OnosInstanceId; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 15 | |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 16 | import org.codehaus.jackson.map.annotate.JsonSerialize; |
| 17 | |
| 18 | /** |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 19 | * Self-contained Switch Mastership object. |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 20 | */ |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 21 | @JsonSerialize(using = MastershipDataSerializer.class) |
| 22 | public class MastershipData extends TopologyElement<MastershipData> { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 23 | private final Dpid dpid; |
Pavlin Radoslavov | 53b208a | 2014-07-28 13:16:11 -0700 | [diff] [blame] | 24 | private final OnosInstanceId onosInstanceId; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 25 | private final Role role; |
| 26 | |
| 27 | /** |
| 28 | * Default constructor for Serializer to use. |
| 29 | */ |
| 30 | @Deprecated |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 31 | protected MastershipData() { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 32 | dpid = null; |
| 33 | onosInstanceId = null; |
| 34 | role = Role.SLAVE; // Default role is SLAVE |
| 35 | } |
| 36 | |
| 37 | /** |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 38 | * Constructor for given switch DPID, ONOS Instance ID, and ONOS instance |
| 39 | * role for the switch. |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 40 | * |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 41 | * @param dpid the switch DPID |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 42 | * @param onosInstanceId the ONOS Instance ID |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 43 | * @param role the ONOS instance role for the switch |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 44 | */ |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 45 | public MastershipData(Dpid dpid, OnosInstanceId onosInstanceId, |
Pavlin Radoslavov | 53b208a | 2014-07-28 13:16:11 -0700 | [diff] [blame] | 46 | Role role) { |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 47 | this.dpid = checkNotNull(dpid); |
| 48 | this.onosInstanceId = checkNotNull(onosInstanceId); |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 49 | this.role = role; |
| 50 | } |
| 51 | |
| 52 | /** |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 53 | * Copy constructor. |
| 54 | * <p> |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 55 | * Creates an unfrozen copy of the given Switch MastershipData object. |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 56 | * |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 57 | * @param original the object to make copy of |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 58 | */ |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 59 | public MastershipData(MastershipData original) { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 60 | super(original); |
| 61 | this.dpid = original.dpid; |
| 62 | this.onosInstanceId = original.onosInstanceId; |
| 63 | this.role = original.role; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Gets the Switch DPID. |
| 68 | * |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 69 | * @return the Switch DPID |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 70 | */ |
| 71 | public Dpid getDpid() { |
| 72 | return dpid; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Gets the ONOS Instance ID. |
| 77 | * |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 78 | * @return the ONOS Instance ID |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 79 | */ |
Pavlin Radoslavov | 53b208a | 2014-07-28 13:16:11 -0700 | [diff] [blame] | 80 | public OnosInstanceId getOnosInstanceId() { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 81 | return onosInstanceId; |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Gets the ONOS Controller Role for the Switch. |
| 86 | * |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 87 | * @return the ONOS Controller Role for the Switch |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 88 | */ |
| 89 | public Role getRole() { |
| 90 | return role; |
| 91 | } |
| 92 | |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 93 | @Override |
Pavlin Radoslavov | d7b792e | 2014-08-01 02:47:47 -0700 | [diff] [blame] | 94 | public Dpid getOriginDpid() { |
| 95 | return this.dpid; |
| 96 | } |
| 97 | |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 98 | @Override |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 99 | public ByteBuffer getIDasByteBuffer() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 100 | String keyStr = "M" + getDpid() + "@" + getOnosInstanceId(); |
| 101 | byte[] id = keyStr.getBytes(StandardCharsets.UTF_8); |
| 102 | ByteBuffer buf = ByteBuffer.wrap(id); |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 103 | return buf; |
| 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public int hashCode() { |
| 108 | return Objects.hash(dpid, onosInstanceId); |
| 109 | } |
| 110 | |
| 111 | /** |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 112 | * Compares two MastershipData objects. |
| 113 | * MastershipData objects are equal if they have same DPID and same |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 114 | * ONOS Instance ID. |
| 115 | * |
Pavlin Radoslavov | 5317ac9 | 2014-08-18 12:59:33 -0700 | [diff] [blame] | 116 | * @param o another object to compare to this |
| 117 | * @return true if equal, false otherwise |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 118 | */ |
| 119 | @Override |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 120 | public boolean equals(Object o) { |
| 121 | if (this == o) { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 122 | return true; |
| 123 | } |
| 124 | |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 125 | if (o == null || getClass() != o.getClass()) { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 126 | return false; |
| 127 | } |
| 128 | |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 129 | // Compare attributes |
| 130 | if (!super.equals(o)) { |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 131 | return false; |
| 132 | } |
| 133 | |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 134 | MastershipData other = (MastershipData) o; |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 135 | return Objects.equals(dpid, other.dpid) && |
| 136 | Objects.equals(onosInstanceId, other.onosInstanceId); |
| 137 | } |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 138 | |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 139 | /** |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 140 | * Comparator to bring {@link MastershipData} with MASTER role up front. |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 141 | * <p> |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 142 | * Note: expected to be used against Collection of MastershipData |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 143 | * about same Dpid. |
| 144 | */ |
| 145 | public static final class MasterFirstComparator |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 146 | implements Comparator<MastershipData>, Serializable { |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 147 | @Override |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 148 | public int compare(MastershipData o1, MastershipData o2) { |
| 149 | // MastershipData for same ONOS Instance |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 150 | // => treat as equal regardless of Role |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 151 | // Note: MastershipData#equals() does not use Role |
Yuta HIGUCHI | a5c48bc | 2014-08-27 10:34:15 -0700 | [diff] [blame] | 152 | if (o1.equals(o2)) { |
| 153 | return 0; |
| 154 | } |
| 155 | |
| 156 | // MASTER Role instance is considered smaller. |
| 157 | // (appears earlier in SortedSet iteration, etc.) |
| 158 | if (o1.getRole() == Role.MASTER) { |
| 159 | return -1; |
| 160 | } |
| 161 | if (o2.getRole() == Role.MASTER) { |
| 162 | return 1; |
| 163 | } |
| 164 | |
| 165 | return o1.getOnosInstanceId().toString() |
| 166 | .compareTo(o2.getOnosInstanceId().toString()); |
| 167 | } |
| 168 | } |
| 169 | |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 170 | @Override |
| 171 | public String toString() { |
Yuta HIGUCHI | d8fd2f5 | 2014-09-01 23:19:45 -0700 | [diff] [blame] | 172 | return "[MastershipData " + getDpid() + "@" + getOnosInstanceId() + |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 173 | "->" + getRole() + "]"; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 174 | } |
| 175 | } |