Module org.pcap4j.core

Package org.pcap4j.packet

Class Dot11SsidElement

java.lang.Object

org.pcap4j.packet.Dot11InformationElement

org.pcap4j.packet.Dot11SsidElement

All Implemented Interfaces:

java.io.Serializable

public final class Dot11SsidElement
extends Dot11InformationElement

IEEE802.11 SSID element

       1         1          0-32
 +----------+----------+-------------
 |Element ID|  Length  |    SSID
 +----------+----------+-------------
 Element ID: 0
 

A SSID field of length 0 is used within Probe Request management frames to indicate the wildcard SSID. The wildcard SSID is also used in Beacon and Probe Response frames transmitted by mesh STAs. When the UTF-8 SSID subfield of the Extended Capabilities element is equal to 1 in the frame that includes the SSID element, the SSID is interpreted using UTF-8 encoding.

Since:

pcap4j 1.7.0

See Also:

IEEE802.11, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dot11SsidElement.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private static java.nio.charset.Charset	ENCODING
private static long	serialVersionUID
private java.lang.String	ssid

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Dot11SsidElement(byte[] rawData, int offset, int length)
private	Dot11SsidElement(Dot11SsidElement.Builder builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
Dot11SsidElement.Builder	getBuilder()
byte[]	getRawData()
java.lang.String	getSsid()
int	hashCode()
int	length()
static Dot11SsidElement	newInstance(byte[] rawData, int offset, int length)	A static factory method.
java.lang.String	toString()
java.lang.String	toString(java.lang.String indent)

Methods inherited from class org.pcap4j.packet.Dot11InformationElement

getElementId, getLength, getLengthAsInt

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ENCODING

private static final java.nio.charset.Charset ENCODING

ssid

private final java.lang.String ssid

Constructor Detail

Dot11SsidElement

private Dot11SsidElement(byte[] rawData,
                         int offset,
                         int length)
                  throws IllegalRawDataException

Parameters:

rawData - rawData

offset - offset

length - length

Throws:

IllegalRawDataException - if parsing the raw data fails.

Dot11SsidElement

private Dot11SsidElement(Dot11SsidElement.Builder builder)

Parameters:

builder - builder

Method Detail

newInstance

public static Dot11SsidElement newInstance(byte[] rawData,
                                           int offset,
                                           int length)
                                    throws IllegalRawDataException

A static factory method. This method validates the arguments by ByteArrays.validateBounds(byte[], int, int), which may throw exceptions undocumented here.

Parameters:

rawData - rawData

offset - offset

length - length

Returns:

a new Dot11SsidElement object.

Throws:

IllegalRawDataException - if parsing the raw data fails.

getSsid

public java.lang.String getSsid()

Returns:

ssid

length

public int length()

Specified by:

length in class Dot11InformationElement

Returns:

the length

getRawData

public byte[] getRawData()

Specified by:

getRawData in class Dot11InformationElement

Returns:

the raw data.

getBuilder

public Dot11SsidElement.Builder getBuilder()

Returns:

a new Builder object populated with this object's fields.

hashCode

public int hashCode()

Overrides:

hashCode in class Dot11InformationElement

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Dot11InformationElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String indent)

Parameters:

indent - indent

Returns:

the string representation of this object.