org.onlab.packet.ipv6

Class EncapSecurityPayload

java.lang.Object

org.onlab.packet.BasePacket

org.onlab.packet.ipv6.EncapSecurityPayload

All Implemented Interfaces:

IPacket

public class EncapSecurityPayload
extends BasePacket

Implements IPv6 Encapsulating Security Payload (ESP) extension header format. (RFC 4303)

Field Summary

Fields

Modifier and Type	Field and Description
static byte	HEADER_LENGTH
protected int	securityParamIndex
protected int	sequence

Fields inherited from class org.onlab.packet.BasePacket

parent, payload

Constructor Summary

Constructors

Constructor and Description
EncapSecurityPayload()

Method Summary

Modifier and Type	Method and Description
IPacket	deserialize(byte[] data, int offset, int length) Deserialize this packet layer and all possible payloads.
static Deserializer<EncapSecurityPayload>	deserializer() Deserializer function for encapsulated security payload headers.
boolean	equals(Object obj)
int	getSecurityParamIndex() Gets the security parameter index of this header.
int	getSequence() Gets the sequence number of this header.
int	hashCode()
byte[]	serialize() Sets all payloads parent packet if applicable, then serializes this packet and all payloads.
EncapSecurityPayload	setSecurityParamIndex(int securityParamIndex) Sets the security parameter index of this header.
EncapSecurityPayload	setSequence(int sequence) Sets the sequence number of this header.
String	toString()

Methods inherited from class org.onlab.packet.BasePacket

clone, getParent, getPayload, resetChecksum, setParent, setPayload

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HEADER_LENGTH

public static final byte HEADER_LENGTH

See Also:

Constant Field Values

securityParamIndex

protected int securityParamIndex

sequence

protected int sequence

Constructor Detail

EncapSecurityPayload

public EncapSecurityPayload()

Method Detail

getSecurityParamIndex

public int getSecurityParamIndex()

Gets the security parameter index of this header.

Returns:

the security parameter index

setSecurityParamIndex

public EncapSecurityPayload setSecurityParamIndex(int securityParamIndex)

Sets the security parameter index of this header.

Parameters:

securityParamIndex - the security parameter index to set

Returns:

this

getSequence

public int getSequence()

Gets the sequence number of this header.

Returns:

the sequence number

setSequence

public EncapSecurityPayload setSequence(int sequence)

Sets the sequence number of this header.

Parameters:

sequence - the sequence number to set

Returns:

this

serialize

public byte[] serialize()

Description copied from interface: IPacket

Sets all payloads parent packet if applicable, then serializes this packet and all payloads.

Returns:

a byte[] containing this packet and payloads

deserialize

public IPacket deserialize(byte[] data,
                           int offset,
                           int length)

Description copied from interface: IPacket

Deserialize this packet layer and all possible payloads. NOTE: This method has been deprecated and will be removed in a future release. It is now recommended to use the Deserializer function provided by the deserialize() method on each packet to deserialize them. The Deserializer functions are robust to malformed input.

Parameters:

data - bytes to deserialize

offset - offset to start deserializing from

length - length of the data to deserialize

Returns:

the deserialized data

hashCode

public int hashCode()

Overrides:

hashCode in class BasePacket

equals

public boolean equals(Object obj)

Overrides:

equals in class BasePacket

deserializer

public static Deserializer<EncapSecurityPayload> deserializer()

Deserializer function for encapsulated security payload headers.

Returns:

deserializer function

toString

public String toString()

Overrides:

toString in class Object