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.opendaylight.controller.sal.core.ConstructionException;
21 import org.opendaylight.controller.sal.utils.HexEncode;
24 @XmlAccessorType(XmlAccessType.NONE)
25 public class EthernetAddress extends DataLinkAddress {
26 private static final long serialVersionUID = 1L;
28 private byte[] macAddress;
30 public static final EthernetAddress BROADCASTMAC = createWellKnownAddress(new byte[] {
31 (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff,
34 public static final EthernetAddress INVALIDHOST = BROADCASTMAC;
36 public static final String addressName = "Ethernet MAC Address";
37 public static final int SIZE = 6;
39 private static final EthernetAddress createWellKnownAddress(byte[] mac) {
41 return new EthernetAddress(mac);
42 } catch (ConstructionException ce) {
47 /* Private constructor to satisfy JAXB */
48 @SuppressWarnings("unused")
49 private EthernetAddress() {
53 * Public constructor for an Ethernet MAC address starting from
54 * the byte constituing the address, the constructor validate the
55 * size of the arrive to make sure it met the expected size
57 * @param macAddress A byte array in big endian format
58 * representing the Ethernet MAC Address
60 * @return The constructed object if valid
62 public EthernetAddress(byte[] macAddress) throws ConstructionException {
65 if (macAddress == null) {
66 throw new ConstructionException("Null input parameter passed");
69 if (macAddress.length != SIZE) {
70 throw new ConstructionException(
71 "Wrong size of passed byte array, expected:" + SIZE
72 + " got:" + macAddress.length);
74 this.macAddress = new byte[SIZE];
75 System.arraycopy(macAddress, 0, this.macAddress, 0, SIZE);
78 public EthernetAddress clone() {
80 return new EthernetAddress(this.macAddress.clone());
81 } catch (ConstructionException ce) {
87 * Return the Ethernet Mac address in byte array format
89 * @return The Ethernet Mac address in byte array format
91 public byte[] getValue() {
92 return this.macAddress;
96 public int hashCode() {
98 int result = super.hashCode();
99 result = prime * result + Arrays.hashCode(macAddress);
104 public boolean equals(Object obj) {
107 if (!super.equals(obj))
109 if (getClass() != obj.getClass())
111 EthernetAddress other = (EthernetAddress) obj;
112 if (!Arrays.equals(macAddress, other.macAddress))
118 public String toString() {
119 return "EthernetAddress [macAddress=" + HexEncode.bytesToHexStringFormat(macAddress)
123 @XmlElement(name = "macAddress")
124 public String getMacAddress() {
125 return HexEncode.bytesToHexStringFormat(macAddress);