KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Yasna > forum > tags > SetYazdPropertyTag


1 /**
2  * Copyright (C) 2001 Yasna.com. All rights reserved.
3  *
4  * ===================================================================
5  * The Apache Software License, Version 1.1
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by
22  * Yasna.com (http://www.yasna.com)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Yazd" and "Yasna.com" must not be used to
27  * endorse or promote products derived from this software without
28  * prior written permission. For written permission, please
29  * contact yazd@yasna.com.
30  *
31  * 5. Products derived from this software may not be called "Yazd",
32  * nor may "Yazd" appear in their name, without prior written
33  * permission of Yasna.com.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL YASNA.COM OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of Yasna.com. For more information
51  * on Yasna.com, please see <http://www.yasna.com>.
52  */

53
54 /**
55  * Copyright (C) 2000 CoolServlets.com. All rights reserved.
56  *
57  * ===================================================================
58  * The Apache Software License, Version 1.1
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  * notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  * notice, this list of conditions and the following disclaimer in
69  * the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3. The end-user documentation included with the redistribution,
73  * if any, must include the following acknowledgment:
74  * "This product includes software developed by
75  * CoolServlets.com (http://www.coolservlets.com)."
76  * Alternately, this acknowledgment may appear in the software itself,
77  * if and wherever such third-party acknowledgments normally appear.
78  *
79  * 4. The names "Jive" and "CoolServlets.com" must not be used to
80  * endorse or promote products derived from this software without
81  * prior written permission. For written permission, please
82  * contact webmaster@coolservlets.com.
83  *
84  * 5. Products derived from this software may not be called "Jive",
85  * nor may "Jive" appear in their name, without prior written
86  * permission of CoolServlets.com.
87  *
88  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
89  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
90  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
91  * DISCLAIMED. IN NO EVENT SHALL COOLSERVLETS.COM OR
92  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
93  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
94  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
95  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
96  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
97  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
98  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
99  * SUCH DAMAGE.
100  * ====================================================================
101  *
102  * This software consists of voluntary contributions made by many
103  * individuals on behalf of CoolServlets.com. For more information
104  * on CoolServlets.com, please see <http://www.coolservlets.com>.
105  */

106
107 package com.Yasna.forum.tags;
108
109 import java.io.*;
110 import javax.servlet.*;
111 import javax.servlet.jsp.*;
112 import javax.servlet.jsp.tagext.*;
113 import javax.servlet.http.*;
114 import com.Yasna.forum.tags.*;
115
116 /**
117  * JSP Tag <b>setYazdProperty</b>, used with <b>create</b>,
118  * <b>account</b>, <b>user</b>, <b>forum</b>, <b>message</b>, and
119  * <b>post</b> tags to get a yazd extended property.
120  * <p>
121  * Requires that attribute <b>name</b> be set to the name of the
122  * script variable for the parent tag.
123  * <p>
124  * Requires that attribute <b>property</b> be set to the name of
125  * an extended property.
126  * <p>
127  * Must be nested within a <b>create</b>, <b>account</b>, <b>user</b>,
128  * <b>forum</b>, <b>message</b>, or <b>post</b> tag.
129  * <p>
130  * The extended property value is set to the body of the tag.
131  * <p>
132  * Extended User Properties are defined in yazd.user.properties.
133  * <p>
134  * JSP Tag Lib Descriptor
135  * <p><pre>
136  * &lt;name&gt;setYazdProperty&lt;/name&gt;
137  * &lt;tagclass&gt;com.Yasna.forum.tags.SetYazdPropertyTag&lt;/tagclass&gt;
138  * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
139  * &lt;info&gt;Gets a yazd extended property value.&lt;/info&gt;
140  * &lt;attribute&gt;
141  * &lt;name&gt;name&lt;/name&gt;
142  * &lt;required&gt;true&lt;/required&gt;
143  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
144  * &lt;/attribute&gt;
145  * &lt;attribute&gt;
146  * &lt;name&gt;property&lt;/name&gt;
147  * &lt;required&gt;true&lt;/required&gt;
148  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
149  * &lt;/attribute&gt;
150  * </pre>
151  *
152  * @see YazdProperty
153  * @see AccountTag
154  * @see CreateTag
155  * @see UserTag
156  * @see ForumTag
157  * @see MessageTag
158  * @see PostTag
159  *
160  * @author Glenn Nielsen
161  */

162
163 public class SetYazdPropertyTag extends BodyTagSupport
164 {
165   private String JavaDoc name = null;
166   private String JavaDoc property = null;
167   private String JavaDoc val;
168
169   /**
170    * Method called at start of tag, just returns EVAL_BODY_TAG
171    *
172    * @return EVAL_BODY_TAG
173    */

174   public final int doStartTag() throws JspException
175   {
176     return EVAL_BODY_TAG;
177   }
178
179   /**
180    * Read the body of the setYazdProperty tag to obtain the value
181    * of an extended yazd property.
182    *
183    * @return SKIP_BODY
184    */

185   public final int doAfterBody() throws JspException
186   {
187     // Use the body of the tag as the value of property
188
BodyContent body = getBodyContent();
189     String JavaDoc s = body.getString();
190     // Clear the body since we use it as the value of a property
191
body.clearBody();
192
193     // Get the parent tag
194
YazdProperty jp =
195         (YazdProperty)pageContext.getAttribute(name.toString(),
196         PageContext.PAGE_SCOPE);
197     // Get the property value
198
if( jp != null ) {
199       jp.setProperty(property,s);
200     }
201     return SKIP_BODY;
202   }
203
204   /**
205    * Set the name of the parent tag script variable
206    */

207   public final void setName(String JavaDoc nam)
208   {
209     name = nam;
210   }
211
212   /**
213    * Set the name of the extended property to get
214    */

215   public final void setProperty(String JavaDoc prop)
216   {
217     property = prop;
218   }
219 }
220
Popular Tags