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 */
017package org.apache.camel;
018
019
020/**
021 * An exception caused by a specific message {@link Exchange}
022 *
023 * @version 
024 */
025public class CamelExchangeException extends CamelException {
026    private static final long serialVersionUID = -8721487431101572630L;
027    // exchange is not guaranteed to be serializable so we set it as transient
028    private final transient Exchange exchange;
029
030    public CamelExchangeException(String message, Exchange exchange) {
031        super(CamelExchangeException.createExceptionMessage(message, exchange, null));
032        this.exchange = exchange;
033    }
034
035    public CamelExchangeException(String message, Exchange exchange, Throwable cause) {
036        super(CamelExchangeException.createExceptionMessage(message, exchange, cause), cause);
037        this.exchange = exchange;
038    }
039
040    /**
041     * Returns the exchange which caused the exception
042     */
043    public Exchange getExchange() {
044        return exchange;
045    }
046
047    /**
048     * Creates an exception message with the provided details.
049     * <p/>
050     * All fields is optional so you can pass in only an exception, or just a message etc. or any combination.
051     *
052     * @param message  the message
053     * @param exchange the exchange
054     * @param cause    the caused exception
055     * @return an error message (without stacktrace from exception)
056     */
057    public static String createExceptionMessage(String message, Exchange exchange, Throwable cause) {
058        StringBuilder sb = new StringBuilder();
059        if (message != null) {
060            sb.append(message);
061        }
062        if (exchange != null) {
063            if (sb.length() > 0) {
064                sb.append(". ");
065            }
066            sb.append(exchange);
067        }
068        if (cause != null) {
069            if (sb.length() > 0) {
070                sb.append(". ");
071            }
072            sb.append("Caused by: [" + cause.getClass().getName() + " - " + cause.getMessage() + "]");
073        }
074        return sb.toString().trim();
075    }
076
077}