cvs commit: jakarta-taglibs/request/src/org/apache/taglibs/request LogTag.java

[gl...@apache.org]

glenn       01/07/12 17:46:21

  Added:       request/src/org/apache/taglibs/request LogTag.java
  Log:
  Added a logging tag
  
  Revision  Changes    Path
  1.1                  jakarta-taglibs/request/src/org/apache/taglibs/request/LogTag.java
  
  Index: LogTag.java
  ===================================================================
  /**
   * $Header: /home/cvs/jakarta-taglibs/request/src/org/apache/taglibs/request/LogTag.java,v 1.1 2001/07/13 00:46:20 glenn Exp $
   * $Revision: 1.1 $
   * $Date: 2001/07/13 00:46:20 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 The Apache Software Foundation.  All rights
   * reserved.
   *
   * 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 acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * 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 THE APACHE SOFTWARE FOUNDATION 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 the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  package org.apache.taglibs.request;
  
  import java.io.*;
  import javax.servlet.*;
  import javax.servlet.jsp.*;
  import javax.servlet.jsp.tagext.*;
  import javax.servlet.http.*;
  
  /**
   * JSP Tag <b>log</b>, used to log the content of the log
   * tag body to the servlet context log.
   * <p>
   * JSP Tag Lib Descriptor
   * <p><pre>
   *  &lt;name&gt;log&lt;/name&gt;
   *  &lt;tagclass&gt;org.apache.taglibs.request.LogTag&lt;/tagclass&gt;
   *  &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
   *  &lt;info&gt;Logs the body of the tag to the servlet context log.&lt;/info&gt;
   * </pre>
   *
   * @author Glenn Nielsen
   */
  
  public class LogTag extends BodyTagSupport
  {
      /**
       * Always include the body so it can be logged.
       *
       * @return EVAL_BODY_TAG
       */
      public final int doStartTag() throws JspException
      {
          return EVAL_BODY_TAG;
      }
  
      /**
       * Log the content of the log tag body to the servlet context log.
       *
       * @return SKIP_BODY
       */
      public final int doAfterBody() throws JspException
      {
          // Use the body of the tag as message to log
          BodyContent body = getBodyContent();
          String s = body.getString();
          // Clear the body since we use tag body as log message
          body.clearBody();
          // Get the servlet context to log the message
          ServletContext ctx = pageContext.getServletContext();
          ctx.log(s);
          return SKIP_BODY;
      }
  
  }