com.netflix.genie.web.configs

Class ServicesConfig

java.lang.Object

com.netflix.genie.web.configs.ServicesConfig

@Configuration
public class ServicesConfig
extends java.lang.Object

Configuration for all the services.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
ServicesConfig()

Method Summary

Modifier and Type	Method and Description
ApplicationService	applicationService(JpaApplicationRepository applicationRepo, JpaCommandRepository commandRepo) Get JPA based implementation of the ApplicationService.
AttachmentService	attachmentService(JobsProperties jobsProperties) The attachment service to use.
GenieFileTransferService	cacheGenieFileTransferService(FileTransferFactory fileTransferFactory, java.lang.String baseCacheLocation, FileTransfer localFileTransfer, com.netflix.spectator.api.Registry registry) Get an instance of the Cache Genie File Transfer service.
ClusterLoadBalancer	clusterLoadBalancer() Get a Randomized Cluster load balancer.
ClusterService	clusterService(JpaClusterRepository clusterRepo, JpaCommandRepository commandRepo) Get JPA based implementation of the ClusterService.
CommandService	commandService(JpaCommandRepository commandRepo, JpaApplicationRepository appRepo, JpaClusterRepository clusterRepo) Get JPA based implementation of the CommandService.
org.springframework.beans.factory.FactoryBean	fileTransferFactory() FileTransfer factory.
GenieFileTransferService	genieFileTransferService(FileTransferFactory fileTransferFactory) Get an instance of the Genie File Transfer service.
MailService	getDefaultMailServiceImpl() Get an default implementation of the Mail Service interface if nothing is supplied.
MailService	getJavaMailSenderMailService(org.springframework.mail.javamail.JavaMailSender javaMailSender, java.lang.String fromAddress) Returns a bean for mail service impl using the Spring Mail.
JobCoordinatorService	jobCoordinatorService(JobPersistenceService jobPersistenceService, JobKillService jobKillService, JobStateService jobStateService, JobsProperties jobsProperties, ApplicationService applicationService, ClusterService clusterService, CommandService commandService, ClusterLoadBalancer clusterLoadBalancer, com.netflix.spectator.api.Registry registry, java.lang.String hostName) Get an instance of the JobCoordinatorService.
JobKillService	jobKillService(java.lang.String hostName, JobSearchService jobSearchService, org.apache.commons.exec.Executor executor, JobsProperties jobsProperties, org.springframework.context.ApplicationEventPublisher eventPublisher, org.springframework.core.io.Resource genieWorkingDir, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Get an local implementation of the JobKillService.
JobPersistenceService	jobPersistenceService(JpaJobRepository jobRepo, JpaJobRequestRepository jobRequestRepo, JpaJobMetadataRepository jobMetadataRepository, JpaJobExecutionRepository jobExecutionRepo, JpaApplicationRepository applicationRepo, JpaClusterRepository clusterRepo, JpaCommandRepository commandRepo) Get JPA based implementation of the JobPersistenceService.
JobSearchService	jobSearchService(JpaJobRepository jobRepository, JpaJobRequestRepository jobRequestRepository, JpaJobExecutionRepository jobExecutionRepository, JpaClusterRepository clusterRepository, JpaCommandRepository commandRepository) Get JPA based implementation of the JobSearchService.
JobSubmitterService	jobSubmitterService(JobPersistenceService jobPersistenceService, org.springframework.context.ApplicationEventPublisher eventPublisher, org.springframework.context.event.ApplicationEventMulticaster eventMulticaster, java.util.List<WorkflowTask> workflowTasks, org.springframework.core.io.Resource genieWorkingDir, com.netflix.spectator.api.Registry registry) Get a implementation of the JobSubmitterService that runs jobs locally.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicesConfig

public ServicesConfig()

Method Detail

getJavaMailSenderMailService

@Bean
 @ConditionalOnProperty(value="spring.mail.host")
public MailService getJavaMailSenderMailService(org.springframework.mail.javamail.JavaMailSender javaMailSender,
                                                                                                        @Value(value="${genie.mail.fromAddress}")
                                                                                                        java.lang.String fromAddress)

Returns a bean for mail service impl using the Spring Mail.

Parameters:

javaMailSender - An implementation of the JavaMailSender interface.

fromAddress - The from email address for the email.

Returns:

An instance of MailService implementation.

getDefaultMailServiceImpl

@Bean
 @ConditionalOnMissingBean
public MailService getDefaultMailServiceImpl()

Get an default implementation of the Mail Service interface if nothing is supplied.

Returns:

The mail service implementation that does nothing.

applicationService

@Bean
public ApplicationService applicationService(JpaApplicationRepository applicationRepo,
                                                   JpaCommandRepository commandRepo)

Get JPA based implementation of the ApplicationService.

Parameters:

applicationRepo - The application repository to use.

commandRepo - The command repository to use.

Returns:

An application service instance.

clusterService

@Bean
public ClusterService clusterService(JpaClusterRepository clusterRepo,
                                           JpaCommandRepository commandRepo)

Get JPA based implementation of the ClusterService.

Parameters:

clusterRepo - The cluster repository to use.

commandRepo - The command repository to use.

Returns:

A cluster service instance.

commandService

@Bean
public CommandService commandService(JpaCommandRepository commandRepo,
                                           JpaApplicationRepository appRepo,
                                           JpaClusterRepository clusterRepo)

Get JPA based implementation of the CommandService.

Parameters:

commandRepo - the command repository to use

appRepo - the application repository to use

clusterRepo - the cluster repository to use

Returns:

A command service instance.

jobSearchService

@Bean
public JobSearchService jobSearchService(JpaJobRepository jobRepository,
                                               JpaJobRequestRepository jobRequestRepository,
                                               JpaJobExecutionRepository jobExecutionRepository,
                                               JpaClusterRepository clusterRepository,
                                               JpaCommandRepository commandRepository)

Get JPA based implementation of the JobSearchService.

Parameters:

jobRepository - The repository to use for job entities

jobRequestRepository - The repository to use for job request entities

jobExecutionRepository - The repository to use for job execution entities

clusterRepository - The repository to use for cluster entities

commandRepository - The repository to use for command entities

Returns:

A job search service instance.

jobPersistenceService

@Bean
public JobPersistenceService jobPersistenceService(JpaJobRepository jobRepo,
                                                         JpaJobRequestRepository jobRequestRepo,
                                                         JpaJobMetadataRepository jobMetadataRepository,
                                                         JpaJobExecutionRepository jobExecutionRepo,
                                                         JpaApplicationRepository applicationRepo,
                                                         JpaClusterRepository clusterRepo,
                                                         JpaCommandRepository commandRepo)

Get JPA based implementation of the JobPersistenceService.

Parameters:

jobRepo - The job repository to use

jobRequestRepo - The job request repository to use

jobMetadataRepository - The job metadata repository to use

jobExecutionRepo - The job execution repository to use

applicationRepo - The application repository to use

clusterRepo - The cluster repository to use

commandRepo - The command repository to use

Returns:

A job search service instance.

jobKillService

@Bean
public JobKillService jobKillService(java.lang.String hostName,
                                           JobSearchService jobSearchService,
                                           org.apache.commons.exec.Executor executor,
                                           JobsProperties jobsProperties,
                                           org.springframework.context.ApplicationEventPublisher eventPublisher,
                                           @Qualifier(value="jobsDir")
                                           org.springframework.core.io.Resource genieWorkingDir,
                                           com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Get an local implementation of the JobKillService.

Parameters:

hostName - The name of the host this Genie node is running on.

jobSearchService - The job search service to use to locate job information.

executor - The executor to use to run system processes.

jobsProperties - The jobs properties to use

eventPublisher - The application event publisher to use to publish system wide events

genieWorkingDir - Working directory for genie where it creates jobs directories.

objectMapper - The Jackson ObjectMapper used to serialize from/to JSON

Returns:

A job kill service instance.

clusterLoadBalancer

@Bean
public ClusterLoadBalancer clusterLoadBalancer()

Get a Randomized Cluster load balancer.

Returns:

A randomized cluster load balancer instance.

genieFileTransferService

@Bean
public GenieFileTransferService genieFileTransferService(FileTransferFactory fileTransferFactory)
                                                        throws GenieException

Get an instance of the Genie File Transfer service.

Parameters:

fileTransferFactory - file transfer implementation factory

Returns:

A singleton for GenieFileTransferService

Throws:

GenieException - If there is any problem

cacheGenieFileTransferService

@Bean
public GenieFileTransferService cacheGenieFileTransferService(FileTransferFactory fileTransferFactory,
                                                                    @Value(value="${genie.file.cache.location}")
                                                                    java.lang.String baseCacheLocation,
                                                                    @Qualifier(value="file.system.file")
                                                                    FileTransfer localFileTransfer,
                                                                    com.netflix.spectator.api.Registry registry)
                                                             throws GenieException

Get an instance of the Cache Genie File Transfer service.

Parameters:

fileTransferFactory - file transfer implementation factory

baseCacheLocation - file cache location

localFileTransfer - local file transfer service

registry - Registry

Returns:

A singleton for GenieFileTransferService

Throws:

GenieException - If there is any problem

jobSubmitterService

@Bean
public JobSubmitterService jobSubmitterService(JobPersistenceService jobPersistenceService,
                                                     org.springframework.context.ApplicationEventPublisher eventPublisher,
                                                     org.springframework.context.event.ApplicationEventMulticaster eventMulticaster,
                                                     java.util.List<WorkflowTask> workflowTasks,
                                                     @Qualifier(value="jobsDir")
                                                     org.springframework.core.io.Resource genieWorkingDir,
                                                     com.netflix.spectator.api.Registry registry)

Get a implementation of the JobSubmitterService that runs jobs locally.

Parameters:

jobPersistenceService - Implementation of the job persistence service.

eventPublisher - Instance of the synchronous event publisher.

eventMulticaster - Instance of the asynchronous event publisher.

workflowTasks - List of all the workflow tasks to be executed.

genieWorkingDir - Working directory for genie where it creates jobs directories.

registry - The metrics registry to use

Returns:

An instance of the JobSubmitterService.

jobCoordinatorService

@Bean
public JobCoordinatorService jobCoordinatorService(JobPersistenceService jobPersistenceService,
                                                         JobKillService jobKillService,
                                                         @Qualifier(value="jobMonitoringCoordinator")
                                                         JobStateService jobStateService,
                                                         JobsProperties jobsProperties,
                                                         ApplicationService applicationService,
                                                         ClusterService clusterService,
                                                         CommandService commandService,
                                                         ClusterLoadBalancer clusterLoadBalancer,
                                                         com.netflix.spectator.api.Registry registry,
                                                         java.lang.String hostName)

Get an instance of the JobCoordinatorService.

Parameters:

jobPersistenceService - implementation of job persistence service interface

jobKillService - The job kill service to use

jobStateService - The running job metrics service to use

jobsProperties - The jobs properties to use

applicationService - Implementation of application service interface

clusterService - Implementation of cluster service interface

commandService - Implementation of command service interface

clusterLoadBalancer - Implementation of the cluster load balancer interface

registry - The metrics registry to use

hostName - The host this Genie instance is running on

Returns:

An instance of the JobCoordinatorService.

attachmentService

@Bean
public AttachmentService attachmentService(JobsProperties jobsProperties)

The attachment service to use.

Parameters:

jobsProperties - All properties related to jobs

Returns:

The attachment service to use

fileTransferFactory

@Bean
public org.springframework.beans.factory.FactoryBean fileTransferFactory()

FileTransfer factory.

Returns:

FileTransfer factory