KickJava   Java API By Example, From Geeks To Geeks.

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


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>header</b>, used to output the value of an
27  * HttpServletRequest header with name <b>name</b>.
28  * <p>
29  * JSP Tag Lib Descriptor
30  * <p><pre>
31  * &lt;name&gt;header&lt;/name&gt;
32  * &lt;tagclass&gt;org.apache.taglibs.request.HeaderTag&lt;/tagclass&gt;
33  * &lt;bodycontent&gt;empty&lt;/bodycontent&gt;
34  * &lt;info&gt;Get the value of a single request header.&lt;/info&gt;
35  * &lt;attribute&gt;
36  * &lt;name&gt;name&lt;/name&gt;
37  * &lt;required&gt;true&lt;/required&gt;
38  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
39  * &lt;/attribute&gt;
40  * </pre>
41  *
42  * @author Glenn Nielsen
43  */
44
45 public class HeaderTag extends TagSupport
46 {
47     // Required attribute, name of HTTP header
48 private String JavaDoc name = null;
49
50     /**
51      * Method called at end of Tag to output header value
52      *
53      * @return EVAL_PAGE
54      */
55     public final int doEndTag() throws JspException
56     {
57         String JavaDoc value =
58             ((HttpServletRequest)pageContext.getRequest()).getHeader(name);
59         if( value == null )
60             value = "";
61  
62         try {
63             pageContext.getOut().write(value);
64         } catch(Exception JavaDoc e) {
65             throw new JspException("IO Error: " + e.getMessage());
66         }
67     return EVAL_PAGE;
68     }
69
70     /**
71      * Set the required tag attribute <b>name</b>.
72      *
73      * @param String name of HTTP header
74      */
75     public final void setName(String JavaDoc str)
76     {
77     name = str;
78     }
79
80 }
81
Popular Tags