KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > taglibs > session > SetAttributeTag


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.session;
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>setAttribute</b>, used to set an HttpSession
27  * attribute with name <b>name</b> to a String from the body of the tag.
28  * <p>
29  * JSP Tag Lib Descriptor
30  * <p><pre>
31  * &lt;name&gt;setAttribute&lt;/name&gt;
32  * &lt;tagclass&gt;org.apache.taglibs.session.SetAttributeTag&lt;/tagclass&gt;
33  * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
34  * &lt;info&gt;Sets the value of the session attribute to the content of the tag body.&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 SetAttributeTag extends BodyTagSupport
46 {
47     // Name of the session attribute to set a value for
48 private String JavaDoc name = null;
49
50     /**
51      * Returns EVAL_BODY_TAG so the body of the tag can be evaluated.
52      *
53      * @return EVAL_BODY_TAG
54      */
55     public final int doStartTag() throws JspException
56     {
57     return EVAL_BODY_TAG;
58     }
59
60     /**
61      * Read the body of the setAttribute tag to obtain the attribute value,
62      * then set the attribute with <b>name</b> to that value.
63      *
64      * @return SKIP_BODY
65      */
66     public final int doAfterBody() throws JspException
67     {
68     // Use the body of the tag as attribute value
69 BodyContent body = getBodyContent();
70     String JavaDoc s = body.getString();
71     // Clear the body since we only used it as input for the attribute
72 // value
73 body.clearBody();
74     // set the attribute
75 pageContext.getSession().setAttribute(name,(Object JavaDoc)s);
76     return SKIP_BODY;
77     }
78
79     /**
80      * Set the required tag attribute <b>name</b>.
81      *
82      * @param String name of session attribute
83      */
84     public final void setName(String JavaDoc str)
85     {
86     name = str;
87     }
88
89 }
90
Popular Tags