3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
10 package org.opendaylight.controller.sal.packet.address;
12 import java.util.Arrays;
14 import javax.xml.bind.annotation.XmlAccessType;
15 import javax.xml.bind.annotation.XmlAccessorType;
16 import javax.xml.bind.annotation.XmlElement;
17 import javax.xml.bind.annotation.XmlRootElement;
18 import javax.xml.bind.annotation.XmlTransient;
20 import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
21 import org.opendaylight.controller.sal.core.ConstructionException;
22 import org.opendaylight.controller.sal.utils.HexEncode;
25 @XmlAccessorType(XmlAccessType.NONE)
26 public class EthernetAddress extends DataLinkAddress {
27 private static final long serialVersionUID = 1L;
29 private byte[] macAddress;
31 public static final EthernetAddress BROADCASTMAC = createWellKnownAddress(new byte[] {
32 (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff,
35 public static final EthernetAddress INVALIDHOST = BROADCASTMAC;
37 public static final String addressName = "Ethernet MAC Address";
38 public static final int SIZE = 6;
40 private static final EthernetAddress createWellKnownAddress(byte[] mac) {
42 return new EthernetAddress(mac);
43 } catch (ConstructionException ce) {
48 /* Private constructor to satisfy JAXB */
49 private EthernetAddress() {
54 * Public constructor for an Ethernet MAC address starting from
55 * the byte constituing the address, the constructor validate the
56 * size of the arrive to make sure it met the expected size
58 * @param macAddress A byte array in big endian format
59 * representing the Ethernet MAC Address
61 * @return The constructed object if valid
63 public EthernetAddress(byte[] macAddress) throws ConstructionException {
66 if (macAddress == null) {
67 throw new ConstructionException("Null input parameter passed");
70 if (macAddress.length != SIZE) {
71 throw new ConstructionException(
72 "Wrong size of passed byte array, expected:" + SIZE
73 + " got:" + macAddress.length);
75 this.macAddress = new byte[SIZE];
76 System.arraycopy(macAddress, 0, this.macAddress, 0, SIZE);
79 public EthernetAddress clone() {
81 return new EthernetAddress(this.macAddress.clone());
82 } catch (ConstructionException ce) {
88 * Return the Ethernet Mac address in byte array format
90 * @return The Ethernet Mac address in byte array format
92 public byte[] getValue() {
93 return this.macAddress;
97 public int hashCode() {
99 int result = super.hashCode();
100 result = prime * result + Arrays.hashCode(macAddress);
105 public boolean equals(Object obj) {
108 if (!super.equals(obj))
110 if (getClass() != obj.getClass())
112 EthernetAddress other = (EthernetAddress) obj;
113 if (!Arrays.equals(macAddress, other.macAddress))
119 public String toString() {
120 return "EthernetAddress[" + ReflectionToStringBuilder.toString(this)
124 @XmlElement(name = "macAddress")
125 public String getMacAddress() {
126 return HexEncode.bytesToHexStringFormat(macAddress);