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

Go to download
/*_##########################################################################
  _##
  _##  Copyright (C) 2018  Pcap4J.org
  _##
  _##########################################################################
*/

package org.pcap4j.packet;

import static org.pcap4j.util.ByteArrays.SHORT_SIZE_IN_BYTES;

import java.util.ArrayList;
import java.util.List;
import org.pcap4j.util.ByteArrays;

/**
 * Icmpv6 mobile prefix solicitation packet.
 *
 * @see RFC 6275
 * @see ICMPv6
 *     Parameters
 * @author Leo Ma
 * @since pcap4j 1.7.5
 */
public class IcmpV6MobilePrefixSolicitationPacket extends AbstractPacket {

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

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

  private IcmpV6MobilePrefixSolicitationPacket(byte[] rawData, int offset, int length)
      throws IllegalRawDataException {
    this.header = new IcmpV6MobilePrefixSolicitationHeader(rawData, offset, length);
  }

  private IcmpV6MobilePrefixSolicitationPacket(Builder builder) {
    this.header = new IcmpV6MobilePrefixSolicitationHeader(builder);
  }

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

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

  /** */
  public static final class Builder extends AbstractBuilder {

    private short identifier;
    private short reserved;

    /** */
    public Builder() {
      // Do nothing, just used to create a Builder without fields setting
    }

    private Builder(IcmpV6MobilePrefixSolicitationPacket packet) {
      this.identifier = packet.header.identifier;
      this.reserved = packet.header.reserved;
    }

    /**
     * @param identifier identifier
     * @return this Builder object for method chaining.
     */
    public Builder identifier(short identifier) {
      this.identifier = identifier;
      return this;
    }

    /**
     * @param reserved reserved
     * @return this Builder object for method chaining.
     */
    public Builder reserved(short reserved) {
      this.reserved = reserved;
      return this;
    }

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

  /**
   * Icmpv6 mobile prefix solicitation header.
   *
   *    *  0                            15                              31
   * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   * |          Identifier           |            Reserved           |
   * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   * 
   *
   * @see RFC 6275
   * @see ICMPv6
   *     Parameters
   * @author Leo Ma
   * @since pcap4j 1.7.5
   */
  public static final class IcmpV6MobilePrefixSolicitationHeader extends AbstractHeader {

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

    private static final int IDENTIFIER_OFFSET = 0;
    private static final int IDENTIFIER_SIZE = SHORT_SIZE_IN_BYTES;
    private static final int RESERVED_OFFSET = IDENTIFIER_OFFSET + IDENTIFIER_SIZE;
    private static final int RESERVED_SIZE = SHORT_SIZE_IN_BYTES;
    private static final int ICMPV6_MOBILE_PREFIX_SOLICITATION_HEADER_SIZE =
        RESERVED_OFFSET + RESERVED_SIZE;

    private final short identifier;
    private final short reserved;

    private IcmpV6MobilePrefixSolicitationHeader(byte[] rawData, int offset, int length)
        throws IllegalRawDataException {
      if (length < ICMPV6_MOBILE_PREFIX_SOLICITATION_HEADER_SIZE) {
        StringBuilder sb = new StringBuilder();
        sb.append("The data is too short to build an ICMPv6 Mobile Prefix Solicitation Header(")
            .append(ICMPV6_MOBILE_PREFIX_SOLICITATION_HEADER_SIZE)
            .append(" bytes). data: ")
            .append(ByteArrays.toHexString(rawData, " "))
            .append(", offset: ")
            .append(offset)
            .append(", length: ")
            .append(length);
        throw new IllegalRawDataException(sb.toString());
      }
      this.identifier = ByteArrays.getShort(rawData, IDENTIFIER_OFFSET + offset);
      this.reserved = ByteArrays.getShort(rawData, RESERVED_OFFSET + offset);
    }

    private IcmpV6MobilePrefixSolicitationHeader(Builder builder) {
      this.identifier = builder.identifier;
      this.reserved = builder.reserved;
    }

    /** @return identifier */
    public short getIdentifier() {
      return identifier;
    }

    /** @return identifier */
    public int getIdentifierAsInt() {
      return identifier & 0xFFFF;
    }

    /** @return reserved */
    public short getReserved() {
      return reserved;
    }

    @Override
    protected List getRawFields() {
      List rawFields = new ArrayList();
      rawFields.add(ByteArrays.toByteArray(identifier));
      rawFields.add(ByteArrays.toByteArray(reserved));
      return rawFields;
    }

    @Override
    public int length() {
      return ICMPV6_MOBILE_PREFIX_SOLICITATION_HEADER_SIZE;
    }

    @Override
    protected String buildString() {
      StringBuilder sb = new StringBuilder();
      String ls = System.getProperty("line.separator");

      sb.append("[ICMPv6 Mobile Prefix Solicitation Header (")
          .append(length())
          .append(" bytes)]")
          .append(ls);
      sb.append("  Identifier: ").append(getIdentifierAsInt()).append(ls);
      sb.append("  Reserved: ").append(reserved).append(ls);
      return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
      if (obj == this) {
        return true;
      }
      if (obj == null) {
        return false;
      }
      if (!this.getClass().isInstance(obj)) {
        return false;
      }

      IcmpV6MobilePrefixSolicitationHeader other = (IcmpV6MobilePrefixSolicitationHeader) obj;
      return this.identifier == other.identifier && this.reserved == other.reserved;
    }

    @Override
    protected int calcHashCode() {
      int result = 17;
      result = 31 * result + identifier;
      result = 31 * result + reserved;
      return result;
    }
  }
}