org.pcap4j.packet.IpV6ExtHopByHopOptionsPacket Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pcap4j-core Show documentation
The core module of Pcap4J.
There is a newer version: 2.0.0-alpha.6
/*_##########################################################################
  _##
  _##  Copyright (C) 2012-2014  Pcap4J.org
  _##
  _##########################################################################
*/

package org.pcap4j.packet;

import java.util.List;
import org.pcap4j.packet.namednumber.IpNumber;
import org.pcap4j.util.ByteArrays;

/**
 * @author Kaito Yamada
 * @since pcap4j 0.9.10
 */
public final class IpV6ExtHopByHopOptionsPacket extends IpV6ExtOptionsPacket {

  /** */
  private static final long serialVersionUID = 4289988881526919621L;

  private final IpV6ExtHopByHopOptionsHeader 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 rawData
   * @param offset offset
   * @param length length
   * @return a new IpV6ExtHopByHopOptionsPacket object.
   * @throws IllegalRawDataException if parsing the raw data fails.
   */
  public static IpV6ExtHopByHopOptionsPacket newPacket(byte[] rawData, int offset, int length)
      throws IllegalRawDataException {
    ByteArrays.validateBounds(rawData, offset, length);

    IpV6ExtHopByHopOptionsHeader optHeader =
        new IpV6ExtHopByHopOptionsHeader(rawData, offset, length);

    int payloadLength = length - optHeader.length();
    if (payloadLength > 0) {
      return new IpV6ExtHopByHopOptionsPacket(
          rawData, offset + optHeader.length(), payloadLength, optHeader);
    } else {
      return new IpV6ExtHopByHopOptionsPacket(optHeader);
    }
  }

  private IpV6ExtHopByHopOptionsPacket(IpV6ExtHopByHopOptionsHeader optHeader) {
    this.header = optHeader;
  }

  private IpV6ExtHopByHopOptionsPacket(
      byte[] rawData,
      int payloadOffset,
      int payloadLength,
      IpV6ExtHopByHopOptionsHeader optHeader) {
    super(rawData, payloadOffset, payloadLength, optHeader.getNextHeader());
    this.header = optHeader;
  }

  private IpV6ExtHopByHopOptionsPacket(Builder builder) {
    super(builder);
    this.header = new IpV6ExtHopByHopOptionsHeader(builder);
  }

  @Override
  public IpV6ExtHopByHopOptionsHeader getHeader() {
    return header;
  }

  @Override
  public Builder getBuilder() {
    return new Builder(this);
  }

  /**
   * @author Kaito Yamada
   * @since pcap4j 0.9.10
   */
  public static final class Builder extends org.pcap4j.packet.IpV6ExtOptionsPacket.Builder {

    /** */
    public Builder() {}

    private Builder(IpV6ExtHopByHopOptionsPacket packet) {
      super(packet);
    }

    @Override
    public Builder nextHeader(IpNumber nextHeader) {
      super.nextHeader(nextHeader);
      return this;
    }

    @Override
    public Builder hdrExtLen(byte hdrExtLen) {
      super.hdrExtLen(hdrExtLen);
      return this;
    }

    @Override
    public Builder options(List options) {
      super.options(options);
      return this;
    }

    @Override
    public Builder payloadBuilder(Packet.Builder payloadBuilder) {
      super.payloadBuilder(payloadBuilder);
      return this;
    }

    @Override
    public IpV6ExtHopByHopOptionsPacket build() {
      return new IpV6ExtHopByHopOptionsPacket(this);
    }
  }

  /**
   * @author Kaito Yamada
   * @since pcap4j 0.9.10
   */
  public static final class IpV6ExtHopByHopOptionsHeader extends IpV6ExtOptionsHeader {

    /*
     *  0                              16                            31
     * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     * |  Next Header  |  Hdr Ext Len  |                               |
     * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
     * |                                                               |
     * .                                                               .
     * .                            Options                            .
     * .                                                               .
     * |                                                               |
     * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     *
     */

    /** */
    private static final long serialVersionUID = -3903426584619413207L;

    private IpV6ExtHopByHopOptionsHeader(byte[] rawData, int offset, int length)
        throws IllegalRawDataException {
      super(rawData, offset, length);
    }

    private IpV6ExtHopByHopOptionsHeader(Builder builder) {
      super(builder);
    }

    @Override
    protected String getHeaderName() {
      return "IPv6 Hop-by-Hop Options Header";
    }
  }
}