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