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