/*************************************************************************
 *                                                                       *
 *  EJBCA Community: The OpenSource Certificate Authority                *
 *                                                                       *
 *  This software 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 any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.ejbca.core.ejb.config;

import java.util.Properties;

import javax.ejb.Remote;

/**
 * @version $Id: ConfigurationSessionRemote.java 19902 2014-09-30 14:32:24Z anatom $
 */
@Remote
public interface ConfigurationSessionRemote {

	/**
     * Try to backup the current configuration.
     * @return false if a backup already exists.
     */
    public boolean backupConfiguration();

    /**
     * Restore configuration from backup.
     * @return false if no backup exists.
     */
    public boolean restoreConfiguration();

    /**
     * Makes sure there is a backup of the configuration and then alters the
     * active configuration with all the properties.
     */
    public boolean updateProperties(Properties properties);

    /**
     * Makes sure there is a backup of the configuration and then alters the
     * active configuration with the property.
     */
    public boolean updateProperty(String key, String value);

    /** Verifies that the property is set to the expected value. */
    public boolean verifyProperty(String key, String value);

    /** Returns a property from the current server configuration. */
    public String getProperty(String key);

    /** @return all currently used properties */
    public Properties getAllProperties();
}