001 /**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.camel.spring.spi;
018
019 import org.apache.camel.Processor;
020 import org.apache.camel.builder.ErrorHandlerBuilder;
021 import org.apache.camel.builder.ErrorHandlerBuilderRef;
022 import org.apache.camel.model.ProcessorDefinition;
023 import org.apache.camel.spi.RouteContext;
024 import org.apache.camel.spi.TransactedPolicy;
025 import org.apache.camel.util.ObjectHelper;
026 import org.slf4j.Logger;
027 import org.slf4j.LoggerFactory;
028 import org.springframework.transaction.PlatformTransactionManager;
029 import org.springframework.transaction.support.TransactionTemplate;
030
031 /**
032 * Wraps the processor in a Spring transaction
033 *
034 * @version
035 */
036 public class SpringTransactionPolicy implements TransactedPolicy {
037 private static final transient Logger LOG = LoggerFactory.getLogger(SpringTransactionPolicy.class);
038 private TransactionTemplate template;
039 private String propagationBehaviorName;
040 private PlatformTransactionManager transactionManager;
041
042 /**
043 * Default constructor for easy spring configuration.
044 */
045 public SpringTransactionPolicy() {
046 }
047
048 public SpringTransactionPolicy(TransactionTemplate template) {
049 this.template = template;
050 }
051
052 public SpringTransactionPolicy(PlatformTransactionManager transactionManager) {
053 this.transactionManager = transactionManager;
054 }
055
056 public void beforeWrap(RouteContext routeContext, ProcessorDefinition<?> definition) {
057 }
058
059 public Processor wrap(RouteContext routeContext, Processor processor) {
060 TransactionErrorHandler answer;
061
062 // the goal is to configure the error handler builder on the route as a transacted error handler,
063 // either its already a transacted or if not we replace it with a transacted one that we configure here
064 // and wrap the processor in the transacted error handler as we can have transacted routes that change
065 // propagation behavior, eg: from A required -> B -> requiresNew C (advanced use-case)
066 // if we should not support this we do not need to wrap the processor as we only need one transacted error handler
067
068 // find the existing error handler builder
069 ErrorHandlerBuilder builder = routeContext.getRoute().getErrorHandlerBuilder();
070
071 // check if its a ref if so then do a lookup
072 if (builder instanceof ErrorHandlerBuilderRef) {
073 // its a reference to a error handler so lookup the reference
074 ErrorHandlerBuilderRef builderRef = (ErrorHandlerBuilderRef) builder;
075 String ref = builderRef.getRef();
076 // only lookup if there was explicit an error handler builder configured
077 // otherwise its just the "default" that has not explicit been configured
078 // and if so then we can safely replace that with our transacted error handler
079 if (ErrorHandlerBuilderRef.isErrorHandlerBuilderConfigured(ref)) {
080 if (LOG.isDebugEnabled()) {
081 LOG.debug("Looking up ErrorHandlerBuilder with ref: " + ref);
082 }
083 builder = ErrorHandlerBuilderRef.lookupErrorHandlerBuilder(routeContext, ref);
084 }
085 }
086
087 if (builder != null && builder.supportTransacted()) {
088 // already a TX error handler then we are good to go
089 if (LOG.isDebugEnabled()) {
090 LOG.debug("The ErrorHandlerBuilder configured is already a TransactionErrorHandlerBuilder: " + builder);
091 }
092 answer = createTransactionErrorHandler(routeContext, processor, builder);
093 answer.setExceptionPolicy(builder.getExceptionPolicyStrategy());
094 // configure our answer based on the existing error handler
095 builder.configure(answer);
096 } else {
097 // no transaction error handler builder configure so create a temporary one as we got all
098 // the needed information form the configured builder anyway this allow us to use transacted
099 // routes anyway even though the error handler is not transactional, eg ease of configuration
100 if (LOG.isDebugEnabled()) {
101 if (builder != null) {
102 LOG.debug("The ErrorHandlerBuilder configured is not a TransactionErrorHandlerBuilder: " + builder);
103 } else {
104 LOG.debug("No ErrorHandlerBuilder configured, will use default TransactionErrorHandlerBuilder settings");
105 }
106 }
107 TransactionErrorHandlerBuilder txBuilder = new TransactionErrorHandlerBuilder();
108 txBuilder.setTransactionTemplate(getTransactionTemplate());
109 txBuilder.setSpringTransactionPolicy(this);
110 if (builder != null) {
111 // use error handlers from the configured builder
112 txBuilder.setErrorHandlers(builder.getErrorHandlers());
113 }
114 answer = createTransactionErrorHandler(routeContext, processor, txBuilder);
115 answer.setExceptionPolicy(txBuilder.getExceptionPolicyStrategy());
116 // configure our answer based on the existing error handler
117 txBuilder.configure(answer);
118
119 // set the route to use our transacted error handler builder
120 routeContext.getRoute().setErrorHandlerBuilder(txBuilder);
121 }
122
123 // return with wrapped transacted error handler
124 return answer;
125 }
126
127 protected TransactionErrorHandler createTransactionErrorHandler(RouteContext routeContext, Processor processor, ErrorHandlerBuilder builder) {
128 TransactionErrorHandler answer;
129 try {
130 answer = (TransactionErrorHandler) builder.createErrorHandler(routeContext, processor);
131 } catch (Exception e) {
132 throw ObjectHelper.wrapRuntimeCamelException(e);
133 }
134 return answer;
135 }
136
137 public TransactionTemplate getTransactionTemplate() {
138 if (template == null) {
139 ObjectHelper.notNull(transactionManager, "transactionManager");
140 template = new TransactionTemplate(transactionManager);
141 if (propagationBehaviorName != null) {
142 template.setPropagationBehaviorName(propagationBehaviorName);
143 }
144 }
145 return template;
146 }
147
148 public void setTransactionTemplate(TransactionTemplate template) {
149 this.template = template;
150 }
151
152 public void setTransactionManager(PlatformTransactionManager transactionManager) {
153 this.transactionManager = transactionManager;
154 }
155
156 public PlatformTransactionManager getTransactionManager() {
157 return transactionManager;
158 }
159
160 public void setPropagationBehaviorName(String propagationBehaviorName) {
161 this.propagationBehaviorName = propagationBehaviorName;
162 }
163
164 public String getPropagationBehaviorName() {
165 return propagationBehaviorName;
166 }
167 }