com.k2.core.DispatcherServletConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of k2-core Show documentation
The newest version!
/* vim: set et ts=2 sw=2 cindent fo=qroca: */

package com.k2.core;

import org.springframework.web.servlet.config.annotation
    .ResourceHandlerRegistration;
import org.springframework.web.servlet.config.annotation
    .ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation
    .WebMvcConfigurationSupport;
import org.springframework.web.servlet.mvc.method.annotation
    .RequestMappingHandlerAdapter;
import org.springframework.web.servlet.mvc.method.annotation
    .RequestMappingHandlerMapping;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support
    .PropertySourcesPlaceholderConfigurer;
import org.springframework.format.FormatterRegistry;
import org.springframework.format.datetime.standard.DateTimeFormatterRegistrar;
import org.springframework.http.converter.HttpMessageConverter;

/** Custom configuration for the dispatcher servlet application context
 *
 * K2 uses this configuration to initialize the dispatcher servlet if the
 * application runs in a web environment.
 *
 * @see com.k2.core.Application#setWebEnvironment(boolean)
 */
@Configuration
public class DispatcherServletConfiguration extends WebMvcConfigurationSupport {

  /** Whether the application is loaded in debug modue or not.
   *
   * Injected by spring.
   *
   * NOTE: Avoid @Value in attributes as plague in your code. I could not
   * find another way, given that this is used in an overriden operation from
   * WebMvcConfigurationSupport.
   */
  @Value(value = "${debug:false}") private boolean debug;

  /** The module definition that owns the DispatcherServlet of this
   * configuration.
   *
   * Injected by spring, never null after wired.
   *
   * NOTE: Avoid Autowired in attributes as plague in your code. I could not
   * find another way, given that this is used in an overriden operation from
   * WebMvcConfigurationSupport.
   */
  @Autowired private ModuleDefinition moduleDefinition;

  /** Defines a handler mapping to look for handlers in the current
   * application context and its parent.
   *
   * @return a properly configured handler mapping. Never returns null.
   */
  @Override
  protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() {
    RequestMappingHandlerMapping result = new RequestMappingHandlerMapping();
    result.setDetectHandlerMethodsInAncestorContexts(true);
    return result;
  }

  /** A handler adapter bean that can be configured with the message converters
   * found in the application context hierarchy.
   *
   * If there is at least one message converter up in the application context
   * hierarchy, this bean will override the default message converters for the
   * handler adapter.
   *
   * @param converters a list of message converters. If empty, the handler
   * adapter uses the default converters (see WebMvcConfigurationSupport).
   *
   * @return a RequestMappingHandlerAdapter configured with any message
   * converter found in the application context. Never returns null.
   */
  @Bean
  public RequestMappingHandlerAdapter requestMappingHandlerAdapter(
      final List> converters) {
    RequestMappingHandlerAdapter adapter;
    adapter = super.requestMappingHandlerAdapter();

    if (!converters.isEmpty()) {
      adapter.setMessageConverters(converters);
    }
    return adapter;
  }

  /** Registers handlers that serve the module static content.
   */
  @Override
  protected void addResourceHandlers(final ResourceHandlerRegistry registry) {
    ResourceHandlerRegistration reg;
    reg = registry.addResourceHandler("/static/**");
    if (debug && moduleDefinition.getRelativePath() != null) {
      reg.addResourceLocations("file:" + moduleDefinition.getRelativePath()
          + "/" + moduleDefinition.getStaticPath());
    }
    reg.addResourceLocations("classpath:" + moduleDefinition.getStaticPath());
  }

  /** Bean to resolve @Value from k2 environment.
   *
   * @return a place holder configurer, to resolve @Value. Never returns null.
   */
  @Bean
  public static PropertySourcesPlaceholderConfigurer propertyConfigIn() {
    return new PropertySourcesPlaceholderConfigurer();
  }

  /** Configure the date time formatter to support iso conventions, if it is
   * configured so.
   *
   * To use iso format, set the property k2.mvc.use-iso-format to true.
   *
   * Implementation note: this looks for the property in the parent context
   * environment. This lets modules independently set the iso flag, by
   * configuring in its own private properties file.
   *
   * {@inheritDoc}
   */
  @Override
  protected void addFormatters(final FormatterRegistry registry) {
    ApplicationContext parent = getApplicationContext().getParent();
    boolean useIsoFormat = parent.getEnvironment().getProperty(
        "k2.mvc.use-iso-format", Boolean.class, false);
    if (useIsoFormat) {
      DateTimeFormatterRegistrar r = new DateTimeFormatterRegistrar();
      r.setUseIsoFormat(true);
      r.registerFormatters(registry);
    }
  }
}