org.fiware.cybercaptor.server.topology.asset.VLAN.java Source code

Introduction

Here is the source code for org.fiware.cybercaptor.server.topology.asset.VLAN.java

Source

/****************************************************************************************
 * This file is part of FIWARE CyberCAPTOR,                                             *
 * instance of FIWARE Cyber Security Generic Enabler                                    *
 * Copyright (C) 2012-2015  Thales Services S.A.S.,                                     *
 * 20-22 rue Grande Dame Rose 78140 VELIZY-VILACOUBLAY FRANCE                           *
 *                                                                                      *
 * FIWARE CyberCAPTOR is free software; you can redistribute                            *
 * it and/or modify it under the terms of the GNU General Public License                *
 * as published by the Free Software Foundation; either version 3 of the License,       *
 * or (at your option) any later version.                                               *
 *                                                                                      *
 * FIWARE CyberCAPTOR 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 General Public License for more details.                                         *
 *                                                                                      *
 * You should have received a copy of the GNU General Public License                    *
 * along with FIWARE CyberCAPTOR.                                                       *
 * If not, see <http://www.gnu.org/licenses/>.                                          *
 ****************************************************************************************/
package org.fiware.cybercaptor.server.topology.asset;

import org.fiware.cybercaptor.server.topology.asset.component.Interface;
import org.jdom2.Element;

import java.util.ArrayList;
import java.util.List;

/**
 * Class to represent a VLAN
 *
 * @author Francois -Xavier Aguessy
 */
public class VLAN implements Cloneable {
    /**
     * The name of the VLAN
     */
    private String name = "";

    /**
     * The label of the VLAN
     */
    private String label = "";

    /**
     * The IP address of the network
     */
    private IPAddress networkAddress;

    /**
     * The network mask of the VLAN
     */
    private int networkMask;
    /**
     * The list of hosts contained in the VLAN
     */
    private List<Host> hosts = new ArrayList<Host>();

    /**
     * The list of all the interfaces contained in the VLAN
     */
    private List<Interface> interfaces = new ArrayList<Interface>();

    /**
     * Create a default VLAN
     */
    public VLAN() {
        java.util.Random rand = new java.util.Random();
        this.label = rand.nextInt(10000) + "";
    }

    /**
     * Instantiates a new VLAN.
     *
     * @param label the label of the VLAN
     */
    public VLAN(String label) {
        this.label = label;
    }

    /**
     * Instantiates a new VLAN.
     *
     * @param label The label of the VLAN
     * @param name  The name of the VLAN
     */
    public VLAN(String label, String name) {
        this.label = label;
        this.name = name;
    }

    /**
     * Gets name.
     *
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * Sets name.
     *
     * @param name the name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Gets hosts.
     *
     * @return the hosts
     */
    public List<Host> getHosts() {
        return hosts;
    }

    /**
     * Add host.
     *
     * @param host the hosts to add
     */
    public void addHost(Host host) {
        this.hosts.add(host);
    }

    /**
     * Gets interfaces.
     *
     * @return the interfaces
     */
    public List<Interface> getInterfaces() {
        return interfaces;
    }

    /**
     * Add interface.
     *
     * @param intface the interface to add
     */
    public void addInterface(Interface intface) {
        this.interfaces.add(intface);
    }

    /**
     * Gets label.
     *
     * @return the label
     */
    public String getLabel() {
        return label;
    }

    /**
     * Sets label.
     *
     * @param label the label to set
     */
    public void setLabel(String label) {
        this.label = label;
    }

    @Override
    public VLAN clone() throws CloneNotSupportedException {
        return (VLAN) super.clone();
    }

    /**
     * To dOM element.
     *
     * @return the element
     */
    public Element toDOMElement() {
        Element root = new Element("vlan");

        Element vlanNameElement = new Element("name");
        vlanNameElement.setText(this.name);
        root.addContent(vlanNameElement);

        Element vlanLabelElement = new Element("label");
        vlanLabelElement.setText(this.label);
        root.addContent(vlanLabelElement);

        return root;
    }

    /**
     * Gets network address.
     *
     * @return the network address
     */
    public IPAddress getNetworkAddress() {
        return networkAddress;
    }

    /**
     * Sets network address.
     *
     * @param networkAddress the network address
     */
    public void setNetworkAddress(IPAddress networkAddress) {
        this.networkAddress = networkAddress;
    }

    /**
     * Gets network mask.
     *
     * @return the network mask
     */
    public int getNetworkMask() {
        return networkMask;
    }

    /**
     * Sets network mask.
     *
     * @param networkMask the network mask
     */
    public void setNetworkMask(int networkMask) {
        this.networkMask = networkMask;
    }
}