VitamApplication.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/

package fr.gouv.vitam.common.server.application;

import org.eclipse.jetty.server.Handler;

import fr.gouv.vitam.common.exception.VitamApplicationServerException;
import fr.gouv.vitam.common.server.application.configuration.VitamApplicationConfiguration;

/**
 * VitamApplication Interface
 *
 * @param <A> The VitamApplication final class
 * @param <C> The VitamApplicationConfiguration final class
 */
public interface VitamApplication<A extends VitamApplication<A, C>, C extends VitamApplicationConfiguration>
    extends VitamApplicationInterface<A, C> {
    /**
     * Return the name as a string of your configuration file. Example : "logbook.conf" </br>
     * Could be overridden if necessary
     *
     * @return the name of the application configuration file
     */
    String getConfigFilename();

    /**
     * @return the configuration
     */
    C getConfiguration();

    /**
     * Allow to override this method in Junit
     *
     * @param configuration
     */
    void setConfiguration(C configuration);

    /**
     *
     * @return the Configuration Class
     */
    Class<C> getConfigurationType();

    /**
     * @return the application Handler
     */
    Handler getApplicationHandler();

    /**
     * Start the server as full daemon and blocking
     *
     * @throws VitamApplicationServerException
     */
    void run() throws VitamApplicationServerException;

}