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