GetYazdPropertyTag


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>getYazdProperty</b>, used with <b>create</b>,
118  * <b>account</b>, <b>user</b>, <b>forum</b>, <b>post</b>, and <b>message</b>
119  *  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>post</b>, or <b>message</b> tag.
129  * <p>
130  * Always ignores 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;getYazdProperty&lt;/name&gt;
137  *  &lt;tagclass&gt;com.Yasna.forum.tags.GetYazdPropertyTag&lt;/tagclass&gt;
138  *  &lt;bodycontent&gt;empty&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 GetYazdProperty
153  * @see AccountTag
154  * @see CreateTag
155  * @see UserTag
156  * @see ForumTag
157  * @see MessageTag
158  *
159  * @author Glenn Nielsen
160  */
161 
162 public class GetYazdPropertyTag extends TagSupport
163 {
164   private String   name = null;
165   private String   property = null;
166   private String   val;
167 
168   /**
169    * Method called at start of getYazdProperty Tag to get the extended
170    * Yazd property.
171    *
172    * @return SKIP_BODY
173    */
174   public final int doStartTag() throws JspException
175   {
176     // Get the parent tag
177     YazdProperty jp =
178     (YazdProperty)pageContext.getAttribute(name, PageContext.PAGE_SCOPE);
179     // Get the property value
180     if( jp != null ) {
181       val = jp.getProperty(property);
182     }
183 
184     if( val == null ) {
185       val = "";
186     }
187 
188     return SKIP_BODY;
189   }
190 
191   /**
192    * Output the extended property
193    *
194    * @return EVAL_PAGE
195    */
196   public final int doEndTag() throws JspException
197   {
198     try {
199       pageContext.getOut().write(val);
200     } catch(Exception   e) {
201       throw new JspException("IO Error: " + e.getMessage());
202     }
203     return EVAL_PAGE;
204   }
205 
206   /**
207    * Set the name of the parent tag script variable
208    */
209   public final void setName(String   nam)
210   {
211     name = nam;
212   }
213 
214   /**
215    * Set the name of the extended property to get
216    */
217   public final void setProperty(String   prop)
218   {
219     property = prop;
220   }
221 }
222
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags