|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
IMonitor.java | - | - | - | - |
|
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.engine; | |
16 | ||
17 | /** | |
18 | * Basic support for application monitoring and metrics. | |
19 | * This interface defines events; the implementation | |
20 | * decides what to do with them (such as record them to a database). | |
21 | * | |
22 | * @author Howard Lewis Ship | |
23 | * | |
24 | **/ | |
25 | ||
26 | public interface IMonitor | |
27 | { | |
28 | /** | |
29 | * Invoked before constructing a page. | |
30 | * | |
31 | **/ | |
32 | ||
33 | public void pageCreateBegin(String pageName); | |
34 | ||
35 | /** | |
36 | * Invoked after successfully constructing a page and all of its components. | |
37 | * | |
38 | **/ | |
39 | ||
40 | public void pageCreateEnd(String pageName); | |
41 | ||
42 | /** | |
43 | * Invoked when a page is loaded. This includes time to locate or create an instance | |
44 | * of the page and rollback its state (to any previously recorded value). | |
45 | * | |
46 | **/ | |
47 | ||
48 | public void pageLoadBegin(String pageName); | |
49 | ||
50 | /** | |
51 | * Invoked once a page is completely loaded and rolled back to its prior state. | |
52 | * | |
53 | **/ | |
54 | ||
55 | public void pageLoadEnd(String pageName); | |
56 | ||
57 | /** | |
58 | * Invoked before a page render begins. | |
59 | * | |
60 | **/ | |
61 | ||
62 | public void pageRenderBegin(String pageName); | |
63 | ||
64 | /** | |
65 | * Invoked after a page has succesfully rendered. | |
66 | * | |
67 | **/ | |
68 | ||
69 | public void pageRenderEnd(String pageName); | |
70 | ||
71 | /** | |
72 | * Invoked before a page rewind (to respond to an action) begins. | |
73 | * | |
74 | **/ | |
75 | ||
76 | public void pageRewindBegin(String pageName); | |
77 | ||
78 | /** | |
79 | * Invoked after a page has succesfully been rewound (which includes | |
80 | * any activity related to the action listener). | |
81 | * | |
82 | **/ | |
83 | ||
84 | public void pageRewindEnd(String pageName); | |
85 | ||
86 | /** | |
87 | * Invoked when a service begins processing. | |
88 | * | |
89 | **/ | |
90 | ||
91 | public void serviceBegin(String serviceName, String detailMessage); | |
92 | ||
93 | /** | |
94 | * Invoked when a service successfully ends. | |
95 | * | |
96 | **/ | |
97 | ||
98 | public void serviceEnd(String serviceName); | |
99 | ||
100 | /** | |
101 | * Invoked when a service throws an exception rather than completing normally. | |
102 | * Processing of the request may continue with the display of an exception | |
103 | * page. | |
104 | * | |
105 | * <p> | |
106 | * serviceException() is always invoked <em>before</em> | |
107 | * {@link #serviceEnd(String)}. | |
108 | * | |
109 | **/ | |
110 | ||
111 | public void serviceException(Throwable exception); | |
112 | ||
113 | /** | |
114 | * Invoked when a session is initiated. This is typically | |
115 | * done from the implementation of the home service. | |
116 | * | |
117 | **/ | |
118 | ||
119 | public void sessionBegin(); | |
120 | } |
|