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.api.management;
018    
019    import org.apache.camel.Exchange;
020    
021    /**
022     * A counter that gathers performance metrics when an {@link org.apache.camel.Exchange} is routed in Camel.
023     *
024     * @version 
025     */
026    public interface PerformanceCounter {
027    
028        /**
029         * Executed when an {@link org.apache.camel.Exchange} is complete.
030         *
031         * @param exchange the exchange
032         * @param time the time it took in millis to complete
033         */
034        void completedExchange(Exchange exchange, long time);
035    
036        /**
037         * Executed when an {@link org.apache.camel.Exchange} failed.
038         *
039         * @param exchange the exchange
040         */
041        void failedExchange(Exchange exchange);
042    
043        /**
044         * Are statistics enabled?
045         * <p/>
046         * They can be enabled and disabled at runtime
047         *
048         * @return whether statistics are enabled or not
049         */
050        boolean isStatisticsEnabled();
051    
052        /**
053         * Sets whether statistics are enabled.
054         * <p/>
055         * They can be enabled and disabled at runtime
056         *
057         * @param statisticsEnabled whether statistics are enabled or not
058         */
059        void setStatisticsEnabled(boolean statisticsEnabled);
060    
061    }