com.netflix.genie.web.spring.autoconfigure.jobs

Class JobsAutoConfiguration

java.lang.Object

com.netflix.genie.web.spring.autoconfigure.jobs.JobsAutoConfiguration

@Configuration
 @EnableConfigurationProperties(value=S3FileTransferProperties.class)
public class JobsAutoConfiguration
extends java.lang.Object

Configuration for Jobs Setup and Run.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
JobsAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
ApplicationTask	applicationProcessorTask(io.micrometer.core.instrument.MeterRegistry registry, GenieFileTransferService fts) Create an Application Task bean that processes all Applications needed for a job.
ClusterTask	clusterProcessorTask(io.micrometer.core.instrument.MeterRegistry registry, GenieFileTransferService fts) Create an Cluster Task bean that processes the cluster needed for a job.
CommandTask	commandProcessorTask(io.micrometer.core.instrument.MeterRegistry registry, GenieFileTransferService fts) Create an Command Task bean that processes the command needed for a job.
HttpFileTransferImpl	httpFileTransfer(org.springframework.web.client.RestTemplate restTemplate, io.micrometer.core.instrument.MeterRegistry registry) Bean to create a http[s] file transfer object.
InitialSetupTask	initialSetupTask(io.micrometer.core.instrument.MeterRegistry registry) Create an setup Task bean that does initial setup before any of the tasks start.
JobKickoffTask	jobKickoffTask(JobsProperties jobsProperties, org.apache.commons.exec.Executor executor, GenieHostInfo genieHostInfo, io.micrometer.core.instrument.MeterRegistry registry) Create an Job Kickoff Task bean that runs the job.
JobFailureAndKillHandlerLogicTask	jobKillLogicTask(io.micrometer.core.instrument.MeterRegistry registry) Create a task that adds logic to handle kill requests to a job.
JobTask	jobProcessorTask(AttachmentService attachmentService, io.micrometer.core.instrument.MeterRegistry registry, GenieFileTransferService fts) Create an Job Task bean that processes Job information provided by user.
LocalFileTransferImpl	localFileTransfer() Bean to create a local file transfer object.
ProcessChecker.Factory	processCheckerFactory(org.apache.commons.exec.Executor executor, JobsProperties jobsProperties) Create a ProcessChecker.Factory suitable for UNIX systems.
S3FileTransferImpl	s3FileTransferImpl(S3ClientFactory s3ClientFactory, io.micrometer.core.instrument.MeterRegistry registry, S3FileTransferProperties s3FileTransferProperties) Returns a bean which has an s3 implementation of the File Transfer interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsAutoConfiguration

public JobsAutoConfiguration()

Method Detail

localFileTransfer

@Bean(name={"file.system.file","file.system.null"})
 @Order(value=2)
 @ConditionalOnMissingBean(value=LocalFileTransferImpl.class)
public LocalFileTransferImpl localFileTransfer()

Bean to create a local file transfer object.

Returns:

A unix copy implementation of the FileTransferService.

httpFileTransfer

@Bean(name={"file.system.http","file.system.https"})
 @Order(value=3)
 @ConditionalOnMissingBean(value=HttpFileTransferImpl.class)
public HttpFileTransferImpl httpFileTransfer(org.springframework.web.client.RestTemplate restTemplate,
                                                                                                                                                                                io.micrometer.core.instrument.MeterRegistry registry)

Bean to create a http[s] file transfer object.

Parameters:

restTemplate - The rest template to use

registry - The registry to use for metrics

Returns:

A http implementation of the FileTransferService.

s3FileTransferImpl

@Bean(name={"file.system.s3","file.system.s3n","file.system.s3a"})
 @Order(value=1)
 @ConditionalOnMissingBean(value=S3FileTransferImpl.class)
 @ConditionalOnBean(value=S3ClientFactory.class)
public S3FileTransferImpl s3FileTransferImpl(S3ClientFactory s3ClientFactory,
                                                                                                                                                                                                                                             io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                                                                                                                                             S3FileTransferProperties s3FileTransferProperties)

Returns a bean which has an s3 implementation of the File Transfer interface.

Parameters:

s3ClientFactory - S3 client factory to use

registry - The metrics registry to use

s3FileTransferProperties - Configuration properties

Returns:

An s3 implementation of the FileTransfer interface

jobKillLogicTask

@Bean
 @Order(value=0)
 @ConditionalOnMissingBean(value=JobFailureAndKillHandlerLogicTask.class)
public JobFailureAndKillHandlerLogicTask jobKillLogicTask(io.micrometer.core.instrument.MeterRegistry registry)

Create a task that adds logic to handle kill requests to a job.

Parameters:

registry - The metrics registry to use

Returns:

A jobKillLogicTask bean.

initialSetupTask

@Bean
 @Order(value=1)
 @ConditionalOnMissingBean(value=InitialSetupTask.class)
public InitialSetupTask initialSetupTask(io.micrometer.core.instrument.MeterRegistry registry)

Create an setup Task bean that does initial setup before any of the tasks start.

Parameters:

registry - The metrics registry to use

Returns:

An initial setup task object

clusterProcessorTask

@Bean
 @Order(value=2)
 @ConditionalOnMissingBean(value=ClusterTask.class)
public ClusterTask clusterProcessorTask(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                   @Qualifier(value="cacheGenieFileTransferService")
                                                                                                                   GenieFileTransferService fts)

Create an Cluster Task bean that processes the cluster needed for a job.

Parameters:

registry - The metrics registry to use

fts - File transfer implementation

Returns:

An cluster task object

applicationProcessorTask

@Bean
 @Order(value=3)
 @ConditionalOnMissingBean(value=ApplicationTask.class)
public ApplicationTask applicationProcessorTask(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                               @Qualifier(value="cacheGenieFileTransferService")
                                                                                                                               GenieFileTransferService fts)

Create an Application Task bean that processes all Applications needed for a job.

Parameters:

registry - The metrics registry to use

fts - File transfer implementation

Returns:

An application task object

commandProcessorTask

@Bean
 @Order(value=4)
 @ConditionalOnMissingBean(value=CommandTask.class)
public CommandTask commandProcessorTask(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                                   @Qualifier(value="cacheGenieFileTransferService")
                                                                                                                   GenieFileTransferService fts)

Create an Command Task bean that processes the command needed for a job.

Parameters:

registry - The metrics registry to use

fts - File transfer implementation

Returns:

An command task object

jobProcessorTask

@Bean
 @Order(value=5)
 @ConditionalOnMissingBean(value=JobTask.class)
public JobTask jobProcessorTask(AttachmentService attachmentService,
                                                                                                       io.micrometer.core.instrument.MeterRegistry registry,
                                                                                                       @Qualifier(value="genieFileTransferService")
                                                                                                       GenieFileTransferService fts)

Create an Job Task bean that processes Job information provided by user.

Parameters:

attachmentService - An implementation of the attachment service

registry - The metrics registry to use

fts - File transfer implementation

Returns:

An job task object

jobKickoffTask

@Bean
 @Order(value=6)
 @ConditionalOnMissingBean(value=JobKickoffTask.class)
public JobKickoffTask jobKickoffTask(JobsProperties jobsProperties,
                                                                                                                   org.apache.commons.exec.Executor executor,
                                                                                                                   GenieHostInfo genieHostInfo,
                                                                                                                   io.micrometer.core.instrument.MeterRegistry registry)

Create an Job Kickoff Task bean that runs the job.

Parameters:

jobsProperties - The various jobs properties

executor - An instance of an executor

genieHostInfo - Info about the host Genie is running on

registry - The metrics registry to use

Returns:

An application task object

processCheckerFactory

@Bean
 @ConditionalOnMissingBean(value=ProcessChecker.Factory.class)
public ProcessChecker.Factory processCheckerFactory(org.apache.commons.exec.Executor executor,
                                                                                                                         JobsProperties jobsProperties)

Create a ProcessChecker.Factory suitable for UNIX systems.

Parameters:

executor - The executor where checks are executed

jobsProperties - The jobs properties

Returns:

a ProcessChecker.Factory