Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 1 | package org.onlab.onos.sdnip.config; |
| 2 | |
| 3 | import java.util.List; |
| 4 | import java.util.Objects; |
| 5 | |
| 6 | import org.codehaus.jackson.annotate.JsonCreator; |
| 7 | import org.codehaus.jackson.annotate.JsonProperty; |
| 8 | import org.onlab.onos.net.ConnectPoint; |
| 9 | import org.onlab.onos.net.DeviceId; |
| 10 | import org.onlab.onos.net.PortNumber; |
| 11 | import org.onlab.packet.MacAddress; |
| 12 | |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 13 | import com.google.common.base.MoreObjects; |
| 14 | |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 15 | /** |
| 16 | * Represents a BGP daemon in SDN network. |
| 17 | * <p/> |
| 18 | * Each BGP speaker has a attachment point, which includes a switch DPID and a |
| 19 | * switch port. Each BGP speaker has one MAC address and several IP addresses, |
| 20 | * which are used to peer with BGP peers outside the SDN network. For each |
| 21 | * peer outside the SDN network, we configure a different IP address to BGP |
| 22 | * speaker inside the SDN network. |
| 23 | * <p/> |
| 24 | * Each BGP speaker has a name, which is a unique identifying String that is |
| 25 | * used to reference this speaker in the configuration. |
| 26 | */ |
| 27 | public class BgpSpeaker { |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 28 | private final String name; |
| 29 | private final ConnectPoint connectPoint; |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 30 | private final MacAddress macAddress; |
| 31 | private List<InterfaceAddress> interfaceAddresses; |
| 32 | |
| 33 | /** |
| 34 | * Class constructor used by the JSON library to create an object. |
| 35 | * |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 36 | * @param name the name of the BGP speaker inside SDN network |
| 37 | * @param attachmentDpid the DPID where the BGP speaker is attached to |
| 38 | * @param attachmentPort the port where the BGP speaker is attached to |
| 39 | * @param macAddress the MAC address of the BGP speaker |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 40 | */ |
| 41 | @JsonCreator |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 42 | public BgpSpeaker(@JsonProperty("name") String name, |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 43 | @JsonProperty("attachmentDpid") String attachmentDpid, |
| 44 | @JsonProperty("attachmentPort") int attachmentPort, |
| 45 | @JsonProperty("macAddress") String macAddress) { |
| 46 | |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 47 | this.name = name; |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 48 | this.macAddress = MacAddress.valueOf(macAddress); |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 49 | this.connectPoint = new ConnectPoint( |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 50 | DeviceId.deviceId(SdnIpConfigReader.dpidToUri(attachmentDpid)), |
| 51 | PortNumber.portNumber(attachmentPort)); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Sets the addresses we configured for the BGP speaker on all virtual |
| 56 | * {@link Interface}s. |
| 57 | * |
| 58 | * @param interfaceAddresses a list of IP addresses of the BGP speaker |
| 59 | * configured on all virtual interfaces |
| 60 | */ |
| 61 | @JsonProperty("interfaceAddresses") |
| 62 | public void setInterfaceAddresses( |
| 63 | List<InterfaceAddress> interfaceAddresses) { |
| 64 | this.interfaceAddresses = interfaceAddresses; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Gets the BGP speaker name. |
| 69 | * |
| 70 | * @return the BGP speaker name |
| 71 | */ |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 72 | public String name() { |
| 73 | return name; |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 74 | } |
| 75 | |
| 76 | /** |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 77 | * Gets the connect point where the BGP speaker is attached. |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 78 | * |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 79 | * @return the connect point |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 80 | */ |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 81 | public ConnectPoint connectPoint() { |
| 82 | return connectPoint; |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Gets the MAC address of the BGP speaker. |
| 87 | * |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 88 | * @return the MAC address |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 89 | */ |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 90 | public MacAddress macAddress() { |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 91 | return macAddress; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Gets all IP addresses configured on all {@link Interface}s of the |
| 96 | * BGP speaker. |
| 97 | * |
| 98 | * @return a list of IP addresses of the BGP speaker configured on all |
| 99 | * virtual interfaces |
| 100 | */ |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 101 | public List<InterfaceAddress> interfaceAddresses() { |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 102 | return interfaceAddresses; |
| 103 | } |
| 104 | |
| 105 | @Override |
| 106 | public boolean equals(Object other) { |
| 107 | if (!(other instanceof BgpSpeaker)) { |
| 108 | return false; |
| 109 | } |
| 110 | |
| 111 | BgpSpeaker otherBgpSpeaker = (BgpSpeaker) other; |
| 112 | |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 113 | return name.equals(otherBgpSpeaker.name) && |
| 114 | connectPoint.equals( |
| 115 | otherBgpSpeaker.connectPoint) && |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 116 | macAddress.equals(otherBgpSpeaker.macAddress) && |
| 117 | interfaceAddresses.equals(otherBgpSpeaker.interfaceAddresses); |
| 118 | } |
| 119 | |
| 120 | @Override |
| 121 | public int hashCode() { |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 122 | return Objects.hash(name, connectPoint, macAddress, |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 123 | interfaceAddresses); |
| 124 | |
| 125 | } |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 126 | |
| 127 | @Override |
| 128 | public String toString() { |
| 129 | return MoreObjects.toStringHelper(getClass()) |
| 130 | .add("speakerName", name) |
| 131 | .add("connectPoint", connectPoint) |
| 132 | .add("macAddress", macAddress) |
| 133 | .add("interfaceAddresses", interfaceAddresses) |
| 134 | .toString(); |
| 135 | } |
Jonathan Hart | bac07a0 | 2014-10-13 21:29:54 -0700 | [diff] [blame] | 136 | } |