RemoveAttributeTag


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>removeAttribute</b>, used to remove an HttpSession
27   * attribute with name <b>name</b>.
28   * <p>
29   * JSP Tag Lib Descriptor
30   * <p><pre>
31   * &lt;name&gt;removeAttribute&lt;/name&gt;
32   * &lt;tagclass&gt;org.apache.taglibs.session.RemoveAttributeTag&lt;/tagclass&gt;
33   * &lt;bodycontent&gt;empty&lt;/bodycontent&gt;
34   * &lt;info&gt;Removes an attribute from a session.&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 RemoveAttributeTag extends TagSupport
46  {
47      // Name of session attribute to remove
48      private String   name = null;
49  
50      /**
51       * Removes an attribute from a session.
52       *
53       * @return SKIP_BODY
54       */
55      public final int doStartTag() throws JspException
56      {
57      pageContext.getSession().removeAttribute(name);
58      return SKIP_BODY;
59      }
60  
61      /**
62       * Set the required tag attribute <b>name</b>.
63       *
64       * @param String name of session attribute 
65       */
66      public final void setName(String   str)
67      {   
68      name = str;
69      }
70  }
71
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags