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;
018    
019    /**
020     * An exception caused when a mandatory property is not available on a message
021     * {@link Exchange}
022     * 
023     * @see org.apache.camel.util.ExchangeHelper#getMandatoryProperty(Exchange, String, Class)
024     * 
025     * @version 
026     */
027    public class NoSuchPropertyException extends CamelExchangeException {
028        private static final long serialVersionUID = -8721487431101572630L;
029        private final String propertyName;
030        private final transient Class<?> type;
031    
032        public NoSuchPropertyException(Exchange exchange, String propertyName, Class<?> type) {
033            super("No '" + propertyName + "' property available of type: " + type.getName()
034                  + reason(exchange, propertyName), exchange);
035            this.propertyName = propertyName;
036            this.type = type;
037        }
038    
039        public String getPropertyName() {
040            return propertyName;
041        }
042    
043        public Class<?> getType() {
044            return type;
045        }
046    
047        protected static String reason(Exchange exchange, String propertyName) {
048            Object value = exchange.getProperty(propertyName);
049            return valueDescription(value);
050        }
051    
052        static String valueDescription(Object value) {
053            if (value == null) {
054                return "";
055            }
056            return " but has value: " + value + " of type: " + value.getClass().getCanonicalName();
057        }
058    }