/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* 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,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* 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.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using System.IO;
using System.Reflection;
using AgentService.Agent;
using AgentService.Agent.Runtime;
using AgentService.Platform;
using AgentService.Platform.Modules;
using AgentService.Platform.Configuration;
using AgentService.Platform.Commands;
using AgentService.Platform.AMS;
using AgentService.Interop;

namespace AgentService.Platform
{

    /// <summary>
    //// Interface IPlatform. Defines the contract and the
    /// API exposed to control the platform instance.
    /// </summary>
    public interface IPlatform
    {
        #region Platform structure constant strings

        #endregion

        #region Data Member

        string amsName
        {
            get;
        }
        /// <summary>
        /// Name of the MTS agent.
        /// </summary>
        string mtsName
        { 
            get;
        }
        /// <summary>
        /// Name of the DF agent.
        /// </summary>
        string dfName
        {
            get;
        }
        
        IPlatformDescription Description
        {
            get;
        }

        /// <summary>
        /// Gets the Yellow Pages Service.
        /// </summary>
        IYellowPagesServer YellowPageSvc
        {
            get;
        }

        /// <summary>
        /// Gets the White Pages Service.
        /// </summary>
        IWhitePagesServer WhitePageSvc
        {
            get;
        }

        #endregion

        #region Platform Startup and Configuration

        /// <summary>
        /// Gets the Platform Configuration Information.
        /// </summary>
        Configuration.Configuration Configuration
        {
            get;
        }

        /// <summary>
        /// Gets the platform State.
        /// </summary>
        PlatformState State
        {
            get;
        }

        #endregion

        #region Support Members

        IPlatformConsole Console
        {
            get;
        }

        #endregion

        #region Platform Modules

        /// <summary>
        /// Gets the Storage Module.
        /// </summary>
        IStorageModule Storage
        {
            get;
        }

        /// <summary>
        /// Gets the Messaging Module.
        /// </summary>
        IMessagingModule Messaging
        {
            get;
        }

        /// <summary>
        /// Gets the Persistence Module.
        /// </summary>
        IPersistenceModule Persistence
        {
            get;
        }

        /// <summary>
        /// Gets the Logging Module.
        /// </summary>
        ILoggingModule Logging
        {
            get;
        }

        /// <summary>
        /// Gets the additional modules loaded in the platform.
        /// </summary>
        IPlatformModule[] Modules
        {
            get;
        }

        #endregion

        #region Core Agents References

        AgentService.Platform.AMS.AMS ams
        {
            get;
        }

        AgentService.Platform.MTS.IMTSGateway mts
        {
            get;
        }

        #endregion

        #region Constructors

        #endregion

        #region Platform Control Methods

        /// <summary>
        /// Installs a module into the AgentService platform
        /// </summary>
        /// <param name="typeName">full name of the type that define the module</param>
        /// <param name="assemblyFile">path to the assembly where the type is defined</param>
        /// <param name="configFile">name of the file to store configuration information</param>
        /// <returns>true if the installation is successful</returns>
        bool InstallModule(ModuleInfo modInfo);

        /// <summary>
        /// Uninstalls a module from the AgentService platform
        /// </summary>
        /// <param name="typeName">full name of the type that implements the module</param>
        /// <param name="bRemoveAssembly">true if the assembly need to be removed after uninstall</param>
        /// <returns>true if the uninstallation has been successful</returns>
        bool UninstallModule(string typeName, bool bRemoveAssembly);

        #endregion

        #region Worker Private Methods

        #endregion

        #region Agent Management Methods

        /// <summary>
        /// Create an agent with the given agent template, name, and configuration file
        /// </summary>
        /// <param name="agentTemplate">name of the agent template</param>
        /// <param name="agentName">name of the agent to be created</param>
        /// <param name="configFile">name of the configuration file including the path</param>
        /// <param name="bPersist">persistence flag</param>
        /// <returns>True if the agent is been created, false otherwise</returns>
        AID CreateAgent(string agentTemplate, string agentName, string configFile, bool bPersist);
        
        /// <summary>
        /// Create an agent with the given agent template, name, and configuration file
        /// </summary>
        /// <param name="agentTemplate">name of the agent template</param>
        /// <param name="agentName">name of the agent to be created</param>
        /// <param name="configFile">name of the configuration file including the path</param>
        /// <param name="bPersist">persistence flag</param>
        /// <param name="bCreateForResume">if true do not perform agent initialization</param>
        /// <param name="bDomain"> domain flag</param>
        /// <returns>True if the agent is been created, false otherwise</returns>

        AID CreateAgent(string agentTemplate, string agentName, string configFile, bool bPersist, bool bCreateForResume, bool bDomain);

        /// <summary>
        /// Create an agent with the given agent template, name, and configuration file
        /// </summary>
        /// <param name="agentTemplate">name of the agent template</param>
        /// <param name="agentName">name of the agent to be created</param>
        /// <param name="configFile">name of the configuration file including the path</param>
        /// <param name="bPersist">persistence flag</param>
        /// <param name="bCreateForResume">if true do not perform agent initialization</param>
        /// <param name="bDomain"> domain flag</param>
        /// <param name="domainName">the name of the AppDomain in which the Agent is created</param>
        /// <returns>True if the agent is been created, false otherwise</returns>

        AID CreateAgent(string agentTemplate, string agentName, string configFile, bool bPersist, bool bCreateForResume, bool bDomain, string domainName);

        /// <summary>
        /// persistence event handler
        /// </summary>
        /// <param name="sender">source of the event</param>
        /// <param name="args">event args</param>
        void persistAgent(object sender, PersistenceEventArgs args);

        /// <summary>
        /// Callback or agent activation
        /// </summary>
        /// <param name="sender">aid of the activted agent</param>
        void onActivateAgent(AID sender);

        /// <summary>
        /// Callback for agent termination
        /// </summary>
        /// <param name="sender">aid of the terminated agent</param>
        void onTerminateAgent(AID sender);

        #endregion
    }
}