/*********************************************************************/
/*                                                                   */
/*                     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 AgentService;
using AgentService.Platform.DF;
using AgentService.Platform.AMS;

namespace AgentService.Agent.Runtime
{
	/// <summary>
	/// Class DefaultYelloPagesClient. Provides a default implementation of the IYellowPagesClient interface.
	/// </summary>
	public class DefaultYellowPagesClient: IYellowPagesClient
	{
		/// <summary>
		/// AID of the agent instance that owns the client.
		/// </summary>
		private AID aid;

		/// <summary>
		/// Reference to the YellowPages service.
		/// </summary>
		private IYellowPagesServer yellowPagesServer;

		/// <summary>
		/// Constructs a DefaultYellowPagesClient.
		/// </summary>
		/// <param name="aid">aid of the owning agent</param>
		/// <param name="yellowPagesServer">reference to the YellowPages service</param>
		public DefaultYellowPagesClient(AID aid, IYellowPagesServer yellowPagesServer)
		{
			this.aid = aid;
			this.yellowPagesServer = yellowPagesServer;
		}

		#region IYellowPagesClient Members

		/// <summary>
		/// Searches for agents that offer the given service description.
		/// </summary>
		/// <param name="sd">description of the required service</param>
		/// <returns>array of agent descriptions that offer the given service</returns>
		public DFAgentDescription[] SearchAgent(ServiceDescription sd)
		{
			lock(this.yellowPagesServer)
			{
				return this.yellowPagesServer.SearchAgent(sd);
			}
		}
		/// <summary>
		/// Searches for agents that offer the given service description.
		/// </summary>
		/// <param name="sd">description of the required service</param>
		/// <param name="flags">Flags that specify which fields are used to compare the services</param>
		/// <returns>array of agent descriptions that offer the given service</returns>
		public DFAgentDescription[] SearchAgent(ServiceDescription sd, ServiceComparison flags)
		{
			lock(this.yellowPagesServer)
			{
				return this.yellowPagesServer.SearchAgent(sd, flags);
			}
		}
		/// <summary>
		/// Searches for agents that offer the given service description, by following the given constraints.
		/// </summary>
		/// <param name="sd">description of the required service</param>
		/// <param name="constraint">set of constraints that will be applied to the search</param>
		/// <returns>array of agent descriptions that offer the given service</returns>
		public DFAgentDescription[] SearchAgent(ServiceDescription sd, SearchConstraints constraint)
		{
			lock(this.yellowPagesServer)
			{
				return this.yellowPagesServer.SearchAgent(sd, constraint);
			}
		}
		/// <summary>
		/// Searches for agents that offer the given service description, by following the given constraints.
		/// </summary>
		/// <param name="sd">description of the required service</param>
		/// <param name="flags">Flags that specify which fields are used to compare the services</param>
		/// <param name="constraint">set of constraints that will be applied to the search</param>
		/// <returns>array of agent descriptions that offer the given service</returns>
		public DFAgentDescription[] SearchAgent(ServiceDescription sd, ServiceComparison flags, SearchConstraints constraint)
		{
			lock(this.yellowPagesServer)
			{
				return this.yellowPagesServer.SearchAgent(sd, flags, constraint);
			}
		}
		/// <summary>
		/// Registers an agent with the directory facilitator service.
		/// </summary>
		/// <param name="description">description of the services promoted by the agent</param>
		public void Register(DFAgentDescription description)
		{
			lock(this.yellowPagesServer)
			{
				description.Aid = this.aid;
				this.yellowPagesServer.Register(description);
			}
		}

		/// <summary>
		/// Modifies the agent description previously registered with the directory facilitator service.
		/// </summary>
		/// <param name="description">description of the services promoted by the agent</param>
		public void Edit(DFAgentDescription description)
		{
			lock(this.yellowPagesServer)
			{
				description.Aid = this.aid;
				this.yellowPagesServer.Edit(description);
			}
		}

		/// <summary>
		/// Deregisters an agent with the directory facilitator service.
		/// </summary>
		public void Deregister()
		{
			lock(this.yellowPagesServer)
			{
				this.yellowPagesServer.Deregister(this.aid);
			}
		}

        /// <summary>
        /// Deregisters an agent with the directory facilitator service.
        /// </summary>
        /// <param name="aid">identifier of the agents whoes description has to be removed</param>
        public void Deregister(AID aid)
        {
            lock (this.yellowPagesServer)
            {
                this.yellowPagesServer.Deregister(aid);
            }
        }

		#endregion

		#region IRuntimeBindable Members
		/// <summary>
		/// Connects the runtime component to the events
		/// originated by the agent instance.
		/// </summary>
		/// <param name="proxy">proxy to the agent instance</param>
		public void BindEvents(IAgentEventProxy proxy)
		{}
		/// <summary>
		/// Disconnects the runtime component to the events
		/// originated by the agent instance.
		/// </summary>
		/// <param name="proxy">proxy to the agent instance</param>
		public void UnbindEvents(IAgentEventProxy proxy)
		{}
		#endregion

	}
}