org.springframework.integration.jdbc.JdbcOutboundGateway Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-integration-jdbc Show documentation
Spring Integration JDBC Support
There is a newer version: 6.4.1
Show newest version
/*
 * Copyright 2002-2022 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
 *
 *      https://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 org.springframework.integration.jdbc;

import java.util.Collections;
import java.util.List;

import javax.sql.DataSource;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.integration.handler.AbstractReplyProducingMessageHandler;
import org.springframework.jdbc.core.JdbcOperations;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.messaging.Message;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
 * @author Dave Syer
 * @author Gunnar Hillert
 * @author Artem Bilan
 * @author Gary Russell
 *
 * @since 2.0
 */
public class JdbcOutboundGateway extends AbstractReplyProducingMessageHandler {

	private final JdbcMessageHandler handler;

	private final JdbcPollingChannelAdapter poller;

	private SqlParameterSourceFactory sqlParameterSourceFactory = new ExpressionEvaluatingSqlParameterSourceFactory();

	private boolean sqlParameterSourceFactorySet;

	private boolean keysGenerated;

	private Integer maxRows;

	/**
	 * Construct an instance based on the provided {@link DataSource} and update SQL.
	 * @param dataSource the {@link DataSource} for execution.
	 * @param updateQuery the query to execute.
	 */
	public JdbcOutboundGateway(DataSource dataSource, String updateQuery) {
		this(new JdbcTemplate(dataSource), updateQuery, null);
	}

	/**
	 * Construct an instance based on the provided {@link DataSource}, select and update SQLs.
	 * @param dataSource the {@link DataSource} for execution.
	 * @param updateQuery the update to execute.
	 * @param selectQuery the select to execute.
	 */
	public JdbcOutboundGateway(DataSource dataSource, String updateQuery, String selectQuery) {
		this(new JdbcTemplate(dataSource), updateQuery, selectQuery);
	}

	/**
	 * Construct an instance based on the provided {@link JdbcOperations} and update SQL.
	 * @param jdbcOperations the {@link JdbcOperations} for execution.
	 * @param updateQuery the query to execute.
	 */
	public JdbcOutboundGateway(JdbcOperations jdbcOperations, String updateQuery) {
		this(jdbcOperations, updateQuery, null);
	}

	/**
	 * Construct an instance based on the provided {@link JdbcOperations}, select and update SQLs.
	 * @param jdbcOperations the {@link JdbcOperations} for execution.
	 * @param updateQuery the update to execute.
	 * @param selectQuery the select to execute.
	 */
	public JdbcOutboundGateway(JdbcOperations jdbcOperations, String updateQuery, String selectQuery) {
		Assert.notNull(jdbcOperations, "'jdbcOperations' must not be null.");

		if (!StringUtils.hasText(updateQuery) && !StringUtils.hasText(selectQuery)) {
			throw new IllegalArgumentException(
					"The 'updateQuery' and the 'selectQuery' must not both be null or empty.");
		}

		if (StringUtils.hasText(selectQuery)) {
			this.poller = new JdbcPollingChannelAdapter(jdbcOperations, selectQuery);
			this.poller.setMaxRows(1);
		}
		else {
			this.poller = null;
		}

		if (StringUtils.hasText(updateQuery)) {
			this.handler = new JdbcMessageHandler(jdbcOperations, updateQuery);
		}
		else {
			this.handler = null;
		}

	}

	/**
	 * The maximum number of rows to query.
	 * The value is set on the underlying {@link JdbcPollingChannelAdapter}.
	 * Also used to check before producing reply:
	 * if result has only one item and {@code maxRows} is not set or configured to {@code 1},
	 * only that item is returned. Otherwise, the whole list.
	 * If not specified this value will default to {@code 1}.
	 * This parameter is only applicable if a selectQuery was provided. Null values
	 * are not permitted.
	 * @param maxRows the number of rows to select. Must not be null.
	 * @since 5.1
	 * @see JdbcPollingChannelAdapter#setMaxRows(int)
	 */
	public void setMaxRows(Integer maxRows) {
		Assert.notNull(maxRows, "'maxRows' must not be null.");
		this.maxRows = maxRows;
	}

	/**
	 * Flag to indicate that the update query is an insert with auto-generated keys,
	 * which will be logged at debug level.
	 * @param keysGenerated the flag value to set
	 */
	public void setKeysGenerated(boolean keysGenerated) {
		this.keysGenerated = keysGenerated;
	}

	/**
	 * Set a {@link SqlParameterSourceFactory} for update query.
	 * @param sqlParameterSourceFactory the {@link SqlParameterSourceFactory} to use.
	 */
	public void setRequestSqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory) {
		Assert.notNull(this.handler, "'handler' cannot be null");
		this.handler.setSqlParameterSourceFactory(sqlParameterSourceFactory);
	}

	/**
	 * Set a {@link MessagePreparedStatementSetter} for update query.
	 * @param requestPreparedStatementSetter the {@link MessagePreparedStatementSetter} to use.
	 */
	public void setRequestPreparedStatementSetter(MessagePreparedStatementSetter requestPreparedStatementSetter) {
		Assert.notNull(this.handler, "'handler' cannot be null");
		this.handler.setPreparedStatementSetter(requestPreparedStatementSetter);
	}

	/**
	 /**
	 * Set a {@link SqlParameterSourceFactory} for select query.
	 * @param sqlParameterSourceFactory the {@link SqlParameterSourceFactory} to use.
	 */
	public void setReplySqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory) {
		this.sqlParameterSourceFactory = sqlParameterSourceFactory;
		this.sqlParameterSourceFactorySet = true;
	}

	/**
	 * Set a select result {@link RowMapper}.
	 * @param rowMapper the {@link RowMapper} to use.
	 */
	public void setRowMapper(RowMapper rowMapper) {
		this.poller.setRowMapper(rowMapper);
	}

	@Override
	public String getComponentType() {
		return "jdbc:outbound-gateway";
	}

	@Override
	protected void doInit() {
		if (this.maxRows != null) {
			Assert.notNull(this.poller, "If you want to set 'maxRows', then you must provide a 'selectQuery'.");
			this.poller.setMaxRows(this.maxRows);
		}

		BeanFactory beanFactory = getBeanFactory();
		if (this.handler != null) {
			this.handler.setBeanFactory(beanFactory);
			this.handler.afterPropertiesSet();
		}

		if (!this.sqlParameterSourceFactorySet && beanFactory != null) {
			((ExpressionEvaluatingSqlParameterSourceFactory) this.sqlParameterSourceFactory)
					.setBeanFactory(beanFactory);
		}
	}

	@Override
	protected Object handleRequestMessage(Message requestMessage) {
		List list = Collections.emptyList();

		if (this.handler != null) {
			list = this.handler.executeUpdateQuery(requestMessage, this.keysGenerated);
		}

		if (this.poller != null) {
			SqlParameterSource sqlQueryParameterSource =
					this.sqlParameterSourceFactory.createParameterSource(requestMessage);
			if (this.keysGenerated && !list.isEmpty()) {
				if (list.size() == 1) {
					sqlQueryParameterSource = this.sqlParameterSourceFactory.createParameterSource(list.get(0));
				}
				else {
					sqlQueryParameterSource = this.sqlParameterSourceFactory.createParameterSource(list);
				}
			}
			list = this.poller.doPoll(sqlQueryParameterSource);
		}
		Object payload = list;
		if (list.size() == 1 && (this.maxRows == null || this.maxRows == 1)) {
			payload = list.get(0);
		}
		return payload;
	}

}