#region License

/*
 * Copyright © 2002-2005 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#endregion

#region Imports

using System;
using System.Collections;
using Spring.Aop;
using Spring.Context;

#endregion

namespace Spring.Aspects.Cache
{
	/// <summary>
	/// Caching aspect implementation.
	/// </summary>
	/// <remarks>
    /// This class encapsulates all the advisors that need to be configured to support
    /// Spring's full caching functionality.
	/// </remarks>
	/// <see cref="CacheResultAdvisor"/>
	/// <see cref="CacheParameterAdvisor"/>
	/// <see cref="InvalidateCacheAdvisor"/>
    /// <author>Aleksandar Seovic</author>
	public class CacheAspect : IAdvisors, IApplicationContextAware
	{
	    private IAdvisor[] advisors;
	    private IApplicationContext applicationContext;

	    /// <summary>
        /// Creates a new instance.
        /// </summary>
	    public CacheAspect()
	    {
            advisors = new IAdvisor[] { new CacheResultAdvisor(), new CacheParameterAdvisor(), new InvalidateCacheAdvisor() };
	    }

	    /// <summary>
        /// Gets or sets a list of advisors for this aspect.
        /// </summary>
        /// <value>
        /// A list of advisors for this aspect.
        /// </value>
        public IList Advisors
	    {
	        get { return advisors; }
	        set { throw new NotSupportedException("Cache aspect advisors cannot be set externally."); }
	    }

	    /// <summary>
	    /// Sets the <see cref="Spring.Context.IApplicationContext"/> that this
	    /// object runs in.
	    /// </summary>
	    /// <remarks>
	    /// <p>
	    /// Normally this call will be used to initialize the object.
	    /// </p>
	    /// <p>
	    /// Invoked after population of normal object properties but before an
	    /// init callback such as
	    /// <see cref="Spring.Objects.Factory.IInitializingObject"/>'s
	    /// <see cref="Spring.Objects.Factory.IInitializingObject.AfterPropertiesSet"/>
	    /// or a custom init-method. Invoked after the setting of any
	    /// <see cref="Spring.Context.IResourceLoaderAware"/>'s
	    /// <see cref="Spring.Context.IResourceLoaderAware.ResourceLoader"/>
	    /// property.
	    /// </p>
	    /// </remarks>
	    /// <exception cref="Spring.Context.ApplicationContextException">
	    /// In the case of application context initialization errors.
	    /// </exception>
	    /// <exception cref="Spring.Objects.ObjectsException">
	    /// If thrown by any application context methods.
	    /// </exception>
	    /// <exception cref="Spring.Objects.Factory.ObjectInitializationException"/>
	    public IApplicationContext ApplicationContext
	    {
	        set
	        {
	            applicationContext = value;
	            for (int i = 0; i < advisors.Length; i++)
	            {
                    ((IApplicationContextAware) advisors[i]).ApplicationContext = applicationContext;
	            }
	        }
	    }
	}
}