com.netflix.genie.web.configs

Class GenieApiAutoConfiguration

java.lang.Object

com.netflix.genie.web.configs.GenieApiAutoConfiguration

@Configuration
 @EnableConfigurationProperties(value={HttpProperties.class,RetryProperties.class})
public class GenieApiAutoConfiguration
extends java.lang.Object

Configuration for Spring MVC REST API tier.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
GenieApiAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
AgentFileProtocolResolver	agentFileProtocolResolver(AgentFileStreamService agentFileStreamService) Protocol resolver agent file resources.
AgentFileProtocolResolverRegistrar	agentFileProtocolResolverRegistrar(AgentFileProtocolResolver agentFileProtocolResolver) Registrar for the AgentFileProtocolResolver.
org.springframework.web.filter.CharacterEncodingFilter	characterEncodingFilter() Character encoding filter that forces content-type in response to be UTF-8.
DirectoryWriter	directoryWriter() Get the directory writer to use.
GenieHostInfo	genieHostInfo() Get the GenieHostInfo for this application.
org.springframework.web.client.RestTemplate	genieRestTemplate(HttpProperties httpProperties, org.springframework.boot.web.client.RestTemplateBuilder restTemplateBuilder) Get RestTemplate for calling between Genie nodes.
org.springframework.retry.support.RetryTemplate	genieRetryTemplate(RetryProperties retryProperties) Get RetryTemplate.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenieApiAutoConfiguration

public GenieApiAutoConfiguration()

Method Detail

resourceLoader

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

Get a resource loader.

Returns:

a DefaultResourceLoader

genieHostInfo

@Bean
 @ConditionalOnMissingBean(value=GenieHostInfo.class)
public GenieHostInfo genieHostInfo()
                                                                                        throws java.net.UnknownHostException

Get the GenieHostInfo for this application. This is the default fallback implementation if no other bean instance of this type has been created.

Returns:

The hostname calculated from InetAddress

Throws:

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

java.lang.IllegalStateException - When an instance can't be created

See Also:

InetAddress.getCanonicalHostName()

genieRestTemplate

@Bean
 @ConditionalOnMissingBean(name="genieRestTemplate")
public org.springframework.web.client.RestTemplate genieRestTemplate(HttpProperties httpProperties,
                                                                                                                                org.springframework.boot.web.client.RestTemplateBuilder restTemplateBuilder)

Get RestTemplate for calling between Genie nodes.

Parameters:

httpProperties - The properties related to Genie's HTTP client configuration

restTemplateBuilder - The Spring REST template builder to use

Returns:

The rest template to use

genieRetryTemplate

@Bean
 @ConditionalOnMissingBean(name="genieRetryTemplate")
public org.springframework.retry.support.RetryTemplate genieRetryTemplate(RetryProperties retryProperties)

Get RetryTemplate.

Parameters:

retryProperties - The http retry properties to use

Returns:

The retry template to use

directoryWriter

@Bean
 @ConditionalOnMissingBean(value=DirectoryWriter.class)
public DirectoryWriter directoryWriter()

Get the directory writer to use.

Returns:

A default directory writer

jobsDir

@Bean
 @ConditionalOnMissingBean(name="jobsDir",
                          value=org.springframework.core.io.Resource.class)
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

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

agentFileProtocolResolver

@Bean
 @ConditionalOnMissingBean(value=AgentFileProtocolResolver.class)
public AgentFileProtocolResolver agentFileProtocolResolver(AgentFileStreamService agentFileStreamService)

Protocol resolver agent file resources.

Parameters:

agentFileStreamService - the agent file stream service

Returns:

a AgentFileProtocolResolver

agentFileProtocolResolverRegistrar

@Bean
 @ConditionalOnMissingBean(value=AgentFileProtocolResolverRegistrar.class)
public AgentFileProtocolResolverRegistrar agentFileProtocolResolverRegistrar(AgentFileProtocolResolver agentFileProtocolResolver)

Registrar for the AgentFileProtocolResolver.

Parameters:

agentFileProtocolResolver - a protocol AgentFileProtocolResolver to register

Returns:

a AgentFileProtocolResolverRegistrar