com.agiletec.aps.system.services.baseconfig.ConfigInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of entando-engine Show documentation

Entando Engine: an agile, modern and user-centric open source Portal platform.

There is a newer version: 6.2.27

/*
 * Copyright 2015-Present Entando Inc. (http://www.entando.com) All rights reserved.
 *
 * This library 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 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library 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.
 */
package com.agiletec.aps.system.services.baseconfig;

import com.agiletec.aps.system.exception.ApsSystemException;
import java.util.Map;

/**
 * Interfaccia per il servizio di configurazione.
 *
 * @author M.Diana - E.Santoboni
 */
public interface ConfigInterface {

    public static final String ALGO_TYPE_PARAM_NAME = "algo.argon2.type";
    public static final String ALGO_HASH_LENGTH_PARAM_NAME = "algo.argon2.hash.length";
    public static final String ALGO_SALT_LENGTH_PARAM_NAME = "algo.argon2.salt.length";
    public static final String ALGO_ITERATIONS_PARAM_NAME = "algo.argon2.iterations";
    public static final String ALGO_MEMORY_PARAM_NAME = "algo.argon2.memory";
    public static final String ALGO_PARALLELISM_PARAM_NAME = "algo.argon2.parallelism";
    public static final String ALGO_DEFAULT_KEY = "algo.default.key";
    public static final String LEGACY_PASSWORDS_UPDATED = "legacyPasswordsUpdated";

    /**
     * Restituisce una voce di configurazione. La voce è un elemento di testo
     * che può essere complesso (es. XML). I valori restituiti sono relativi
     * alla versione di configurazione con cui è stato avviato il sistema.
     *
     * @param name Il codice della voce da restituire.
     * @return Il testo della voce di configurazione.
     */
    public String getConfigItem(String name);

    /**
     * Aggiorna una voce di configurazione. La voce è un elemento di testo che
     * può essere complesso (es. XML).
     *
     * @param name Il codice della voceda aggiornare.
     * @param config Il testo della voce di configurazione da aggiornare.
     * @throws ApsSystemException In caso di errore nell'aggiornamento
     */
    public void updateConfigItem(String name, String config) throws ApsSystemException;

    /**
     * Restituisce un parametro di configurazione. Un parametro è una stringa
     * semplice.
     *
     * @param name Il nome del parametro
     * @return Il valore del parametro
     */
    public String getParam(String name);

    public void updateParam(String name, String value) throws ApsSystemException;

    public void updateParams(Map params) throws ApsSystemException;

    public boolean areLegacyPasswordsUpdated();

}