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