com.github.sdnwiselab.sdnwise.configuration.Configurator.java Source code

Introduction

Here is the source code for com.github.sdnwiselab.sdnwise.configuration.Configurator.java

Source

/*
 * Copyright (C) 2015 SDN-WISE
 *
 * This program 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.
 *
 * 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 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 <http://www.gnu.org/licenses/>.
 */
package com.github.sdnwiselab.sdnwise.configuration;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.stream.JsonReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Holder of the different kind of configuration classes. It provides methods to
 * parse/write configurations from/to a JSON file.
 *
 * @author Sebastiano Milardo
 */
public class Configurator {

    /**
     * Configuration parameters for the adaptation layer.
     */
    private final ConfigAdaptation adaptation = new ConfigAdaptation();
    /**
     * Configuration parameters for the controller layer.
     */
    private final ConfigController controller = new ConfigController();
    /**
     * Configuration parameters for the FlowVisor layer.
     */
    private final ConfigFlowVisor flowvisor = new ConfigFlowVisor();

    /**
     * Parses a file given in input containing a JSON string and returns the
     * corresponding configurator object described in the file.
     *
     * @param fileName the path to the JSON file
     * @return a configurator object
     */
    public static final Configurator load(final InputStream fileName) {
        try {
            return (new Gson()).fromJson(new JsonReader(new InputStreamReader(fileName, "UTF-8")),
                    Configurator.class);
        } catch (UnsupportedEncodingException ex) {
            Logger.getLogger(Configurator.class.getName()).log(Level.SEVERE, null, ex);
        }
        return null;
    }

    /**
     * Returns a configAdaptation object.
     *
     * @return a configAdaptation object
     */
    public final ConfigAdaptation getAdaptation() {
        return adaptation;
    }

    /**
     * Returns a ConfigController object.
     *
     * @return a configController object
     */
    public final ConfigController getController() {
        return controller;
    }

    /**
     * Returns a configFlowvisor object.
     *
     * @return a configFlowvisor object
     */
    public final ConfigFlowVisor getFlowvisor() {
        return flowvisor;
    }

    /**
     * Returns a string representation of the object in JSON format.
     *
     * @return a JSON string representation of this object.
     */
    @Override
    public final String toString() {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        return gson.toJson(this);
    }

}