com.blitline.image.spring.BlitlineConfiguration Maven / Gradle / Ivy

Go to download
package com.blitline.image.spring;

import java.util.ArrayList;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;
import org.springframework.context.annotation.FilterType;
import org.springframework.context.annotation.PropertySource;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import com.blitline.image.spring.postback.BlitlinePostbackUrlProvider;
import com.blitline.image.spring.postback.BlitlinePostbackUrlProviders;
import com.blitline.image.spring.web.BlitlinePostbackController;
import com.blitline.image.spring.web.BlitlinePostbackHttpMessageConverter;

/**
 * This class provides Spring beans that configure a working Blitline client
 * setup from properties. Blitline's JSON syntax requires some custom setup
 * for the JSON serialization, and qualified instances of type converters
 * are provided here.
 *
 * @author Christopher Smith
 *
 */
@Configuration
@ComponentScan(excludeFilters =
	@Filter(type = FilterType.ASSIGNABLE_TYPE, value = BlitlinePostbackController.class))
@PropertySource(value = "classpath:/blitline.properties", ignoreResourceNotFound = true)
@DependsOn("blitlineObjectMapperHolder")
public class BlitlineConfiguration {

	/**
	 * This field is not constructor-injected because Spring throws a tantrum if an {@code @Configuration} class does not have a
	 * default constructor. Reasonably safe since this class is the one causing the component-scan that picks it up, and any
	 * problems with it need to fail the JUnit tests hard.
	 */
	@Autowired
	private BlitlineObjectMapperHolder objectMapperHolder;

	/**
	 * A {@link RestTemplate} instance configured with a single message converter conforming to the Blitline API syntax.
	 *
	 * @return a Blitline-compatible {@code RestTemplate}
	 */
	@Bean
	@BlitlineApi
	public RestTemplate blitlineRestTemplate() {
		MappingJackson2HttpMessageConverter blitlineConverter = new MappingJackson2HttpMessageConverter();
		blitlineConverter.setObjectMapper(objectMapperHolder.getMapper());

		List> l = new ArrayList>(1);
		l.add(blitlineConverter);

		return new RestTemplate(l);
	}

	/**
	 * Adds a postback-URL provider if a URL is available via the property.
	 */
	@Conditional(BlitlinePostbackUrlProviders.PropertyCondition.class)
	@Configuration
	public static class BlitlinePostbackUrlConfiguration {
		@Value("${" + BlitlinePostbackUrlProviders.POSTBACK_URL_PROPERTY + "}")
		private String postbackUrl;

		@Bean
		public BlitlinePostbackUrlProvider blitlinePropertyBasedUrl() {
			return BlitlinePostbackUrlProviders.fixedUrl(postbackUrl);
		}
	}

	@Configuration
	public static class BlitlineHttpMessageConverterConfiguration extends WebMvcConfigurerAdapter {
	    @Autowired
	    private BlitlinePostbackHttpMessageConverter blitlinePostbackConverter;

	    @Override
	    public void extendMessageConverters(List> converters) {
	        converters.add(0, blitlinePostbackConverter);
	    }
	}
}