1 package org.apache.fulcrum.yaafi.interceptor.jamon;
2 /*
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 */
20
21 /**
22 * Expose the start()/stop() methods for performance monitors independent from their concrete
23 * implementation.
24 *
25 * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
26 */
27
28 public interface JamonPerformanceMonitor
29 {
30 /** Start the monitor. */
31 void start();
32
33 /** Stop the monitor. */
34 void stop();
35
36 /**
37 * Stop the monitor based on an Throwable.
38 * @param throwable the throwable
39 */
40 void stop(Throwable throwable);
41
42 /**
43 * Create a performance report
44 * @return the textual performance report
45 * @throws Exception generating the report failed
46 */
47 String createReport() throws Exception;
48 }