EDIT

// $Id$

/**

* Copyright (C) 2014 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package org.bgbm.utis.configuration;

import java.util.ArrayList;

import java.util.List;

import java.util.Locale;

import javax.servlet.ServletContext;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import org.bgbm.utis.jackson.ClassificationMixIn;

import org.cybertaxonomy.utis.tnr.msg.Classification;

import org.cybertaxonomy.utis.tnr.msg.TnrMsg;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import org.springframework.http.MediaType;

import org.springframework.oxm.jaxb.Jaxb2Marshaller;

import org.springframework.web.accept.ContentNegotiationManager;

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

import org.springframework.web.servlet.View;

import org.springframework.web.servlet.ViewResolver;

import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;

import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import org.springframework.web.servlet.view.ContentNegotiatingViewResolver;

import org.springframework.web.servlet.view.InternalResourceViewResolver;

import org.springframework.web.servlet.view.XmlViewResolver;

import org.springframework.web.servlet.view.json.MappingJacksonJsonView;

import org.springframework.web.servlet.view.xml.MarshallingView;

import com.mangofactory.swagger.configuration.SpringSwaggerConfig;

import com.mangofactory.swagger.plugin.EnableSwagger;

import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;

import com.wordnik.swagger.model.ApiInfo;

/**

 * @author a.kohlbecker

 * @date Jul 1, 2014

 *

 */

@Configuration

@EnableWebMvc

@ComponentScan(basePackages = {

        "com.mangofactory.swagger.configuration.SpringSwaggerConfig",

        "com.mangofactory.swagger.controllers",

        "org.bgbm.utis.controller"

        })

@EnableSwagger

public class SpringMVCConfig extends WebMvcConfigurerAdapter {

    public static final String[] WEB_JAR_RESOURCE_PATTERNS = {"css/", "images/", "lib/", "swagger-ui.js"};

    public static final String WEB_JAR_RESOURCE_LOCATION = "classpath:META-INF/resources/";

    public static final String WEB_JAR_VIEW_RESOLVER_PREFIX = "classpath:/resources/";

    public static final String WEB_JAR_VIEW_RESOLVER_SUFFIX = ".jsp";

    private static final Logger log = LogManager.getLogger(SpringMVCConfig.class.getName());

    @Autowired

    protected ServletContext servletContext;

    private SpringSwaggerConfig springSwaggerConfig;

    @Override

    public void addResourceHandlers(ResourceHandlerRegistry registry) {

      registry.addResourceHandler(WEB_JAR_RESOURCE_PATTERNS)

              .addResourceLocations("/")

              .addResourceLocations(WEB_JAR_RESOURCE_LOCATION).setCachePeriod(0);

    }

    @Bean

    public InternalResourceViewResolver getInternalResourceViewResolver() {

      InternalResourceViewResolver resolver = new InternalResourceViewResolver();

      resolver.setPrefix(WEB_JAR_VIEW_RESOLVER_PREFIX);

      resolver.setSuffix(WEB_JAR_VIEW_RESOLVER_SUFFIX);

      return resolver;

    }

    @Override

    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {

      configurer.enable();

    }

    @Override

    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {

        configurer.favorPathExtension(true).favorParameter(false)

        .defaultContentType(MediaType.APPLICATION_JSON)

        .mediaType("xml", MediaType.APPLICATION_XML)

        .mediaType("json", MediaType.APPLICATION_JSON);

    }

    /**

     * Create the CNVR.  Specify the view resolvers to use explicitly.  Get Spring to inject

     * the ContentNegotiationManager created by the configurer (see previous method).

     */

   @Bean

   public ViewResolver contentNegotiatingViewResolver(ContentNegotiationManager manager) {

       log.info("CNVR");

     // Define the view resolvers

       List<ViewResolver> resolvers = new ArrayList<ViewResolver>();

//       resolvers.add(getXmlViewResolver());

       resolvers.add(getJsonViewResolver());

       resolvers.add(getMarshallingXmlViewResolver());

       ContentNegotiatingViewResolver resolver = new ContentNegotiatingViewResolver();

       resolver.setContentNegotiationManager(manager);

       resolver.setViewResolvers(resolvers);

       return resolver;

   }

    private ViewResolver getXmlViewResolver() {

        XmlViewResolver resolver = new XmlViewResolver();

        resolver.setLocation(new ServletContextResource(servletContext, "/WEB-INF/views.xml"));

        return resolver;

    }

    private ViewResolver getJsonViewResolver() {

        return new ViewResolver() {

            /**

             * Get the view to use.

             *

             * @return Always returns an instance of

             *         {@link MappingJacksonJsonView}.

             */

            @Override

            public View resolveViewName(String viewName, Locale locale) throws Exception {

                MappingJacksonJsonView view = new MappingJacksonJsonView();

                view.setPrettyPrint(true);

                view.getObjectMapper().getSerializationConfig()

                        .addMixInAnnotations(Classification.class, ClassificationMixIn.class);

                return view;

            }

        };

    }

   /**

    * @return

    */

   private ViewResolver getMarshallingXmlViewResolver() {

       final Jaxb2Marshaller marshaller = new Jaxb2Marshaller();

       marshaller.setPackagesToScan(new String[]{TnrMsg.class.getPackage().getName()});

       return new ViewResolver() {

        @Override

        public View resolveViewName(String viewName, Locale locale) throws Exception {

            MarshallingView view = new MarshallingView();

            view.setMarshaller(marshaller);

            return view;

        }

       };

   }

    // -------- Swagger configuration ------------ //

   /**

    * Required to autowire SpringSwaggerConfig

    */

   @Autowired

   public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {

      this.springSwaggerConfig = springSwaggerConfig;

   }

   /**

    * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc framework - allowing for multiple

    * swagger groups i.e. same code base multiple swagger resource listings.

    */

   @Bean

   public SwaggerSpringMvcPlugin customImplementation(){

       // includePatterns: If not supplied a single pattern ".*?" is used by SwaggerSpringMvcPlugin

       // which matches anything and hence all RequestMappings. Here we define it explicitly

      return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)

              .apiInfo(apiInfo()).

              includePatterns(".*?");

   }

   private ApiInfo apiInfo() {

     ApiInfo apiInfo = new ApiInfo("EU BON UTIS",

            "The Unified Taxonomic Information Service (UTIS) is the taxonomic backbone for the EU-BON project",

            "https://www.biodiversitycatalogue.org/services/79", "EditSupport@bgbm.org",

            "Mozilla Public License 2.0", "http://www.mozilla.org/MPL/2.0/");

     return apiInfo;

   }

}