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