/*************************************************************************
 *                                                                       *
 *  SignServer: The OpenSource Automated Signing Server                  *
 *                                                                       *
 *  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.signserver.ejb.interfaces;

import java.util.List;
import javax.ejb.Local;
import javax.ejb.Remote;
import org.signserver.common.GlobalConfiguration;

import org.signserver.common.ResyncException;
import org.signserver.server.log.AdminInfo;

/**
 * Common interface containing all the session bean methods.
 *
 * @version $Id: IGlobalConfigurationSession.java 3253 2013-01-25 16:18:34Z malu9369 $
 */
public interface IGlobalConfigurationSession {

    String LOG_OPERATION = "GLOBALCONFIG_OPERATION";
    String LOG_PROPERTY = "GLOBALCONFIG_PROPERTY";
    String LOG_VALUE = "GLOBALCONFIG_VALUE";

    /**
     * Method setting a global configuration property. For node. prefix will the
     * node id be appended.
     * @param scope one of the GlobalConfiguration.SCOPE_ constants
     * @param key of the property should not have any scope prefix, never null
     * @param value the value, never null.
     */
    void setProperty(String scope, String key, String value);

    /**
     * Method used to remove a property from the global configuration.
     * @param scope one of the GlobalConfiguration.SCOPE_ constants
     * @param key of the property should start with either glob. or node.,
     * never null
     * @return true if removal was successful, othervise false.
     */
    boolean removeProperty(String scope, String key);

    /**
     * Method that returns all the global properties with Global Scope and Node
     * scopes properties for this node.
     * @return A GlobalConfiguration Object, never null
     */
    GlobalConfiguration getGlobalConfiguration();

    /**
     * Method that is used after a database crash to restore all cached data to
     * database.
     * @throws ResyncException if resync was unsuccessfull
     */
    void resync() throws ResyncException;

    /**
     * Method to reload all data from database.
     */
    void reload();

    @Remote
    interface IRemote extends IGlobalConfigurationSession {

        String JNDI_NAME = "signserver/GlobalConfigurationSessionBean/remote";
    }

    /**
     * Local EJB interface.
     * Mirrors methods which are audit-logged, taking an extra AdminInfo instance.
     */
    @Local
    interface ILocal extends IGlobalConfigurationSession {
        String JNDI_NAME = "signserver/GlobalConfigurationSessionBean/local";
        
        /**
         * Method setting a global configuration property. For node. prefix will the
         * node id be appended.
         * @param adminInfo Administrator information
         * @param scope one of the GlobalConfiguration.SCOPE_ constants
         * @param key of the property should not have any scope prefix, never null
         * @param value the value, never null.
         */
        void setProperty(final AdminInfo adminInfo, String scope, String key, String value);
        
        /**
         * Method used to remove a property from the global configuration.
         * @param adminInfo Administrator information
         * @param scope one of the GlobalConfiguration.SCOPE_ constants
         * @param key of the property should start with either glob. or node.,
         * never null
         * @return true if removal was successful, othervise false.
         */
        boolean removeProperty(final AdminInfo adminInfo, String scope, String key);
        
        /**
         * Method that is used after a database crash to restore all cached data to
         * database.
         * @param adminInfo Administrator information
         * @throws ResyncException if resync was unsuccessfull
         */
        void resync(final AdminInfo adminInfo) throws ResyncException;
        
        /**
         * Method that is used after a database crash to restore all cached data to
         * database.
         * @param adminInfo Administrator information
         * @throws ResyncException if resync was unsuccessfull
         */
        void reload(final AdminInfo adminInfo);
    }
}