Package com.netflix.genie.web.spring.autoconfigure.services

Class ServicesAutoConfiguration

java.lang.Object

com.netflix.genie.web.spring.autoconfigure.services.ServicesAutoConfiguration

@Configuration
@EnableConfigurationProperties({JobsForwardingProperties.class,JobsLocationsProperties.class,JobsMemoryProperties.class,JobsUsersProperties.class,JobsActiveLimitProperties.class,AttachmentServiceProperties.class})
public class ServicesAutoConfiguration
extends Object

Configuration for all the services.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
ServicesAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
ArchivedJobServiceImpl	archivedJobService(DataServices dataServices, org.springframework.core.io.ResourceLoader resourceLoader, io.micrometer.core.instrument.MeterRegistry meterRegistry)	Provide a ArchivedJobService implementation if one hasn't been provided already.
AttachmentService	attachmentService(S3ClientFactory s3ClientFactory, AttachmentServiceProperties attachmentServiceProperties, io.micrometer.core.instrument.MeterRegistry meterRegistry)	The attachment service to use.
JobDirectoryServerServiceImpl	jobDirectoryServerService(org.springframework.core.io.ResourceLoader resourceLoader, DataServices dataServices, AgentFileStreamService agentFileStreamService, ArchivedJobService archivedJobService, io.micrometer.core.instrument.MeterRegistry meterRegistry, AgentRoutingService agentRoutingService)	Provide the default implementation of JobDirectoryServerService for serving job directory resources.
JobLaunchServiceImpl	jobLaunchService(DataServices dataServices, JobResolverService jobResolverService, AgentLauncherSelector agentLauncherSelector, BraveTracingComponents tracingComponents, io.micrometer.core.instrument.MeterRegistry registry)	Provide a JobLaunchService implementation if one isn't available.
JobResolutionProperties	jobResolutionProperties(org.springframework.core.env.Environment environment)	Provide a bean for JobResolutionProperties which encapsulates defaults and other values set by external configuration related to job resolution.
JobResolverServiceImpl	jobResolverService(DataServices dataServices, @NotEmpty List<ClusterSelector> clusterSelectors, CommandSelector commandSelector, io.micrometer.core.instrument.MeterRegistry registry, JobsProperties jobsProperties, JobResolutionProperties jobResolutionProperties, BraveTracingComponents tracingComponents)	Get an implementation of JobResolverService if one hasn't already been defined.
JobsProperties	jobsProperties(JobsForwardingProperties forwarding, JobsLocationsProperties locations, JobsMemoryProperties memory, JobsUsersProperties users, JobsActiveLimitProperties activeLimit)	Collection of properties related to job execution.
RequestForwardingServiceImpl	requestForwardingService(org.springframework.web.client.RestTemplate genieRestTemplate, GenieHostInfo hostInfo, JobsForwardingProperties jobsForwardingProperties)	Provide a default implementation of RequestForwardingService for use by other services.

Methods inherited from class java.lang.Object

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

Constructor Details

ServicesAutoConfiguration

public ServicesAutoConfiguration()

Method Details

jobResolutionProperties

@Bean
public JobResolutionProperties jobResolutionProperties(org.springframework.core.env.Environment environment)

Provide a bean for JobResolutionProperties which encapsulates defaults and other values set by external configuration related to job resolution.

Parameters:

environment - The application Environment

Returns:

A JobResolutionProperties instance which will refresh itself in the background

jobsProperties

@Bean
public JobsProperties jobsProperties(JobsForwardingProperties forwarding,
 JobsLocationsProperties locations,
 JobsMemoryProperties memory,
 JobsUsersProperties users,
 JobsActiveLimitProperties activeLimit)

Collection of properties related to job execution.

Parameters:

forwarding - forwarding properties

locations - locations properties

memory - memory properties

users - users properties

activeLimit - active limit properties

Returns:

a JobsProperties instance

attachmentService

@Bean
@ConditionalOnMissingBean(AttachmentService.class)
public AttachmentService attachmentService(S3ClientFactory s3ClientFactory,
 AttachmentServiceProperties attachmentServiceProperties,
 io.micrometer.core.instrument.MeterRegistry meterRegistry)
                                    throws IOException

The attachment service to use.

Parameters:

s3ClientFactory - the S3 client factory

attachmentServiceProperties - the service properties

meterRegistry - the meter registry

Returns:

The attachment service to use

Throws:

IOException - if the local filesystem implmentation is used and it fails to initialize

jobResolverService

@Bean
@ConditionalOnMissingBean(JobResolverService.class)
public JobResolverServiceImpl jobResolverService(DataServices dataServices,
 @NotEmpty
 @NotEmpty List<ClusterSelector> clusterSelectors,
 CommandSelector commandSelector,
 io.micrometer.core.instrument.MeterRegistry registry,
 JobsProperties jobsProperties,
 JobResolutionProperties jobResolutionProperties,
 BraveTracingComponents tracingComponents)

Get an implementation of JobResolverService if one hasn't already been defined.

Parameters:

dataServices - The DataServices encapsulation instance to use

clusterSelectors - The ClusterSelector implementations to use

commandSelector - The CommandSelector implementation to use

registry - The metrics repository to use

jobsProperties - The properties for running a job set by the user

jobResolutionProperties - The JobResolutionProperties instance

tracingComponents - The BraveTracingComponents to use

Returns:

A JobResolverServiceImpl instance

jobDirectoryServerService

@Bean
@ConditionalOnMissingBean(JobDirectoryServerService.class)
public JobDirectoryServerServiceImpl jobDirectoryServerService(org.springframework.core.io.ResourceLoader resourceLoader,
 DataServices dataServices,
 AgentFileStreamService agentFileStreamService,
 ArchivedJobService archivedJobService,
 io.micrometer.core.instrument.MeterRegistry meterRegistry,
 AgentRoutingService agentRoutingService)

Provide the default implementation of JobDirectoryServerService for serving job directory resources.

Parameters:

resourceLoader - The application resource loader used to get references to resources

dataServices - The DataServices instance to use

agentFileStreamService - The service to request a file from an agent running a job

archivedJobService - The ArchivedJobService implementation to use to get archived job data

meterRegistry - The meter registry used to keep track of metrics

agentRoutingService - The agent routing service

Returns:

An instance of JobDirectoryServerServiceImpl

jobLaunchService

@Bean
@ConditionalOnMissingBean(JobLaunchService.class)
public JobLaunchServiceImpl jobLaunchService(DataServices dataServices,
 JobResolverService jobResolverService,
 AgentLauncherSelector agentLauncherSelector,
 BraveTracingComponents tracingComponents,
 io.micrometer.core.instrument.MeterRegistry registry)

Provide a JobLaunchService implementation if one isn't available.

Parameters:

dataServices - The DataServices instance to use

jobResolverService - The JobResolverService implementation to use

agentLauncherSelector - The AgentLauncherSelector implementation to use

tracingComponents - The BraveTracingComponents instance to use

registry - The metrics registry to use

Returns:

A JobLaunchServiceImpl instance

archivedJobService

@Bean
@ConditionalOnMissingBean(ArchivedJobService.class)
public ArchivedJobServiceImpl archivedJobService(DataServices dataServices,
 org.springframework.core.io.ResourceLoader resourceLoader,
 io.micrometer.core.instrument.MeterRegistry meterRegistry)

Provide a ArchivedJobService implementation if one hasn't been provided already.

Parameters:

dataServices - The DataServices instance to use

resourceLoader - The ResourceLoader to use

meterRegistry - The MeterRegistry implementation to use

Returns:

A ArchivedJobServiceImpl instance

requestForwardingService

@Bean
@ConditionalOnMissingBean(RequestForwardingService.class)
public RequestForwardingServiceImpl requestForwardingService(@Qualifier("genieRestTemplate")
 org.springframework.web.client.RestTemplate genieRestTemplate,
 GenieHostInfo hostInfo,
 JobsForwardingProperties jobsForwardingProperties)

Provide a default implementation of RequestForwardingService for use by other services.

Parameters:

genieRestTemplate - The RestTemplate configured to be used to call other Genie nodes

hostInfo - The GenieHostInfo instance containing introspection information about the current node

jobsForwardingProperties - The properties for forwarding requests between Genie nodes

Returns:

A RequestForwardingServiceImpl instance