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