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.tuple.ImmutablePair;
17 import org.apache.commons.lang3.tuple.Pair;
20 * Class that represents the TCP segment objects
22 public class TCP extends Packet {
24 public static final String SRCPORT = "SourcePort";
25 public static final String DESTPORT = "DestinationPort";
26 public static final String SEQNUMBER = "SequenceNumber";
27 public static final String ACKNUMBER = "AcknowledgementNumber";
28 public static final String DATAOFFSET = "DataOffset";
29 public static final String RESERVED = "Reserved";
30 public static final String HEADERLENFLAGS = "HeaderLenFlags";
31 public static final String WINDOWSIZE = "WindowSize";
32 public static final String CHECKSUM = "Checksum";
33 public static final String URGENTPOINTER = "UrgentPointer";
35 private static Map<String, Pair<Integer, Integer>> fieldCoordinates = new LinkedHashMap<String, Pair<Integer, Integer>>() {
36 private static final long serialVersionUID = 1L;
38 put(SRCPORT, new ImmutablePair<Integer, Integer>(0, 16));
39 put(DESTPORT, new ImmutablePair<Integer, Integer>(16, 16));
40 put(SEQNUMBER, new ImmutablePair<Integer, Integer>(32, 32));
41 put(ACKNUMBER, new ImmutablePair<Integer, Integer>(64, 32));
42 put(DATAOFFSET, new ImmutablePair<Integer, Integer>(96, 4));
43 put(RESERVED, new ImmutablePair<Integer, Integer>(100, 3));
44 put(HEADERLENFLAGS, new ImmutablePair<Integer, Integer>(103, 9));
45 put(WINDOWSIZE, new ImmutablePair<Integer, Integer>(112, 16));
46 put(CHECKSUM, new ImmutablePair<Integer, Integer>(128, 16));
47 put(URGENTPOINTER, new ImmutablePair<Integer, Integer>(144, 16));
51 private final Map<String, byte[]> fieldValues;
54 * Default constructor that sets all the header fields to zero
58 fieldValues = new HashMap<String, byte[]>();
59 hdrFieldCoordMap = fieldCoordinates;
60 hdrFieldsMap = fieldValues;
61 /* Setting all remaining header field values to
62 * default value of 0. These maybe changed as needed
64 setSourcePort((short) 0);
65 setDestinationPort((short) 0);
68 setDataOffset((byte) 0);
69 setReserved((byte) 0);
70 setWindowSize((short) 0);
71 setUrgentPointer((short) 0);
72 setChecksum((short) 0);
76 * Constructor that sets the access level for the packet and
77 * sets all the header fields to zero.
79 public TCP(boolean writeAccess) {
81 fieldValues = new HashMap<String, byte[]>();
82 hdrFieldCoordMap = fieldCoordinates;
83 hdrFieldsMap = fieldValues;
84 /* Setting all remaining header field values to
85 * default value of 0. These maybe changed as needed
87 setSourcePort((short) 0);
88 setDestinationPort((short) 0);
91 setDataOffset((byte) 0);
92 setReserved((byte) 0);
93 setWindowSize((short) 0);
94 setUrgentPointer((short) 0);
95 setChecksum((short) 0);
100 * Stores the value read from data stream
102 public void setHeaderField(String headerField, byte[] readValue) {
103 hdrFieldsMap.put(headerField, readValue);
107 * Sets the TCP source port for the current TCP object instance
108 * @param short tcpSourcePort
111 public TCP setSourcePort(short tcpSourcePort) {
112 byte[] sourcePort = BitBufferHelper.toByteArray(tcpSourcePort);
113 fieldValues.put(SRCPORT, sourcePort);
118 * Sets the TCP destination port for the current TCP object instance
119 * @param short tcpDestinationPort
122 public TCP setDestinationPort(short tcpDestinationPort) {
123 byte[] destinationPort = BitBufferHelper
124 .toByteArray(tcpDestinationPort);
125 fieldValues.put(DESTPORT, destinationPort);
130 * Sets the TCP sequence number for the current TCP object instance
131 * @param int tcpSequenceNumber
134 public TCP setSequenceNumber(int tcpSequenceNumber) {
135 byte[] sequenceNumber = BitBufferHelper.toByteArray(tcpSequenceNumber);
136 fieldValues.put(SEQNUMBER, sequenceNumber);
141 * Sets the TCP data offset for the current TCP object instance
142 * @param byte tcpDataOffset
145 public TCP setDataOffset(byte tcpDataOffset) {
146 byte[] offset = BitBufferHelper.toByteArray(tcpDataOffset);
147 fieldValues.put("DataOffset", offset);
152 * Sets the TCP reserved bits for the current TCP object instance
153 * @param byte tcpReserved
156 public TCP setReserved(byte tcpReserved) {
157 byte[] reserved = BitBufferHelper.toByteArray(tcpReserved);
158 fieldValues.put("Reserved", reserved);
163 * Sets the TCP Ack number for the current TCP object instance
164 * @param int tcpAckNumber
167 public TCP setAckNumber(int tcpAckNumber) {
168 byte[] ackNumber = BitBufferHelper.toByteArray(tcpAckNumber);
169 fieldValues.put(ACKNUMBER, ackNumber);
174 * Sets the TCP flags for the current TCP object instance
175 * @param short tcpFlags
178 public TCP setHeaderLenFlags(short tcpFlags) {
179 byte[] headerLenFlags = BitBufferHelper.toByteArray(tcpFlags);
180 fieldValues.put(HEADERLENFLAGS, headerLenFlags);
185 * Sets the TCP window size for the current TCP object instance
186 * @param short tcpWsize
189 public TCP setWindowSize(short tcpWsize) {
190 byte[] wsize = BitBufferHelper.toByteArray(tcpWsize);
191 fieldValues.put(WINDOWSIZE, wsize);
196 * Sets the TCP checksum for the current TCP object instance
197 * @param short tcpChecksum
200 public TCP setChecksum(short tcpChecksum) {
201 byte[] checksum = BitBufferHelper.toByteArray(tcpChecksum);
202 fieldValues.put(CHECKSUM, checksum);
207 * Sets the TCP Urgent Pointer for the current TCP object instance
208 * @param short tcpUrgentPointer
211 public TCP setUrgentPointer(short tcpUrgentPointer) {
212 byte[] urgentPointer = BitBufferHelper.toByteArray(tcpUrgentPointer);
213 fieldValues.put(URGENTPOINTER, urgentPointer);
218 * Gets the stored source port value of TCP header
219 * @return the sourcePort
221 public short getSourcePort() {
222 return (BitBufferHelper.getShort(fieldValues.get(SRCPORT)));
226 * Gets the stored destination port value of TCP header
227 * @return the destinationPort
229 public short getDestinationPort() {
230 return (BitBufferHelper.getShort(fieldValues.get(DESTPORT)));