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;
12 import java.util.HashMap;
13 import java.util.LinkedHashMap;
16 import org.apache.commons.lang3.builder.EqualsBuilder;
17 import org.apache.commons.lang3.builder.HashCodeBuilder;
18 import org.apache.commons.lang3.tuple.ImmutablePair;
19 import org.apache.commons.lang3.tuple.Pair;
20 import org.opendaylight.controller.sal.utils.EtherTypes;
23 * Class that represents the Ethernet frame objects
27 public class Ethernet extends Packet {
28 private static final String DMAC = "DestinationMACAddress";
29 private static final String SMAC = "SourceMACAddress";
30 private static final String ETHT = "EtherType";
32 // TODO: This has to be outside and it should be possible for osgi
33 // to add new coming packet classes
34 public static final Map<Short, Class<? extends Packet>> etherTypeClassMap;
36 etherTypeClassMap = new HashMap<Short, Class<? extends Packet>>();
37 etherTypeClassMap.put(EtherTypes.ARP.shortValue(), ARP.class);
38 etherTypeClassMap.put(EtherTypes.IPv4.shortValue(), IPv4.class);
39 etherTypeClassMap.put(EtherTypes.LLDP.shortValue(), LLDP.class);
41 private static Map<String, Pair<Integer, Integer>> fieldCoordinates = new LinkedHashMap<String, Pair<Integer, Integer>>() {
42 private static final long serialVersionUID = 1L;
44 put(DMAC, new ImmutablePair<Integer, Integer>(0, 48));
45 put(SMAC, new ImmutablePair<Integer, Integer>(48, 48));
46 put(ETHT, new ImmutablePair<Integer, Integer>(96, 16));
49 private Map<String, byte[]> fieldValues;
52 * Default constructor that creates and sets the HashMap
56 fieldValues = new HashMap<String, byte[]>();
57 hdrFieldCoordMap = fieldCoordinates;
58 hdrFieldsMap = fieldValues;
62 * Constructor that sets the access level for the packet and
63 * creates and sets the HashMap
65 public Ethernet(boolean writeAccess) {
67 fieldValues = new HashMap<String, byte[]>();
68 hdrFieldCoordMap = fieldCoordinates;
69 hdrFieldsMap = fieldValues;
73 public void setHeaderField(String headerField, byte[] readValue) {
74 if (headerField.equals(ETHT)) {
75 payloadClass = etherTypeClassMap.get(BitBufferHelper
76 .getShort(readValue));
78 hdrFieldsMap.put(headerField, readValue);
82 * Gets the destination MAC address stored
83 * @return byte[] - the destinationMACAddress
85 public byte[] getDestinationMACAddress() {
86 return fieldValues.get(DMAC);
90 * Gets the source MAC address stored
91 * @return byte[] - the sourceMACAddress
93 public byte[] getSourceMACAddress() {
94 return fieldValues.get(SMAC);
98 * Gets the etherType stored
99 * @return short - the etherType
101 public short getEtherType() {
102 return BitBufferHelper.getShort(fieldValues.get(ETHT));
106 * Sets the destination MAC address for the current Ethernet object instance
107 * @param byte[] - the destinationMACAddress to set
109 public Ethernet setDestinationMACAddress(byte[] destinationMACAddress) {
110 fieldValues.put(DMAC, destinationMACAddress);
115 * Sets the source MAC address for the current Ethernet object instance
116 * @param byte[] - the sourceMACAddress to set
118 public Ethernet setSourceMACAddress(byte[] sourceMACAddress) {
119 fieldValues.put(SMAC, sourceMACAddress);
124 * Sets the etherType for the current Ethernet object instance
125 * @param short - the etherType to set
127 public Ethernet setEtherType(short etherType) {
128 byte[] ethType = BitBufferHelper.toByteArray(etherType);
129 fieldValues.put(ETHT, ethType);
134 public int hashCode() {
135 return HashCodeBuilder.reflectionHashCode(this);
139 public boolean equals(Object obj) {
140 return EqualsBuilder.reflectionEquals(this, obj);