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


namespace AgentService.Agent.Runtime
{
	/// <summary>
	/// Class DefaultWhitePagesClient. Implements a default client for the 
	/// white pages service.
	/// </summary>
	public class DefaultWhitePagesClient: AgentService.Agent.Runtime.IWhitePagesClient	
	{
		/// <summary>
		/// Reference to the AID of the owning agent.
		/// </summary>
		private AID aid;

		/// <summary>
		/// Reference to the white pages service.
		/// </summary>
		private IWhitePagesServer whitePagesServer;

		/// <summary>
		/// Constructs a DefaultWhitePagesClient object.
		/// </summary>
		/// <param name="aid">aid of the owning agent</param>
		/// <param name="whitePagesServer">reference to the white pages service</param>
		public DefaultWhitePagesClient(AID aid, IWhitePagesServer whitePagesServer)
		{
			this.aid = aid;
			this.whitePagesServer = whitePagesServer;
		}

		/// <summary>
		/// Searches for all the agents which names satisfy the given regex pattern.
		/// </summary>
		/// <param name="pattern">regular expression pattern that defines the selction criteria</param>
		/// <returns>collection of Agent Description objects</returns>
		public AgentDescription[] Search(string pattern)
		{
			lock(this) 
			{
				return this.whitePagesServer.Search(pattern);
			}
		}

		/// <summary>
		/// Searches for the agent that has the given name.
		/// </summary>
		/// <param name="name">name of the agent to search for</param>
		/// <returns>Agent Description of the agent if found, null otherwise</returns>
		public AgentDescription SearchExact(string name)
		{
			lock(this) 
			{
				return this.whitePagesServer.SearchExact(name);
			}
		}

		#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

	}
}