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.model;
018    
019    import java.util.ArrayList;
020    import java.util.List;
021    
022    import javax.xml.bind.annotation.XmlAccessType;
023    import javax.xml.bind.annotation.XmlAccessorType;
024    import javax.xml.bind.annotation.XmlAttribute;
025    import javax.xml.bind.annotation.XmlElementRef;
026    import javax.xml.bind.annotation.XmlRootElement;
027    
028    import org.apache.camel.Processor;
029    import org.apache.camel.processor.Throttler;
030    import org.apache.camel.spi.RouteContext;
031    
032    /**
033     * Represents an XML <throttle/> element
034     *
035     * @version $Revision: 751373 $
036     */
037    @XmlRootElement(name = "throttle")
038    @XmlAccessorType(XmlAccessType.FIELD)
039    public class ThrottleDefinition extends ProcessorDefinition<ProcessorDefinition> {
040        @XmlAttribute
041        private Long maximumRequestsPerPeriod;
042        @XmlAttribute
043        private long timePeriodMillis = 1000;
044        @XmlElementRef
045        private List<ProcessorDefinition> outputs = new ArrayList<ProcessorDefinition>();
046    
047        public ThrottleDefinition() {
048        }
049    
050        public ThrottleDefinition(long maximumRequestsPerPeriod) {
051            this.maximumRequestsPerPeriod = maximumRequestsPerPeriod;
052        }
053    
054        @Override
055        public String toString() {
056            return "Throttle[" + getMaximumRequestsPerPeriod() + " request per " + getTimePeriodMillis()
057                   + " millis -> " + getOutputs() + "]";
058        }
059    
060        @Override
061        public String getShortName() {
062            return "throttle";
063        }
064    
065        @Override
066        public String getLabel() {
067            return "" + getMaximumRequestsPerPeriod() + " per " + getTimePeriodMillis() + " (ms)";
068        }
069    
070        @Override
071        public Processor createProcessor(RouteContext routeContext) throws Exception {
072            Processor childProcessor = routeContext.createProcessor(this);
073            return new Throttler(childProcessor, maximumRequestsPerPeriod, timePeriodMillis);
074        }
075    
076        // Fluent API
077        // -------------------------------------------------------------------------
078    
079        /**
080         * Sets the time period during which the maximum request count is valid for
081         *
082         * @param timePeriodMillis  period in millis
083         * @return the builder
084         */
085        public ThrottleDefinition timePeriodMillis(long timePeriodMillis) {
086            setTimePeriodMillis(timePeriodMillis);
087            return this;
088        }
089        
090        /**
091         * Sets the time period during which the maximum request count per period
092         *
093         * @param maximumRequestsPerPeriod  the maximum request count number per time period
094         * @return the builder
095         */
096        public ThrottleDefinition maximumRequestsPerPeriod(Long maximumRequestsPerPeriod) {
097            setMaximumRequestsPerPeriod(maximumRequestsPerPeriod);
098            return this;
099        }
100    
101        // Properties
102        // -------------------------------------------------------------------------
103    
104        public Long getMaximumRequestsPerPeriod() {
105            return maximumRequestsPerPeriod;
106        }
107    
108        public void setMaximumRequestsPerPeriod(Long maximumRequestsPerPeriod) {
109            this.maximumRequestsPerPeriod = maximumRequestsPerPeriod;
110        }
111    
112        public long getTimePeriodMillis() {
113            return timePeriodMillis;
114        }
115    
116        public void setTimePeriodMillis(long timePeriodMillis) {
117            this.timePeriodMillis = timePeriodMillis;
118        }
119    
120        public List<ProcessorDefinition> getOutputs() {
121            return outputs;
122        }
123    
124        public void setOutputs(List<ProcessorDefinition> outputs) {
125            this.outputs = outputs;
126        }
127    }