/*********************************************************************/
/*                                                                   */
/*                     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.Collections.Specialized;

using AgentService.Platform.Modules;

namespace AgentService.Platform.Configuration
{


	/// <summary>
	/// Class InstallationData. Holds installation information
	/// </summary>
	public class InstallationData 
	{

		/// <summary>
		/// Base dir path for the AgentService platform
		/// </summary>
        protected string baseDirPath;
		/// <summary>
		/// Gets, sets the base dir path for the AgentService
		/// platform
		/// </summary>
		public string BaseDirPath 
		{
			get 
			{
				return this.baseDirPath;
			}
			
			set 
			{
				if (this.bUpdating == false)
					throw new InvalidOperationException("Properties can be modified only in the updating phase");
				this.baseDirPath = value;
			}
		}


		/// <summary>
		/// Repository file name
		/// </summary>
		protected string repositoryFile;
		/// <summary>
		/// Gets, sets the base dir path for the AgentService
		/// platform
		/// </summary>
		public string RepositoryFile
		{
			get 
			{
				return this.repositoryFile;
			}
			
			set 
			{
				if (this.bUpdating == false)
					throw new InvalidOperationException("Properties can be modified only in the updating phase");
				this.repositoryFile = value;
			}
		}

		/// <summary>
		/// 
		/// </summary>
		private PlatformDescription descr;
		/// <summary>
		/// Gets, sets the platform description
		/// </summary>
		public PlatformDescription PlatformDescription
		{
			get 
			{
				return this.descr;
			}
			
			set 
			{
				if (this.bUpdating == false)
					throw new InvalidOperationException("Properties can be modified only in the updating phase");
				this.descr = value;
			}
		
		}

		/// <summary>
		/// error flag.
		/// </summary>
		private bool bHasErrors;
		/// <summary>
		/// Indicates whether the configuration is consistent.
		/// </summary>
		public bool HasErrors 
		{
			get 
			{
				return this.bHasErrors;
			}
		}

		/// <summary>
		/// error message
		/// </summary>
		private string errorMessage;
		/// <summary>
		/// Gets the error message
		/// </summary>
		public string ErrorMessage 
		{
			get 
			{
				return this.errorMessage;
			}
			set
			{
				if (this.bUpdating == false)
					throw new InvalidOperationException("Properties can be modified only in the updating phase");
			
				this.errorMessage  = value;
			}

		}
	
		/// <summary>
		/// true while the installation data are update. 
		/// bUpdating is set to true by calling BeginUpdate, 
		/// while is set to false by calling  EndUpdate
		/// </summary>
		private bool bUpdating;
		/// <summary>
		/// Gets true while the installation data are updated
		/// </summary>
		public bool IsUpdating 
		{
			get 
			{
				return this.bUpdating;
			}
		}


		/// <summary>
		/// Info about the storage module.
		/// </summary>
		protected ModuleInfo storageModule;
		/// <summary>
		/// Gets, sets the storage module loading information.
		/// </summary>
		public ModuleInfo Storage
		{
			get 
			{
				return this.storageModule;
			}
			set
			{
				if (this.bUpdating == false) 
				{
					throw new InvalidOperationException("Properties can be modified only in the reading phase");
				}

				this.storageModule  = value;
			}		
		}

		/// <summary>
		/// Info about the messaging module.
		/// </summary>
		protected ModuleInfo messagingModule;
		/// <summary>
		/// Gets, sets the messaging module loading information.
		/// </summary>
		public ModuleInfo Messaging
		{
			get 
			{
				return this.messagingModule;
			}
			set
			{
				if (this.bUpdating == false) 
				{
					throw new InvalidOperationException("Properties can be modified only in the reading phase");
				}

				this.messagingModule  = value;
			}		
		}


		/// <summary>
		/// Info about the persistence module.
		/// </summary>
		protected ModuleInfo persistenceModule;
		/// <summary>
		/// Gets, sets the persistence module loading information.
		/// </summary>
		public ModuleInfo Persistence
		{
			get 
			{
				return this.persistenceModule;
			}
			set
			{
				if (this.bUpdating == false) 
				{
					throw new InvalidOperationException("Properties can be modified only in the reading phase");
				}

				this.persistenceModule  = value;
			}		
		}

		/// <summary>
		/// Info about the logging module.
		/// </summary>
		protected ModuleInfo loggingModule;
		/// <summary>
		/// Gets, sets the logging module loading information.
		/// </summary>
		public ModuleInfo Logging
		{
			get 
			{
				return this.loggingModule;
			}
			set
			{
				if (this.bUpdating == false) 
				{
					throw new InvalidOperationException("Properties can be modified only in the reading phase");
				}

				this.loggingModule  = value;
			}		
		}


		/// <summary>
		/// Additional modules information.
		/// </summary>
		private ModuleInfo[] additionalModules;
		/// <summary>
		/// Gets, sets the loading information about the additional modules.
		/// </summary>
		public ModuleInfo[] AdditionalModules 
		{
			get 
			{
				return this.additionalModules;
			}
			set
			{
				if (this.bUpdating == false) 
				{
					throw new InvalidOperationException("Properties can be modified only in the reading phase");
				}

				this.additionalModules  = value;
			}			
		}
        /// <summary>
        /// dictionary of additional properties
        /// </summary>
        protected StringDictionary properties;
        /// <summary>
        /// Gets, sets the dictionary of additional
        /// properties.
        /// </summary>
        public StringDictionary Properties 
        {
            set
            {
                if (this.bUpdating == false)
                {
                    throw new InvalidOperationException("Properties can be modified only in the reading phase");
                }
                this.properties = value;
            }
            get 
            {
                return this.properties;
            }
        
        }

		/// <summary>
		/// Begins the update process, and sets the Updating property to true.
		/// </summary>
		public void BeginUpdate() 
		{
			this.bUpdating = true;
		}

		/// <summary>
		/// Terminates the update process and sets the Updating property to false.
		/// </summary>
		public void EndUpdate() 
		{
			this.bUpdating = false;
		}

		/// <summary>
		/// Sets the HasErrors property to true during updating. Calling this method
		/// outside the updating process will throw an InvalidOperation exception.
		/// </summary>
		public void SetError() 
		{
			if (this.bUpdating)
				this.bHasErrors = true;
			else
				throw new InvalidOperationException("Cannot notify errors while installation data are not in the updating phase.");
		}

		/// <summary>
		/// Clears the HasErrors flag. 
		/// </summary>
		public void ResetError() 
		{
			this.bHasErrors = false;
		}
		
	}

	/// <summary>
	/// Class InstallManager. Base abstract type for InstallManager types. 
	/// Basicly reads and writes installation files from and to a file.
	/// </summary>
	public abstract class InstallManager
	{
		
		/// <summary>
		/// Gets the information message about the last operation
		/// </summary>
		public virtual string InfoMessage
		{
			get 
			{
				return null;
			}
		}

		/// <summary>
		/// Gets the selected installation file.
		/// </summary>
		public virtual string InstallationFile 
		{
			get
			{
				return null;
			}
		}
		/// <summary>
		/// Gets, sets the default configuration file
		/// </summary>
		public virtual string ConfigurationFile  
		{
			get
			{
				return null;
			}
			set
			{
			
			}
		}

		/// <summary>
		/// Gets, sets the description of the platform
		/// </summary>
		public virtual PlatformDescription PlatformDescription 
		{
			get 
			{
				return null;
			}
			set
			{
			
			}
		}
		
		/// <summary>
		/// Reads the installation file and constructs the corresponding 
		/// InstallationData object.
		/// </summary>
		/// <returns>InstallationData object</returns>
		public virtual InstallationData Read() 
		{
			return null;
		}
		/// <summary>
		/// Writes the default configuration file.
		/// </summary>
		public virtual bool GenerateDefaultConfigurationFile(InstallationData inst) 
		{
			return true;
		}
	}
}