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.impl;
018    
019    import java.util.HashMap;
020    import java.util.Map;
021    
022    import org.apache.camel.CamelContext;
023    import org.apache.camel.Component;
024    import org.apache.camel.Consumer;
025    import org.apache.camel.ResolveEndpointFailedException;
026    import org.apache.camel.util.EndpointHelper;
027    import org.apache.camel.util.IntrospectionSupport;
028    
029    /**
030     * A base class for {@link org.apache.camel.Endpoint} which creates a {@link ScheduledPollConsumer}
031     *
032     * @version $Revision: 16342 $
033     */
034    public abstract class ScheduledPollEndpoint extends DefaultEndpoint {
035        private Map<String, Object> consumerProperties;
036    
037        protected ScheduledPollEndpoint(String endpointUri, Component component) {
038            super(endpointUri, component);
039        }
040    
041        protected ScheduledPollEndpoint(String endpointUri, CamelContext context) {
042            super(endpointUri, context);
043        }
044    
045        protected ScheduledPollEndpoint(String endpointUri) {
046            super(endpointUri);
047        }
048    
049        protected ScheduledPollEndpoint() {
050        }
051    
052        public Map<String, Object> getConsumerProperties() {
053            return consumerProperties;
054        }
055    
056        public void setConsumerProperties(Map<String, Object> consumerProperties) {
057            this.consumerProperties = consumerProperties;
058        }
059    
060        protected void configureConsumer(Consumer consumer) throws Exception {
061            if (consumerProperties != null) {
062                // set reference properties first as they use # syntax that fools the regular properties setter
063                EndpointHelper.setReferenceProperties(getCamelContext(), consumer, consumerProperties);
064                EndpointHelper.setProperties(getCamelContext(), consumer, consumerProperties);
065                if (!this.isLenientProperties() && consumerProperties.size() > 0) {
066                    throw new ResolveEndpointFailedException(this.getEndpointUri(), "There are " + consumerProperties.size()
067                        + " parameters that couldn't be set on the endpoint consumer."
068                        + " Check the uri if the parameters are spelt correctly and that they are properties of the endpoint."
069                        + " Unknown consumer parameters=[" + consumerProperties + "]");
070                }
071            }
072        }
073    
074        public void configureProperties(Map<String, Object> options) {
075            Map<String, Object> consumerProperties = IntrospectionSupport.extractProperties(options, "consumer.");
076            if (consumerProperties != null) {
077                setConsumerProperties(consumerProperties);
078            }
079            configureScheduledPollConsumerProperties(options, consumerProperties);
080        }
081    
082        private void configureScheduledPollConsumerProperties(Map<String, Object> options, Map<String, Object> consumerProperties) {
083            // special for scheduled poll consumers as we want to allow end users to configure its options
084            // from the URI parameters without the consumer. prefix
085            Object initialDelay = options.remove("initialDelay");
086            Object delay = options.remove("delay");
087            Object timeUnit = options.remove("timeUnit");
088            Object useFixedDelay = options.remove("useFixedDelay");
089            Object pollStrategy = options.remove("pollStrategy");
090            if (initialDelay != null || delay != null || timeUnit != null || useFixedDelay != null || pollStrategy != null) {
091                if (consumerProperties == null) {
092                    consumerProperties = new HashMap<String, Object>();
093                }
094                if (initialDelay != null) {
095                    consumerProperties.put("initialDelay", initialDelay);
096                }
097                if (delay != null) {
098                    consumerProperties.put("delay", delay);
099                }
100                if (timeUnit != null) {
101                    consumerProperties.put("timeUnit", timeUnit);
102                }
103                if (useFixedDelay != null) {
104                    consumerProperties.put("useFixedDelay", useFixedDelay);
105                }
106                if (pollStrategy != null) {
107                    consumerProperties.put("pollStrategy", pollStrategy);
108                }
109            }
110        }
111    }