com.netflix.genie.web.configs

Class MvcConfig

java.lang.Object

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

com.netflix.genie.web.configs.MvcConfig

All Implemented Interfaces:

org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@Configuration
public class MvcConfig
extends org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

Configuration for Spring MVC.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
MvcConfig()

Method Summary

Modifier and Type	Method and Description
org.springframework.web.filter.CharacterEncodingFilter	characterEncodingFilter() Character encoding filter that forces content-type in response to be UTF-8.
void	configurePathMatch(org.springframework.web.servlet.config.annotation.PathMatchConfigurer configurer)
DirectoryWriter	directoryWriter() Get the directory writer to use.
GenieResourceHttpRequestHandler	genieResourceHttpRequestHandler(DirectoryWriter directoryWriter, org.springframework.context.ApplicationContext context, org.springframework.core.io.Resource jobsDir) Get a static resource handler for Genie Jobs.
java.lang.String	hostName() Get the hostname for this application.
org.springframework.core.io.Resource	jobsDir(org.springframework.core.io.ResourceLoader resourceLoader, JobsProperties jobsProperties) Get the jobs dir as a Spring Resource.
org.springframework.core.io.ResourceLoader	resourceLoader() Get a resource loader.
org.springframework.web.client.RestTemplate	restTemplate(int httpConnectTimeout, int httpReadTimeout) Get RestTemplate for calling between Genie nodes.
org.springframework.retry.support.RetryTemplate	retryTemplate(int noOfRetries, int initialInterval, int maxInterval) Get RetryTemplate.

Methods inherited from class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MvcConfig

public MvcConfig()

Method Detail

configurePathMatch

public void configurePathMatch(org.springframework.web.servlet.config.annotation.PathMatchConfigurer configurer)

Turn off . recognition in paths. Needed due to Job id's in paths potentially having '.' as character.

Specified by:

configurePathMatch in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Overrides:

configurePathMatch in class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

See Also:

Stack Overflow Issue Answer From Dave Syer

resourceLoader

@Bean
 @ConditionalOnMissingBean
public org.springframework.core.io.ResourceLoader resourceLoader()

Get a resource loader.

Returns:

a DefaultResourceLoader

hostName

@Bean
 @ConditionalOnMissingBean
public java.lang.String hostName()
                                                           throws java.net.UnknownHostException

Get the hostname for this application. This is the default fallback implementation if no other bean with id hostname has been created by another profile.

Returns:

The hostname calculated from InetAddress

Throws:

java.net.UnknownHostException - When the host can't be calculated

See Also:

InetAddress.getCanonicalHostName()

restTemplate

@Bean(name="genieRestTemplate")
public org.springframework.web.client.RestTemplate restTemplate(@Value(value="${genie.http.connect.timeout:2000}")
                                                                                                int httpConnectTimeout,
                                                                                                @Value(value="${genie.http.read.timeout:10000}")
                                                                                                int httpReadTimeout)

Get RestTemplate for calling between Genie nodes.

Parameters:

httpConnectTimeout - http connection timeout in milliseconds

httpReadTimeout - http read timeout in milliseconds

Returns:

The rest template to use

retryTemplate

@Bean(name="genieRetryTemplate")
public org.springframework.retry.support.RetryTemplate retryTemplate(@Value(value="${genie.retry.noOfRetries:5}")
                                                                                                      int noOfRetries,
                                                                                                      @Value(value="${genie.retry.initialInterval:10000}")
                                                                                                      int initialInterval,
                                                                                                      @Value(value="${genie.retry.maxInterval:60000}")
                                                                                                      int maxInterval)

Get RetryTemplate.

Parameters:

noOfRetries - number of retries

initialInterval - initial interval for the back-off policy

maxInterval - maximum interval for the back-off policy

Returns:

The retry template to use

directoryWriter

@Bean
 @ConditionalOnMissingBean
public DirectoryWriter directoryWriter()

Get the directory writer to use.

Returns:

A default directory writer

jobsDir

@Bean
 @ConditionalOnMissingBean
public org.springframework.core.io.Resource jobsDir(org.springframework.core.io.ResourceLoader resourceLoader,
                                                                                     JobsProperties jobsProperties)
                                                                              throws java.io.IOException

Get the jobs dir as a Spring Resource. Will create if it doesn't exist.

Parameters:

resourceLoader - The resource loader to use

jobsProperties - The jobs properties to use

Returns:

The job dir as a resource

Throws:

java.io.IOException - on error reading or creating the directory

genieResourceHttpRequestHandler

@Bean
 @ConditionalOnMissingBean
public GenieResourceHttpRequestHandler genieResourceHttpRequestHandler(DirectoryWriter directoryWriter,
                                                                                                        org.springframework.context.ApplicationContext context,
                                                                                                        org.springframework.core.io.Resource jobsDir)

Get a static resource handler for Genie Jobs.

Parameters:

directoryWriter - The directory writer to use for converting directory resources

context - The spring application context

jobsDir - The location the user is requesting the jobs be stored

Returns:

The genie resource http request handler.

characterEncodingFilter

@Bean
public org.springframework.web.filter.CharacterEncodingFilter characterEncodingFilter()

Character encoding filter that forces content-type in response to be UTF-8.

Returns:

The encoding filter