001 package org.apache.fulcrum.yaafi.interceptor.jamon;
002 /*
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements. See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership. The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License. You may obtain a copy of the License at
010 *
011 * http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied. See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 */
020
021 /**
022 * Expose the start()/stop() methods for performance monitors independent from their concrete
023 * implementation.
024 *
025 * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
026 */
027
028 public interface JamonPerformanceMonitor
029 {
030 /** Start the monitor. */
031 public void start();
032
033 /** Stop the monitor. */
034 public void stop();
035
036 /**
037 * Stop the monitor based on an Throwable.
038 * @param throwable the throwable
039 */
040 public void stop(Throwable throwable);
041
042 /**
043 * Create a performance report
044 * @return the textual performance report
045 * @throws Exception generating the report failed
046 */
047 public String createReport() throws Exception;
048 }