/*

  * Copyright 2004-2010 the Seasar Foundation and the Others.

  *

  * 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.

  */

 package org.seasar.cubby.plugins.spring;

 import javax.servlet.ServletContext;

 import org.seasar.cubby.plugin.AbstractPlugin;

 import org.seasar.cubby.spi.BeanDescProvider;

 import org.seasar.cubby.spi.ContainerProvider;

 import org.seasar.cubby.spi.ConverterProvider;

 import org.seasar.cubby.spi.PathResolverProvider;

 import org.seasar.cubby.spi.Provider;

 import org.seasar.cubby.spi.RequestParserProvider;

 import org.springframework.beans.factory.BeanFactoryUtils;

 import org.springframework.context.ApplicationContext;

 import org.springframework.web.context.ContextLoader;

 import org.springframework.web.context.ContextLoaderListener;

 import org.springframework.web.context.request.RequestContextListener;

 import org.springframework.web.context.support.WebApplicationContextUtils;

 /**

  * Cubby を <a href="http://www.springsource.org/">Spring Framework</a>

  * に統合するためのプラグインです。

  * 

  * <p>

  * アプリケーションが使用する XML ファイルを WEB 配備記述子の初期化パラメータ

  * {@value ContextLoader#CONFIG_LOCATION_PARAM} に指定してください。 また、

  * {@link ContextLoaderListener} と {@link RequestContextListener} をリスナに設定してください。

  * </p>

  * 

  * <p>

  * 例

  * 

  * <pre>

  * <context-param>

  *   <param-name>{@value ContextLoader#CONFIG_LOCATION_PARAM}</paanm-name>

  *   <param-value>/WEB-INF/classes/applicationContext.xml</param-value>

  * </context-param>

  * 

  * <listener>

  *   <listener-class>org.springframework.web.context.ContextLoaderListener<listener-class>

  * </listener>

  * 

  * <listener>

  *   <listener-class>org.springframework.web.context.request.RequestContextListener<listener-class>

  * </listener>

  * </pre>

  * 

  * </p>

  * 

  * <p>

  * このプラグインが提供するプロバイダは以下の通りです。

  * <ul>

  * <li>{@link BeanDescProvider}</li>

  * <li>{@link ContainerProvider}</li>

  * <li>{@link RequestParserProvider}</li>

  * <li>{@link PathResolverProvider}</li>

  * <li>{@link ConverterProvider}</li>

  * </ul>

  * </p>

  * 

  * @author suzuki-kei

  * @author someda

  * 

  * @see <a

  *      href="http://static.springframework.org/spring/docs/2.5.x/reference/beans.html#context-create">Convenient

  *      ApplicationContext instantiation for web applications</a>

  * 

  * @since 2.0.0

  */

 public class SpringPlugin extends AbstractPlugin {

         private ApplicationContext applicationContext;

         /**

          * インスタンス化します。

          */

         public SpringPlugin() {

                 support(BeanDescProvider.class);

                 support(ContainerProvider.class);

                 support(RequestParserProvider.class);

                 support(PathResolverProvider.class);

                 support(ConverterProvider.class);

         }

         /**

          * {@inheritDoc}

          */

         @Override

         public void initialize(final ServletContext servletContext)

                         throws Exception {

                 super.initialize(servletContext);

                 this.applicationContext = WebApplicationContextUtils

                                 .getRequiredWebApplicationContext(servletContext);

         }

         /**

          * {@inheritDoc}

          */

         @Override

         public <S extends Provider> S getProvider(final Class<S> service) {

                 if (this.isSupport(service)) {

                         final String[] names = BeanFactoryUtils

                                         .beanNamesForTypeIncludingAncestors(applicationContext,

                                                         service);

                         return service.cast(applicationContext.getBean(names[0]));

                 } else {

                         return null;

                 }

         }

 }