getjivepropertytag.java

Jive 是一个系统工程

/**
 * $Header: /home/coolserv/.cvs/coolserv/jive/source/taglib/com/coolservlets/forum/tags/GetJivePropertyTag.java,v 1.2 2000/12/11 00:16:14 gnielsen Exp $
 * $Revision: 1.2 $
 * $Date: 2000/12/11 00:16:14 $
 *
 * Copyright (C) 2000 CoolServlets.com. All rights reserved.
 *
 * ===================================================================
 * The Apache Software License, Version 1.1
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *        CoolServlets.com (http://www.coolservlets.com)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Jive" and "CoolServlets.com" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please
 *    contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Jive",
 *    nor may "Jive" appear in their name, without prior written
 *    permission of CoolServlets.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL COOLSERVLETS.COM OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of CoolServlets.com. For more information
 * on CoolServlets.com, please see <http://www.coolservlets.com>.
 */

package com.coolservlets.forum.tags;

import java.io.*;
import javax.servlet.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
import javax.servlet.http.*;
import com.coolservlets.forum.tags.*;

/**
 * JSP Tag <b>getJiveProperty</b>, used with <b>create</b>,
 * <b>account</b>, <b>user</b>, <b>forum</b>, <b>post</b>, and <b>message</b>
 *  tags to get a jive extended property.
 * <p>
 * Requires that attribute <b>name</b> be set to the name of the
 * script variable for the parent tag.
 * <p>
 * Requires that attribute <b>property</b> be set to the name of
 * an extended property.
 * <p>
 * Must be nested within a <b>create</b>, <b>account</b>, <b>user</b>,
 * <b>forum</b>, <b>post</b>, or <b>message</b> tag.
 * <p>
 * Always ignores the body of the tag.
 * <p>
 * Extended User Properties are defined in jive.user.properties.
 * <p>
 * JSP Tag Lib Descriptor
 * <p><pre>
 *  &lt;name&gt;getJiveProperty&lt;/name&gt;
 *  &lt;tagclass&gt;com.coolservlets.forum.tags.GetJivePropertyTag&lt;/tagclass&gt;
 *  &lt;bodycontent&gt;empty&lt;/bodycontent&gt;
 *  &lt;info&gt;Gets a jive extended property value.&lt;/info&gt;
 *  &lt;attribute&gt;
 *    &lt;name&gt;name&lt;/name&gt;
 *    &lt;required&gt;true&lt;/required&gt;
 *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
 *  &lt;/attribute&gt;
 *  &lt;attribute&gt;
 *    &lt;name&gt;property&lt;/name&gt;
 *    &lt;required&gt;true&lt;/required&gt;
 *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
 *  &lt;/attribute&gt;
 * </pre>
 *
 * @see GetJiveProperty
 * @see AccountTag
 * @see CreateTag
 * @see UserTag
 * @see ForumTag
 * @see MessageTag
 *
 * @author Glenn Nielsen
 */

public class GetJivePropertyTag extends TagSupport
{
  private String name = null;
  private String property = null;
  private String val;

  /**
   * Method called at start of getJiveProperty Tag to get the extended
   * Jive property.
   *
   * @return SKIP_BODY
   */
  public final int doStartTag() throws JspException
  {
    // Get the parent tag
    JiveProperty jp =
	(JiveProperty)pageContext.getAttribute(name, PageContext.PAGE_SCOPE);
    // Get the property value
    if( jp != null ) {
      val = jp.getProperty(property);
    }

    if( val == null ) {
      val = "";
    }

    return SKIP_BODY;
  }

  /**
   * Output the extended property
   *
   * @return EVAL_PAGE
   */
  public final int doEndTag() throws JspException
  {
    try {
      pageContext.getOut().write(val);
    } catch(Exception e) {
      throw new JspException("IO Error: " + e.getMessage());
    }
    return EVAL_PAGE;
  }

  /**
   * Set the name of the parent tag script variable
   */
  public final void setName(String nam)
  {
    name = nam;
  }

  /**
   * Set the name of the extended property to get
   */
  public final void setProperty(String prop)
  {
    property = prop;
  }
}