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