KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > taglibs > request > ExistsHeaderTag


1 /*
2  * Copyright 1999,2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.taglibs.request;
18
19 import java.util.*;
20 import javax.servlet.*;
21 import javax.servlet.http.*;
22 import javax.servlet.jsp.*;
23 import javax.servlet.jsp.tagext.*;
24
25 /**
26  * JSP Tag <b>existsHeader</b>, used to determine if an HttpServletRequest
27  * header exists.
28  * <p>
29  * Includes the body of the tag if the header exists.
30  * <p>
31  * You can set the optional tag header <b>value</b> to <i>true</i> or
32  * <i>false</i>. The body of the tag is included if existsHeader matches
33  * the value.
34  * <p>
35  * JSP Tag Lib Descriptor
36  * <p><pre>
37  * &lt;name&gt;existsHeader&lt;/name&gt;
38  * &lt;tagclass&gt;org.apache.taglibs.request.ExistsHeaderTag&lt;/tagclass&gt;
39  * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
40  * &lt;info&gt;Includes the body of the tag if the request header exists.&lt;/info&gt;
41  * &lt;attribute&gt;
42  * &lt;name&gt;name&lt;/name&gt;
43  * &lt;required&gt;true&lt;/required&gt;
44  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
45  * &lt;/attribute&gt;
46  * &lt;attribute&gt;
47  * &lt;name&gt;value&lt;/name&gt;
48  * &lt;required&gt;false&lt;/required&gt;
49  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
50  * &lt;/attribute&gt;
51  * </pre>
52  *
53  * @author Glenn Nielsen
54  */
55
56 public class ExistsHeaderTag extends TagSupport
57 {
58     // Required attribute, name of HTTP header
59 private String JavaDoc name = null;
60     // Optional value to test existance
61 private boolean value = true;
62
63     /**
64      * Includes the body of the tag if the request header exists.
65      *
66      * @return SKIP_BODY if existsHeader doesn't match value, EVAL_BODY_include if existsHeader matches value
67      */
68     public final int doStartTag() throws JspException
69     {
70     boolean result = false;
71     if( ((HttpServletRequest)pageContext.getRequest()).getHeader(name) != null )
72         result = true;
73
74     if( value == result )
75         return EVAL_BODY_INCLUDE;
76
77     return SKIP_BODY;
78     }
79
80     /**
81      * Set the required tag attribute <b>name</b>.
82      *
83      * @param String name of HTTP header
84      */
85     public final void setName(String JavaDoc str)
86     {
87     name = str;
88     }
89
90     /**
91      * Set the optional tag attribute <b>value</b> to true or false.
92      *
93      * @param boolean true or false
94      */
95     public final void setValue(boolean value)
96     {
97     this.value = value;
98     }
99
100 }
101
Popular Tags