com.ardikars.jxpacket.common.layer.NetworkLayer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jxpacket-common Show documentation
Jxpacket is a network packet crafting library for java.
There is a newer version: 1.2.6.RELEASE
/**
 * Copyright (C) 2017-2018  Ardika Rommy Sanjaya 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package com.ardikars.jxpacket.common.layer;

import com.ardikars.common.util.NamedNumber;
import com.ardikars.jxpacket.common.Packet;
import com.ardikars.jxpacket.common.UnknownPacket;
import io.netty.buffer.ByteBuf;

import java.util.HashMap;
import java.util.Map;

public final class NetworkLayer extends NamedNumber implements Packet.Factory {

    /**
     * MTU Size (1500)
     */
    public static final int IEEE802_3_MAX_LENGTH = 1500;

    /**
     * IPv4: 0x0800
     */
    public static final NetworkLayer IPV4
            = new NetworkLayer((short) 0x0800, "IPv4");

    /**
     * Arp: 0x0806
     */
    public static final NetworkLayer ARP
            = new NetworkLayer((short) 0x0806, "Arp");

    /**
     * IEEE 802.1Q VLAN-tagged frames: 0x8100
     */
    public static final NetworkLayer DOT1Q_VLAN_TAGGED_FRAMES
            = new NetworkLayer((short) 0x8100, "IEEE 802.1Q VLAN-tagged frames");

    /**
     * QinQ: 0x88a8
     */
    public static final NetworkLayer IEEE_802_1_AD
            = new NetworkLayer((short) 0x88a8, "QinQ");
    /**
     * RARP: 0x8035
     */
    public static final NetworkLayer RARP
            = new NetworkLayer((short) 0x8035, "RARP");

    /**
     * Appletalk: 0x809b
     */
    public static final NetworkLayer APPLETALK
            = new NetworkLayer((short) 0x809b, "Appletalk");

    /**
     * IPv6: 0x86dd
     */
    public static final NetworkLayer IPV6
            = new NetworkLayer((short) 0x86dd, "IPv6");

    /**
     * PPP: 0x880b
     */
    public static final NetworkLayer PPP
            = new NetworkLayer((short) 0x880b, "PPP");

    /**
     * MPLS: 0x8847
     */
    public static final NetworkLayer MPLS
            = new NetworkLayer((short) 0x8847, "MPLS");

    /**
     * PPPoED Discovery Stage: 0x8863
     */
    public static final NetworkLayer PPPOE_DISCOVERY_STAGE
            = new NetworkLayer((short) 0x8863, "PPPoED Discovery Stage");

    /**
     * PPPoED Session Stage: 0x8864
     */
    public static final NetworkLayer PPPOE_SESSION_STAGE
            = new NetworkLayer((short) 0x8864, "PPPoED Session Stage");

    public static final NetworkLayer UNKNOWN
            = new NetworkLayer((short) -1, "Unknown");

    private static final Map registry
            = new HashMap();

    private static final Map builder
            = new HashMap<>();

    /**
     * @param value value
     * @param name  name
     */
    public NetworkLayer(Short value, String name) {
        super(value, name);
    }

    @Override
    public Packet newInstance(ByteBuf buffer) {
        Packet.Builder packetBuilder = builder.get(this.getValue());
        if (packetBuilder == null) {
            if (buffer == null || buffer.capacity() <= 0) {
                return null;
            }
            return new UnknownPacket.Builder().build(buffer);
        }
        return packetBuilder.build(buffer);
    }

    /**
     * @param value value
     * @return returns {@link NetworkLayer} object.
     */
    public static NetworkLayer valueOf(final Short value) {
        if ((value & 0xFFFF) <= IEEE802_3_MAX_LENGTH) {
            return UNKNOWN;
        }
        NetworkLayer protocolType = registry.get(value);
        if (protocolType == null) {
            return UNKNOWN;
        }
        return protocolType;
    }

    /**
     * @param type type.
     */
    public static void register(NetworkLayer type) {
        synchronized (registry) {
            registry.put(type.getValue(), type);
        }
    }

    /**
     *
     * @param networkLayer type.
     * @param packetBuilder packet builder.
     */
    public static void register(NetworkLayer networkLayer, Packet.Builder packetBuilder) {
        synchronized (builder) {
            builder.put(networkLayer.getValue(), packetBuilder);
        }
    }

    @Override
    public String toString() {
        return super.toString();
    }

    static {
        registry.put(IPV4.getValue(), IPV4);
        registry.put(ARP.getValue(), ARP);
        registry.put(DOT1Q_VLAN_TAGGED_FRAMES.getValue(), DOT1Q_VLAN_TAGGED_FRAMES);
        registry.put(RARP.getValue(), RARP);
        registry.put(APPLETALK.getValue(), APPLETALK);
        registry.put(IPV6.getValue(), IPV6);
        registry.put(PPP.getValue(), PPP);
        registry.put(MPLS.getValue(), MPLS);
        registry.put(PPPOE_DISCOVERY_STAGE.getValue(), PPPOE_DISCOVERY_STAGE);
        registry.put(PPPOE_SESSION_STAGE.getValue(), PPPOE_SESSION_STAGE);
        registry.put(IEEE_802_1_AD.getValue(), IEEE_802_1_AD);
    }

}