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 <throttler/> element
034     *
035     * @version $Revision: 41908 $
036     */
037    @XmlRootElement(name = "throttler")
038    @XmlAccessorType(XmlAccessType.FIELD)
039    public class ThrottlerType extends ProcessorType<ProcessorType> {
040        @XmlAttribute
041        private Long maximumRequestsPerPeriod;
042        @XmlAttribute
043        private long timePeriodMillis = 1000;
044        @XmlElementRef
045        private List<ProcessorType<?>> outputs = new ArrayList<ProcessorType<?>>();
046    
047        public ThrottlerType() {
048        }
049    
050        public ThrottlerType(long maximumRequestsPerPeriod) {
051            this.maximumRequestsPerPeriod = maximumRequestsPerPeriod;
052        }
053    
054        @Override
055        public String toString() {
056            return "Throttler[" + getMaximumRequestsPerPeriod() + " request per " + getTimePeriodMillis()
057                   + " millis -> " + getOutputs() + "]";
058        }
059    
060        @Override
061        public String getLabel() {
062            return "" + getMaximumRequestsPerPeriod() + " per " + getTimePeriodMillis() + " (ms)";
063        }
064    
065        @Override
066        public Processor createProcessor(RouteContext routeContext) throws Exception {
067            Processor childProcessor = routeContext.createProcessor(this);
068            return new Throttler(childProcessor, maximumRequestsPerPeriod, timePeriodMillis);
069        }
070    
071        // Fluent API
072        // -------------------------------------------------------------------------
073    
074        /**
075         * Sets the time period during which the maximum request count is valid for
076         */
077        public ThrottlerType timePeriodMillis(long timePeriodMillis) {
078            this.timePeriodMillis = timePeriodMillis;
079            return this;
080        }
081    
082        // Properties
083        // -------------------------------------------------------------------------
084    
085        public Long getMaximumRequestsPerPeriod() {
086            return maximumRequestsPerPeriod;
087        }
088    
089        public void setMaximumRequestsPerPeriod(Long maximumRequestsPerPeriod) {
090            this.maximumRequestsPerPeriod = maximumRequestsPerPeriod;
091        }
092    
093        public long getTimePeriodMillis() {
094            return timePeriodMillis;
095        }
096    
097        public void setTimePeriodMillis(long timePeriodMillis) {
098            this.timePeriodMillis = timePeriodMillis;
099        }
100    
101        public List<ProcessorType<?>> getOutputs() {
102            return outputs;
103        }
104    
105        public void setOutputs(List<ProcessorType<?>> outputs) {
106            this.outputs = outputs;
107        }
108    }