Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.camel.component.sql.SqlConsumer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.camel.component.sql;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Queue;
import org.apache.camel.Exchange;
import org.apache.camel.ExchangePattern;
import org.apache.camel.Message;
import org.apache.camel.Processor;
import org.apache.camel.RollbackExchangeException;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.support.ResourceHelper;
import org.apache.camel.support.ScheduledBatchPollingConsumer;
import org.apache.camel.util.CastUtils;
import org.apache.camel.util.ObjectHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.PreparedStatementCallback;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import static org.springframework.jdbc.support.JdbcUtils.closeResultSet;
public class SqlConsumer extends ScheduledBatchPollingConsumer {
private static final Logger LOG = LoggerFactory.getLogger(SqlConsumer.class);
private final String query;
private String resolvedQuery;
private final JdbcTemplate jdbcTemplate;
private final NamedParameterJdbcTemplate namedJdbcTemplate;
private final SqlParameterSource parameterSource;
private final SqlPrepareStatementStrategy sqlPrepareStatementStrategy;
private final SqlProcessingStrategy sqlProcessingStrategy;
private String onConsume;
private String onConsumeFailed;
private String onConsumeBatchComplete;
private boolean useIterator = true;
private boolean routeEmptyResultSet;
private int expectedUpdateCount = -1;
private boolean breakBatchOnConsumeFail;
private int parametersCount;
private boolean alwaysPopulateStatement;
private static final class DataHolder {
private Exchange exchange;
private Object data;
private DataHolder() {
}
}
public SqlConsumer(DefaultSqlEndpoint endpoint, Processor processor, JdbcTemplate jdbcTemplate, String query,
SqlPrepareStatementStrategy sqlPrepareStatementStrategy,
SqlProcessingStrategy sqlProcessingStrategy) {
super(endpoint, processor);
this.jdbcTemplate = jdbcTemplate;
this.namedJdbcTemplate = null;
this.query = query;
this.parameterSource = null;
this.sqlPrepareStatementStrategy = sqlPrepareStatementStrategy;
this.sqlProcessingStrategy = sqlProcessingStrategy;
}
public SqlConsumer(DefaultSqlEndpoint endpoint, Processor processor, NamedParameterJdbcTemplate namedJdbcTemplate,
String query, SqlParameterSource parameterSource,
SqlPrepareStatementStrategy sqlPrepareStatementStrategy, SqlProcessingStrategy sqlProcessingStrategy) {
super(endpoint, processor);
this.jdbcTemplate = null;
this.namedJdbcTemplate = namedJdbcTemplate;
this.query = query;
this.parameterSource = parameterSource;
this.sqlPrepareStatementStrategy = sqlPrepareStatementStrategy;
this.sqlProcessingStrategy = sqlProcessingStrategy;
}
@Override
public DefaultSqlEndpoint getEndpoint() {
return (DefaultSqlEndpoint) super.getEndpoint();
}
@Override
protected void doInit() throws Exception {
super.doInit();
if (ResourceHelper.isClasspathUri(query)) {
String placeholder = getEndpoint().isUsePlaceholder() ? getEndpoint().getPlaceholder() : null;
resolvedQuery = SqlHelper.resolveQuery(getEndpoint().getCamelContext(), query, placeholder);
}
}
@Override
protected void doStart() throws Exception {
super.doStart();
if (!ResourceHelper.isClasspathUri(query)) {
String placeholder = getEndpoint().isUsePlaceholder() ? getEndpoint().getPlaceholder() : null;
resolvedQuery = SqlHelper.resolveQuery(getEndpoint().getCamelContext(), query, placeholder);
}
}
@Override
protected int poll() throws Exception {
// must reset for each poll
shutdownRunningTask = null;
pendingExchanges = 0;
final Exchange dummy = getEndpoint().createExchange();
final String preparedQuery
= sqlPrepareStatementStrategy.prepareQuery(resolvedQuery, getEndpoint().isAllowNamedParameters(), dummy);
LOG.trace("poll: {}", preparedQuery);
final PreparedStatementCallback callback = new PreparedStatementCallback() {
@Override
public Integer doInPreparedStatement(PreparedStatement ps) throws SQLException, DataAccessException {
Queue answer = new LinkedList<>();
int expected = parametersCount > 0 ? parametersCount : ps.getParameterMetaData().getParameterCount();
// only populate if really needed
if (alwaysPopulateStatement || expected > 0) {
Iterator i = sqlPrepareStatementStrategy.createPopulateIterator(resolvedQuery, preparedQuery, expected,
dummy, null);
sqlPrepareStatementStrategy.populateStatement(ps, i, expected);
}
LOG.debug("Executing query: {}", preparedQuery);
ResultSet rs = ps.executeQuery();
SqlOutputType outputType = getEndpoint().getOutputType();
boolean closeEager = true;
try {
LOG.trace("Got result list from query: {}, outputType={}", rs, outputType);
if (outputType == SqlOutputType.StreamList) {
ResultSetIterator data = getEndpoint().queryForStreamList(ps.getConnection(), ps, rs);
// only process if we have data
if (data.hasNext()) {
addListToQueue(data, answer);
closeEager = false;
}
} else if (outputType == SqlOutputType.SelectList) {
List data = getEndpoint().queryForList(rs, true);
addListToQueue(data, answer);
} else if (outputType == SqlOutputType.SelectOne) {
Object data = getEndpoint().queryForObject(rs);
if (data != null) {
addListToQueue(data, answer);
}
} else {
throw new IllegalArgumentException("Invalid outputType=" + outputType);
}
} finally {
if (closeEager) {
closeResultSet(rs);
}
}
// process all the exchanges in this batch
try {
if (answer.isEmpty()) {
// no data
return 0;
} else {
int rows = processBatch(CastUtils.cast(answer));
return rows;
}
} catch (Exception e) {
throw RuntimeCamelException.wrapRuntimeCamelException(e);
} finally {
closeResultSet(rs);
}
}
};
Integer messagePolled;
if (namedJdbcTemplate != null) {
messagePolled = namedJdbcTemplate.execute(preparedQuery, parameterSource, callback);
} else {
messagePolled = jdbcTemplate.execute(preparedQuery, callback);
}
return messagePolled;
}
private void addListToQueue(Object data, Queue answer) {
if (data instanceof List) {
// create a list of exchange objects with the data
List list = (List) data;
if (useIterator) {
for (Object item : list) {
addItemToQueue(item, answer);
}
} else if (!list.isEmpty() || routeEmptyResultSet) {
addItemToQueue(list, answer);
}
} else {
// create single object as data
addItemToQueue(data, answer);
}
}
private void addItemToQueue(Object item, Queue answer) {
Exchange exchange = createExchange(item);
DataHolder holder = new DataHolder();
holder.exchange = exchange;
holder.data = item;
answer.add(holder);
}
protected Exchange createExchange(Object data) {
final Exchange exchange = getEndpoint().createExchange(ExchangePattern.InOnly);
Message msg = exchange.getIn();
if (getEndpoint().getOutputHeader() != null) {
msg.setHeader(getEndpoint().getOutputHeader(), data);
} else {
msg.setBody(data);
}
return exchange;
}
@Override
public int processBatch(Queue exchanges) throws Exception {
int total = exchanges.size();
if (maxMessagesPerPoll > 0 && total == maxMessagesPerPoll) {
LOG.debug("Maximum messages to poll is {} and there were exactly {} messages in this poll.", maxMessagesPerPoll,
total);
}
for (int index = 0; index < total && isBatchAllowed(); index++) {
// only loop if we are started (allowed to run)
DataHolder holder = ObjectHelper.cast(DataHolder.class, exchanges.poll());
Exchange exchange = holder.exchange;
Object data = holder.data;
// add current index and total as properties
exchange.setProperty(Exchange.BATCH_INDEX, index);
exchange.setProperty(Exchange.BATCH_SIZE, total);
exchange.setProperty(Exchange.BATCH_COMPLETE, index == total - 1);
// update pending number of exchanges
pendingExchanges = total - index - 1;
// process the current exchange
try {
getProcessor().process(exchange);
} catch (Exception e) {
exchange.setException(e);
}
if (getEndpoint().isTransacted() && exchange.isFailed()) {
// break out as we are transacted and should rollback
Exception cause = exchange.getException();
if (cause != null) {
throw cause;
} else {
throw new RollbackExchangeException("Rollback transaction due error processing exchange", exchange);
}
}
// pick the on consume to use
String sql = exchange.isFailed() ? onConsumeFailed : onConsume;
try {
// we can only run on consume if there was data
if (data != null && sql != null) {
int updateCount;
if (namedJdbcTemplate != null && sqlProcessingStrategy instanceof SqlNamedProcessingStrategy) {
SqlNamedProcessingStrategy namedProcessingStrategy = (SqlNamedProcessingStrategy) sqlProcessingStrategy;
updateCount = namedProcessingStrategy.commit(getEndpoint(), exchange, data, namedJdbcTemplate,
parameterSource, sql);
} else {
updateCount = sqlProcessingStrategy.commit(getEndpoint(), exchange, data, jdbcTemplate, sql);
}
if (expectedUpdateCount > -1 && updateCount != expectedUpdateCount) {
String msg = "Expected update count " + expectedUpdateCount + " but was " + updateCount
+ " executing query: " + sql;
throw new SQLException(msg);
}
}
} catch (Exception e) {
if (breakBatchOnConsumeFail) {
throw e;
} else {
handleException("Error executing onConsume/onConsumeFailed query " + sql, e);
}
}
}
try {
if (onConsumeBatchComplete != null) {
int updateCount;
if (namedJdbcTemplate != null && sqlProcessingStrategy instanceof SqlNamedProcessingStrategy) {
SqlNamedProcessingStrategy namedProcessingStrategy = (SqlNamedProcessingStrategy) sqlProcessingStrategy;
updateCount = namedProcessingStrategy.commitBatchComplete(getEndpoint(), namedJdbcTemplate, parameterSource,
onConsumeBatchComplete);
} else {
updateCount
= sqlProcessingStrategy.commitBatchComplete(getEndpoint(), jdbcTemplate, onConsumeBatchComplete);
}
LOG.debug("onConsumeBatchComplete update count {}", updateCount);
}
} catch (Exception e) {
if (breakBatchOnConsumeFail) {
throw e;
} else {
handleException("Error executing onConsumeBatchComplete query " + onConsumeBatchComplete, e);
}
}
return total;
}
public String getOnConsume() {
return onConsume;
}
/**
* Sets a SQL to execute when the row has been successfully processed.
*/
public void setOnConsume(String onConsume) {
this.onConsume = onConsume;
}
public String getOnConsumeFailed() {
return onConsumeFailed;
}
/**
* Sets a SQL to execute when the row failed being processed.
*/
public void setOnConsumeFailed(String onConsumeFailed) {
this.onConsumeFailed = onConsumeFailed;
}
public String getOnConsumeBatchComplete() {
return onConsumeBatchComplete;
}
public void setOnConsumeBatchComplete(String onConsumeBatchComplete) {
this.onConsumeBatchComplete = onConsumeBatchComplete;
}
public boolean isUseIterator() {
return useIterator;
}
/**
* Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object.
* defaults to true.
*/
public void setUseIterator(boolean useIterator) {
this.useIterator = useIterator;
}
public boolean isRouteEmptyResultSet() {
return routeEmptyResultSet;
}
/**
* Sets whether empty resultset should be allowed to be sent to the next hop. defaults to false. So the empty
* resultset will be filtered out.
*/
public void setRouteEmptyResultSet(boolean routeEmptyResultSet) {
this.routeEmptyResultSet = routeEmptyResultSet;
}
public int getExpectedUpdateCount() {
return expectedUpdateCount;
}
/**
* Sets an expected update count to validate when using onConsume.
*/
public void setExpectedUpdateCount(int expectedUpdateCount) {
this.expectedUpdateCount = expectedUpdateCount;
}
public boolean isBreakBatchOnConsumeFail() {
return breakBatchOnConsumeFail;
}
/**
* Sets whether to break batch if onConsume failed.
*/
public void setBreakBatchOnConsumeFail(boolean breakBatchOnConsumeFail) {
this.breakBatchOnConsumeFail = breakBatchOnConsumeFail;
}
@Override
public void setMaxMessagesPerPoll(int maxMessagesPerPoll) {
super.setMaxMessagesPerPoll(maxMessagesPerPoll);
if (jdbcTemplate != null) {
jdbcTemplate.setMaxRows(maxMessagesPerPoll);
}
}
public void setParametersCount(int parametersCount) {
this.parametersCount = parametersCount;
}
public void setAlwaysPopulateStatement(boolean alwaysPopulateStatement) {
this.alwaysPopulateStatement = alwaysPopulateStatement;
}
}
