de.codecentric.batch.configuration.WebConfig.java Source code

Introduction

Here is the source code for de.codecentric.batch.configuration.WebConfig.java

Source

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.codecentric.batch.configuration;

import java.util.List;

import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.jsr.launch.JsrJobOperator;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import de.codecentric.batch.web.JobMonitoringController;
import de.codecentric.batch.web.JobOperationsController;

/**
 * This configuration adds the controllers for the two endpoints, and it adds a Jackson MixIn to the
 * message converter to avoid a stack overflow through circular references in the JobExecution /
 * StepExecution.
 *
 * @author Tobias Flohre
 *
 */
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Autowired
    private BaseConfiguration baseConfig;
    @Autowired
    private BatchWebAutoConfiguration batchWebAutoConfiguration;
    @Autowired(required = false)
    private JsrJobOperator jsrJobOperator;

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        for (HttpMessageConverter<?> httpMessageConverter : converters) {
            if (httpMessageConverter instanceof MappingJackson2HttpMessageConverter) {
                final MappingJackson2HttpMessageConverter converter = (MappingJackson2HttpMessageConverter) httpMessageConverter;
                converter.getObjectMapper().addMixIn(StepExecution.class, StepExecutionJacksonMixIn.class);
            }
        }
    }

    @Bean
    public JobMonitoringController jobMonitoringController() {
        return new JobMonitoringController(baseConfig.jobOperator(), baseConfig.jobExplorer(),
                batchWebAutoConfiguration.runningExecutionTracker());
    }

    @Bean
    public JobOperationsController jobOperationsController() {
        return new JobOperationsController(baseConfig.jobOperator(), baseConfig.jobExplorer(),
                baseConfig.jobRegistry(), baseConfig.jobRepository(), baseConfig.jobLauncher(), jsrJobOperator);
    }

}