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