1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.monitoring.web.jsp;
19
20 import org.apache.commons.monitoring.stopwatches.StopWatch;
21
22 import javax.servlet.jsp.JspException;
23 import javax.servlet.jsp.tagext.TagSupport;
24
25 import static org.apache.commons.monitoring.web.jsp.TagUtils.getScope;
26
27 /**
28 * A JSP tag to counter JSP rendering performances
29 *
30 * @author <a href="mailto:nicolas@apache.org">Nicolas De Loof</a>
31 */
32 public class StopTag extends TagSupport {
33 private String id;
34 private String scope;
35
36 /**
37 * @param id the id to set
38 */
39 public void setId(String id) {
40 this.id = id;
41 }
42
43 /**
44 * {@inheritDoc}
45 *
46 * @see javax.servlet.jsp.tagext.TagSupport#doStartTag()
47 */
48 @Override
49 public int doStartTag() throws JspException {
50 StopWatch stopWatch;
51 if (scope != null) {
52 stopWatch = (StopWatch) pageContext.getAttribute(id, getScope(scope));
53 } else {
54 stopWatch = (StopWatch) pageContext.getAttribute(id);
55 }
56 if (stopWatch == null) {
57 throw new JspException("No StopWatch under ID " + id + " and scope " + scope);
58 }
59 stopWatch.stop();
60 return EVAL_PAGE;
61 }
62
63 /**
64 * @param scope the scope to set
65 */
66 public void setScope(final String scope) {
67 this.scope = scope;
68 }
69 }