VitamConfigurationParameters.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;

import com.google.common.base.Strings;

/**
 * This class contains Vitam Data
 */
public class VitamConfigurationParameters {

    protected String secret;
    protected boolean filterActivation = true;

    /**
     * VitamData empty constructor for YAMLFactory
     */
    public VitamConfigurationParameters() {
        // empty
    }


    /**
     * Must return the value of a 'secret' attribute
     *
     * @return the secret value
     */
    public String getSecret() {

        if (Strings.isNullOrEmpty(secret)) {
            return "";
        }
        return secret;
    }

    /**
     * @param secret the Platform secret to set
     * @return this
     * @throws IllegalArgumentException if secret is Null Or Empty
     */
    public VitamConfigurationParameters setSecret(String secret) {
        ParametersChecker.checkParameter("Platform secret", secret);
        this.secret = secret;
        return this;
    }


    /**
     * Must return the value of a 'filterActivation' attribute
     *
     * @return the filterActivation
     */
    public boolean isFilterActivation() {
        return filterActivation;
    }


    /**
     * @param filterActivation the filterActivation to set
     *
     * @return this
     */
    public VitamConfigurationParameters setFilterActivation(boolean filterActivation) {
        this.filterActivation = filterActivation;
        return this;
    }


}