mychalvlcek/!Spring Quartz - multitenancy.md

## !Spring Quartz - multitenancy.md

      
    Raw
  

              !Spring Quartz - multitenancy.md
            
          
    To achieve multitenant behavior for quartz scheduler, we need to setup:

set tenantId for every job we created.. we use quartz JobDataMap (handy key/value store) in Job class
JobListener - to inject tenantId from JobDataMap into current thread-bounded tenant context

This will work with shared quartz database.. if we want to have separated quartz databases/schemas for every tenant, we can instantiate multiple SchedulerFactoryBean with its custom dataSource

  
## QuartzMultitenantConfig.java
@Configuration
public class QuartzMultitenantConfig {

    @Bean
    public JobDetailFactoryBean jobDetail() {
        JobDetailFactoryBean jobDetailFactory = new JobDetailFactoryBean();
        jobDetailFactory.setJobClass(TestJob.class);
        jobDetailFactory.setDescription("Invoke Sample Job service...");
        jobDetailFactory.setName("test");
        jobDetailFactory.setGroup("group");
        jobDetailFactory.setJobDataAsMap(Map.of(TenantContext.TENANT_HEADER, "tenant1"));
        jobDetailFactory.setDurability(true);
        return jobDetailFactory;
    }

    @Bean
    public SimpleTriggerFactoryBean trigger(JobDetail job) {
        SimpleTriggerFactoryBean trigger = new SimpleTriggerFactoryBean();
        trigger.setJobDetail(job);
        trigger.setRepeatInterval(3000);
        trigger.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
        return trigger;
    }

    @Bean
    public SchedulerFactoryBean schedulerFactory(ObjectProvider<Trigger> triggers) {
        SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
        schedulerFactoryBean.setJobFactory(jobFactory());
        schedulerFactoryBean.setTriggers(triggers.orderedStream().toArray(Trigger[]::new));
        schedulerFactoryBean.setGlobalJobListeners(new TenantInjectorJobListener());

        return schedulerFactoryBean;
    }

    @Bean
    public SpringBeanJobFactory jobFactory() {
        return new SpringBeanJobFactory();
    }

}

## TenantContext.java
@Slf4j
public class TenantContext {

    public static final String TENANT_HEADER = "X-TenantId";

    private static final ThreadLocal<String> CONTEXT = new ThreadLocal<>();

    public static void setTenantId(String tenantId) {
        if (log.isDebugEnabled()) {
            log.debug("Setting tenantId to {} ", tenantId);
        }

        CONTEXT.set(tenantId);
    }

    public static String getTenantId() {
        return CONTEXT.get();
    }

    public static void clear() {
        CONTEXT.remove();
    }
}

## TenantInjectorJobListener.java
@Slf4j
public class TenantInjectorJobListener implements JobListener {

    private static final String NAME = "tenantContext";

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public void jobToBeExecuted(JobExecutionContext context) {
        TenantContext.setTenantId(context.getJobDetail().getJobDataMap().getString(TenantContext.TENANT_HEADER));
    }

    @Override
    public void jobExecutionVetoed(JobExecutionContext context) {
        TenantContext.clear();
    }

    @Override
    public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) {
        TenantContext.clear();
    }
}

## TestJob.java
@Slf4j
@Component
public class TestJob extends QuartzJobBean {

    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) {
        log.info("TestJob {}", TenantContext.getTenantId());
    }
}
	@Configuration
	public class QuartzMultitenantConfig {

	@Bean
	public JobDetailFactoryBean jobDetail() {
	JobDetailFactoryBean jobDetailFactory = new JobDetailFactoryBean();
	jobDetailFactory.setJobClass(TestJob.class);
	jobDetailFactory.setDescription("Invoke Sample Job service...");
	jobDetailFactory.setName("test");
	jobDetailFactory.setGroup("group");
	jobDetailFactory.setJobDataAsMap(Map.of(TenantContext.TENANT_HEADER, "tenant1"));
	jobDetailFactory.setDurability(true);
	return jobDetailFactory;
	}

	@Bean
	public SimpleTriggerFactoryBean trigger(JobDetail job) {
	SimpleTriggerFactoryBean trigger = new SimpleTriggerFactoryBean();
	trigger.setJobDetail(job);
	trigger.setRepeatInterval(3000);
	trigger.setRepeatCount(SimpleTrigger.REPEAT_INDEFINITELY);
	return trigger;
	}

	@Bean
	public SchedulerFactoryBean schedulerFactory(ObjectProvider<Trigger> triggers) {
	SchedulerFactoryBean schedulerFactoryBean = new SchedulerFactoryBean();
	schedulerFactoryBean.setJobFactory(jobFactory());
	schedulerFactoryBean.setTriggers(triggers.orderedStream().toArray(Trigger[]::new));
	schedulerFactoryBean.setGlobalJobListeners(new TenantInjectorJobListener());

	return schedulerFactoryBean;
	}

	@Bean
	public SpringBeanJobFactory jobFactory() {
	return new SpringBeanJobFactory();
	}

	}
	@Slf4j
	public class TenantContext {

	public static final String TENANT_HEADER = "X-TenantId";

	private static final ThreadLocal<String> CONTEXT = new ThreadLocal<>();

	public static void setTenantId(String tenantId) {
	if (log.isDebugEnabled()) {
	log.debug("Setting tenantId to {} ", tenantId);
	}

	CONTEXT.set(tenantId);
	}

	public static String getTenantId() {
	return CONTEXT.get();
	}

	public static void clear() {
	CONTEXT.remove();
	}
	}
	@Slf4j
	public class TenantInjectorJobListener implements JobListener {

	private static final String NAME = "tenantContext";

	@Override
	public String getName() {
	return NAME;
	}

	@Override
	public void jobToBeExecuted(JobExecutionContext context) {
	TenantContext.setTenantId(context.getJobDetail().getJobDataMap().getString(TenantContext.TENANT_HEADER));
	}

	@Override
	public void jobExecutionVetoed(JobExecutionContext context) {
	TenantContext.clear();
	}

	@Override
	public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) {
	TenantContext.clear();
	}
	}
	@Slf4j
	@Component
	public class TestJob extends QuartzJobBean {

	@Override
	protected void executeInternal(JobExecutionContext jobExecutionContext) {
	log.info("TestJob {}", TenantContext.getTenantId());
	}
	}