/*_##########################################################################
_##
_## Copyright (C) 2013-2014 Kaito Yamada
_##
_##########################################################################
*/
package org.pcap4j.packet;
import static org.pcap4j.util.ByteArrays.*;
import java.net.Inet6Address;
import java.util.ArrayList;
import java.util.List;
import org.pcap4j.packet.IcmpV6CommonPacket.IpV6NeighborDiscoveryOption;
import org.pcap4j.packet.factory.PacketFactories;
import org.pcap4j.packet.namednumber.IpV6NeighborDiscoveryOptionType;
import org.pcap4j.util.ByteArrays;
/**
* @author Kaito Yamada
* @since pcap4j 0.9.15
*/
public final class IcmpV6NeighborSolicitationPacket extends AbstractPacket {
/**
*
*/
private static final long serialVersionUID = 1178892836174110046L;
private final IcmpV6NeighborSolicitationHeader header;
/**
* A static factory method.
* This method validates the arguments by {@link ByteArrays#validateBounds(byte[], int, int)},
* which may throw exceptions undocumented here.
*
* @param rawData
* @param offset
* @param length
* @return a new IcmpV6NeighborSolicitationPacket object.
* @throws IllegalRawDataException
*/
public static IcmpV6NeighborSolicitationPacket newPacket(
byte[] rawData, int offset, int length
) throws IllegalRawDataException {
ByteArrays.validateBounds(rawData, offset, length);
return new IcmpV6NeighborSolicitationPacket(rawData, offset, length);
}
private IcmpV6NeighborSolicitationPacket(
byte[] rawData, int offset, int length
) throws IllegalRawDataException {
this.header = new IcmpV6NeighborSolicitationHeader(rawData, offset, length);
}
private IcmpV6NeighborSolicitationPacket(Builder builder) {
if (
builder == null
|| builder.targetAddress == null
|| builder.options == null
) {
StringBuilder sb = new StringBuilder();
sb.append("builder: ").append(builder)
.append(" builder.targetAddress: ").append(builder.targetAddress)
.append(" builder.options: ").append(builder.options);
throw new NullPointerException(sb.toString());
}
this.header = new IcmpV6NeighborSolicitationHeader(builder);
}
@Override
public IcmpV6NeighborSolicitationHeader getHeader() {
return header;
}
@Override
public Builder getBuilder() {
return new Builder(this);
}
/**
* @author Kaito Yamada
* @since pcap4j 0.9.15
*/
public static final class Builder extends AbstractBuilder {
private int reserved;
private Inet6Address targetAddress;
private List<IpV6NeighborDiscoveryOption> options;
/**
*
*/
public Builder() {}
private Builder(IcmpV6NeighborSolicitationPacket packet) {
this.reserved = packet.header.reserved;
this.targetAddress = packet.header.targetAddress;
this.options = packet.header.options;
}
/**
*
* @param reserved
* @return this Builder object for method chaining.
*/
public Builder reserved(int reserved) {
this.reserved = reserved;
return this;
}
/**
*
* @param targetAddress
* @return this Builder object for method chaining.
*/
public Builder targetAddress(Inet6Address targetAddress) {
this.targetAddress = targetAddress;
return this;
}
/**
*
* @param options
* @return this Builder object for method chaining.
*/
public Builder options(List<IpV6NeighborDiscoveryOption> options) {
this.options = options;
return this;
}
@Override
public IcmpV6NeighborSolicitationPacket build() {
return new IcmpV6NeighborSolicitationPacket(this);
}
}
/**
* @author Kaito Yamada
* @since pcap4j 0.9.15
*/
public static
final class IcmpV6NeighborSolicitationHeader extends AbstractHeader {
/*
* 0 1 2 3
* 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Reserved |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | |
* + +
* | |
* + Target Address +
* | |
* + +
* | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Options ...
* +-+-+-+-+-+-+-+-+-+-+-+-
*
*/
/**
*
*/
private static final long serialVersionUID = -2707375708511831386L;
private static final int RESERVED_OFFSET
= 0;
private static final int RESERVED_SIZE
= INT_SIZE_IN_BYTES;
private static final int TARGET_ADDRESS_OFFSET
= RESERVED_OFFSET + RESERVED_SIZE;
private static final int TARGET_ADDRESS_SIZE
= INET6_ADDRESS_SIZE_IN_BYTES;
private static final int OPTIONS_OFFSET
= TARGET_ADDRESS_OFFSET + TARGET_ADDRESS_SIZE;
private final int reserved;
private final Inet6Address targetAddress;
private final List<IpV6NeighborDiscoveryOption> options;
private IcmpV6NeighborSolicitationHeader(
byte[] rawData, int offset, int length
) throws IllegalRawDataException {
if (length < OPTIONS_OFFSET) {
StringBuilder sb = new StringBuilder(120);
sb.append("The raw data must be more than ")
.append(OPTIONS_OFFSET - 1).append("bytes")
.append(" to build this header. raw data: ")
.append(ByteArrays.toHexString(rawData, " "))
.append(", offset: ")
.append(offset)
.append(", length: ")
.append(length);
throw new IllegalRawDataException(sb.toString());
}
this.reserved = ByteArrays.getInt(rawData, RESERVED_OFFSET + offset);
this.targetAddress = ByteArrays.getInet6Address(rawData, TARGET_ADDRESS_OFFSET + offset);
this.options = new ArrayList<IpV6NeighborDiscoveryOption>();
int currentOffsetInHeader = OPTIONS_OFFSET;
while (currentOffsetInHeader < length) {
IpV6NeighborDiscoveryOptionType type
= IpV6NeighborDiscoveryOptionType.getInstance(rawData[currentOffsetInHeader + offset]);
IpV6NeighborDiscoveryOption newOne;
try {
newOne
= PacketFactories
.getFactory(
IpV6NeighborDiscoveryOption.class,
IpV6NeighborDiscoveryOptionType.class
).newInstance(
rawData,
currentOffsetInHeader + offset,
length - currentOffsetInHeader,
type
);
} catch (Exception e) {
break;
}
options.add(newOne);
currentOffsetInHeader += newOne.length();
}
}
private IcmpV6NeighborSolicitationHeader(Builder builder) {
this.reserved = builder.reserved;
this.targetAddress = builder.targetAddress;
this.options = new ArrayList<IpV6NeighborDiscoveryOption>(builder.options);
}
/**
*
* @return reserved
*/
public int getReserved() {
return reserved;
}
/**
*
* @return targetAddress
*/
public Inet6Address getTargetAddress() {
return targetAddress;
}
/**
*
* @return options
*/
public List<IpV6NeighborDiscoveryOption> getOptions() {
return new ArrayList<IpV6NeighborDiscoveryOption>(options);
}
@Override
protected List<byte[]> getRawFields() {
List<byte[]> rawFields = new ArrayList<byte[]>();
rawFields.add(ByteArrays.toByteArray(reserved));
rawFields.add(ByteArrays.toByteArray(targetAddress));
for (IpV6NeighborDiscoveryOption o: options) {
rawFields.add(o.getRawData());
}
return rawFields;
}
@Override
protected int calcLength() {
int len = 0;
for (IpV6NeighborDiscoveryOption o: options) {
len += o.length();
}
return len + OPTIONS_OFFSET;
}
@Override
protected String buildString() {
StringBuilder sb = new StringBuilder();
String ls = System.getProperty("line.separator");
sb.append("[ICMPv6 Neighbor Solicitation Header (")
.append(length())
.append(" bytes)]")
.append(ls);
sb.append(" Reserved: ")
.append(reserved)
.append(ls);
sb.append(" Target Address: ")
.append(targetAddress)
.append(ls);
for (IpV6NeighborDiscoveryOption opt: options) {
sb.append(" Option: ")
.append(opt)
.append(ls);
}
return sb.toString();
}
}
}