/**
    * Copyright 2005-2015 The Kuali Foundation
    *
    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
    *
   * 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.kuali.rice.krad.web.controller;
  
  import org.kuali.rice.krad.web.bind.UifServletRequestDataBinderFactory;
  import org.springframework.web.method.annotation.ErrorsMethodArgumentResolver;
  import org.springframework.web.method.annotation.ExpressionValueMethodArgumentResolver;
  import org.springframework.web.method.annotation.MapMethodProcessor;
  import org.springframework.web.method.annotation.ModelMethodProcessor;
  import org.springframework.web.method.annotation.RequestHeaderMapMethodArgumentResolver;
  import org.springframework.web.method.annotation.RequestHeaderMethodArgumentResolver;
  import org.springframework.web.method.annotation.RequestParamMapMethodArgumentResolver;
  import org.springframework.web.method.annotation.RequestParamMethodArgumentResolver;
  import org.springframework.web.method.annotation.SessionStatusMethodArgumentResolver;
  import org.springframework.web.method.support.HandlerMethodArgumentResolver;
  import org.springframework.web.method.support.InvocableHandlerMethod;
  import org.springframework.web.servlet.mvc.method.annotation.HttpEntityMethodProcessor;
  import org.springframework.web.servlet.mvc.method.annotation.MatrixVariableMapMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.MatrixVariableMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.PathVariableMapMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.PathVariableMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.RedirectAttributesMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
  import org.springframework.web.servlet.mvc.method.annotation.RequestPartMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor;
  import org.springframework.web.servlet.mvc.method.annotation.ServletCookieValueMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.ServletModelAttributeMethodProcessor;
  import org.springframework.web.servlet.mvc.method.annotation.ServletRequestDataBinderFactory;
  import org.springframework.web.servlet.mvc.method.annotation.ServletRequestMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.ServletResponseMethodArgumentResolver;
  import org.springframework.web.servlet.mvc.method.annotation.UriComponentsBuilderMethodArgumentResolver;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Override of request mapping handler apapter to create a custom binder factory.
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class UifRequestMappingHandlerAdapter extends RequestMappingHandlerAdapter {
  
      /**
       * {@inheritDoc}
       */
      @Override
      protected ServletRequestDataBinderFactory createDataBinderFactory(
              List<InvocableHandlerMethod> binderMethods) throws Exception {
          return new UifServletRequestDataBinderFactory(binderMethods, getWebBindingInitializer());
      }
  
      /**
       * Override to set Uif form argument resolver as first in the list of resolvers.
       *
       * {@inheritDoc}
       */
      @Override
      public void afterPropertiesSet() {
          List<HandlerMethodArgumentResolver> resolvers = getUifArgumentResolvers();
          setArgumentResolvers(resolvers);
  
          super.afterPropertiesSet();
      }
  
      /**
       * Return the list of argument resolvers to use including built-in resolvers
       * and custom resolvers provided via {@link #setCustomArgumentResolvers}.
       */
      protected List<HandlerMethodArgumentResolver> getUifArgumentResolvers() {
          List<HandlerMethodArgumentResolver> resolvers = new ArrayList<HandlerMethodArgumentResolver>();
  
          resolvers.add(new UifDefaultFormMethodArgumentResolver());
  
          // Annotation-based argument resolution
          resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
          resolvers.add(new RequestParamMapMethodArgumentResolver());
          resolvers.add(new PathVariableMethodArgumentResolver());
          resolvers.add(new PathVariableMapMethodArgumentResolver());
          resolvers.add(new MatrixVariableMethodArgumentResolver());
          resolvers.add(new MatrixVariableMapMethodArgumentResolver());
          resolvers.add(new ServletModelAttributeMethodProcessor(false));
          resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters()));
          resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters()));
          resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
          resolvers.add(new RequestHeaderMapMethodArgumentResolver());
          resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
         resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
 
         // Type-based argument resolution
         resolvers.add(new ServletRequestMethodArgumentResolver());
         resolvers.add(new ServletResponseMethodArgumentResolver());
         resolvers.add(new HttpEntityMethodProcessor(getMessageConverters()));
         resolvers.add(new RedirectAttributesMethodArgumentResolver());
         resolvers.add(new ModelMethodProcessor());
         resolvers.add(new MapMethodProcessor());
         resolvers.add(new ErrorsMethodArgumentResolver());
         resolvers.add(new SessionStatusMethodArgumentResolver());
         resolvers.add(new UriComponentsBuilderMethodArgumentResolver());
 
         // Custom arguments
         if (getCustomArgumentResolvers() != null) {
             resolvers.addAll(getCustomArgumentResolvers());
         }
 
         // Catch-all
         resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
         resolvers.add(new ServletModelAttributeMethodProcessor(true));
 
         return resolvers;
     }
 }