You are viewing a plain text version of this content. The canonical link for it is here.
Posted to taglibs-dev@jakarta.apache.org by gl...@locus.apache.org on 2000/10/30 00:04:24 UTC
cvs commit: jakarta-taglibs/session/doc/web index.html
glenn 00/10/29 15:04:24
Modified: session/doc/web index.html
Log:
Cleanup for release
Revision Changes Path
1.2 +848 -52 jakarta-taglibs/session/doc/web/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-taglibs/session/doc/web/index.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.html 2000/09/24 03:25:39 1.1
+++ index.html 2000/10/29 23:04:24 1.2
@@ -1,52 +1,848 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.74 [en] (X11; U; FreeBSD 3.4-RELEASE i386) [Netscape]">
- <title>Documentation for the SESSION Tag Library</title>
-</head>
-<body text="#000000" bgcolor="#FFFFFF" link="#0000EE" vlink="#551A8B" alink="#FF0000">
-
-<center>
-<h1>
-Documentation for the SESSION Tag Library</h1></center>
-
-<h3>
-1. INTRODUCTION</h3>
-The SESSION custom tag library contains tags which can be used to access
-all the information about the HTTP session for a JSP page.
-<h3>
-2. PREREQUISITE SOFTWARE</h3>
-This custom tag library requires no software other than a servlet container
-that supports the JavaServer Pages Specification, version 1.1.
-<h3>
-3. CONFIGURATION INFORMATION</h3>
-Follow these steps to configure your web application with this tag library:
-<p> Copy the tag library descriptor file
-(session/session.tld) to the /WEB-INF subdirectory of your web application.
-<br> Copy the tag library JAR file (session/session.jar)
-to the /WEB-INF/lib subdirectory of your web application.
-<br> Add a <taglib> element to your web
-application deployment descriptor in /WEB-INF/web.xml like this:
-<p> <taglib>
-<br>
-<taglib-uri>http://jakarta.apache.org/taglibs/session-1.0</taglib-uri>
-<br>
-<taglib-location>/WEB-INF/session.tld</taglib-location>
-<br> </taglib>
-<p>To use the tags from this library in your JSP pages, add the following
-directive at the top of each page:
-<p> <%@ taglib uri="http://jakarta.apache.org/taglibs/session-1.0"
-prefix="sess" %>
-<p>where "sess" is the tag name prefix you wish to use for tags from this
-library. You can change this value to any prefix you like.
-<h3>
-4. TAG DOCUMENTATION</h3>
-This custom tag library includes a number of tags which are documented
-using <a href="javadoc/index.html">javadocs</a>.
-<h3>
-5. USAGE EXAMPLES</h3>
-See the example application (session/session-examples.war) for examples
-of the usage of the tags from this custom tag library.
-</body>
-</html>
+<HTML>
+
+<HEAD>
+ <TITLE>Jakarta Project: SESSION JSP Tag Library</TITLE>
+</HEAD>
+
+<BODY BGCOLOR="white">
+<CENTER>
+<H1>Jakarta Project: SESSION JSP Tag Library</H1>
+<H3>Version 1.0</H3>
+</CENTER>
+
+<H3>Table of Contents</H3>
+<A HREF="#overview">Overview</A><BR>
+<A HREF="#requirements">Requirements</A><BR>
+<A HREF="#config">Configuration</A><BR>
+<A HREF="#summary">Tag Summary</A><BR>
+<A HREF="#reference">Tag Reference</A><BR>
+<A HREF="#examples">Examples</A><BR>
+<A HREF="#javadocs">Javadocs</A><BR>
+<A HREF="#history">Revision History</A><BR>
+<BR>
+
+<A NAME="overview"><H3>Overview</H3></A>
+<P>The SESSION JSP tag library provides tags for reading or modifying client
+HttpSession information.</P>
+<P> A servlet container uses an HttpSession to store information about a
+clients session on the server. By default a JSP page will create a session for
+a user. The user is tied to the session using either a Cookie or by using URL
+rewriting. This is how you can tie information to a user between multiple HTTP
+requests to your server.</P>
+<P> Session Attributes are what makes it possible to store information about a
+clients session between multiple HTTP requests. A session attribute consists of
+a name and value. To save information about a users session on your server use
+the <B>setattribute</B> tag.</P>
+<P> The session attributes you save only exist while the sessions exists.
+Servlet containers will expire a users session and remove it after the user has
+been inactive for a period of time. Many servlet containers default to 30
+minutes. You can change this by using the <B>maxinactiveinterval</B> tag.</P>
+<P> A typical example of this is a shopping cart application where you use the
+session to track what items the user wants to purchase. Each time a user
+selects an item to purchase you set a session attribute which contains
+information about the item. Then when the user later checks out, you can
+determine what items they want to purchase by looking at the session
+attributes.</P>
+
+<A NAME="requirements"><H3>Requirements</H3></A>
+<P>This custom tag library requires no software other than a servlet container
+that supports the JavaServer Pages Specification, version 1.1.</P>
+
+<A NAME="config"><H3>Configuration</H3></A>
+<P>Follow these steps to configure your web application with this tag library:</P>
+<UL>
+<LI>Copy the tag library descriptor file (session/session.tld) to the /WEB-INF
+subdirectory of your web application.</LI>
+<LI>Copy the tag library JAR file (session/session.jar) to the /WEB-INF/lib
+subdirectory of your web application.</LI>
+<LI>Add a <taglib> element to your web application deployment descriptor
+in /WEB-INF/web.xml like this:<BR>
+<BR>
+<PRE>
+<taglib>
+ <taglib-uri>http://jakarta.apache.org/taglibs/session-1.0</taglib-uri>
+ <taglib-location>/WEB-INF/session.tld</taglib-location>
+</taglib>
+</PRE>
+</LI>
+</UL>
+<P>To use the tags from this library in your JSP pages, add the following
+directive at the top of each page: </P>
+<PRE>
+<%@ taglib uri="http://jakarta.apache.org/taglibs/session-1.0" prefix="sess" %>
+</PRE>
+<P>where "<I>sess</I>" is the tag name prefix you wish to use for
+tags from this library. You can change this value to any prefix you like.
+For the examples below the prefix "<B>sess</B>" is used.</P>
+
+<A NAME="summary"><H3>Tag Summary</H3></A>
+<TABLE>
+ <TR>
+ <TD COLSPAN="2"><B>Session Tags</B></TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#session">session</A></TD>
+ <TD>Used to access general information about session</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#isnew">isnew</A></TD>
+ <TD>Used to determine if a session is new</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#invalidate">invalidate</A></TD>
+ <TD>Used to invalidate a session and remove it</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#maxinactiveinterval">maxinactiveinterval</A></TD>
+ <TD>Used to set the maximum inactive interval before a session times out</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2"> </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2"><B>Session Attribute Tags</B></TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#attribute">attribute</A></TD>
+ <TD>Get a single attribute value</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#attributes">attributes</A></TD>
+ <TD>Loop through all attribute name and value pairs</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#existsattribute">existsattribute</A></TD>
+ <TD>See if an attribute exists</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#removeattribute">removeattribute</A></TD>
+ <TD>Remove an attribute</TD>
+ </TR>
+ <TR>
+ <TD><A HREF="#setattribute">setattribute</A></TD>
+ <TD>Set an attribute</TD>
+ </TR>
+</TABLE>
+
+<A NAME="reference"><H3>Tag Reference</H3></A>
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="session"> session</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Used to access general information about session.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">Empty</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">Yes, available from beginning of tag to end of page</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> id</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Script variable id for use with standard
+ <B>jsp:getProperty</B> tag</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN=2 WIDTH="100%"><B>Properties</B></TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="60%">Name</TD>
+ <TD WIDTH="20%">Get</TD>
+ <TD WIDTH="20%">Set</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> creationTime</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Returns the time when this session was created, measured in
+ milliseconds since midnight January 1, 1970 GMT.</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> sessionId</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Returns the unique identifier assigned to this session.</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> lastAccessedTime</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Returns the last time the client sent a request associated with
+ this session as the number of milliseconds since midnight January 1, 1970
+ GMT.</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> maxInactiveInterval</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Returns the maximum time interval, in seconds, that the servlet
+ container will keep this session open between client accesses.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Display the creation time of the session --%>
+<sess:session id="ss"/>
+The creation time in milliseconds since midnight January 1, 1970 GMT is:
+<jsp:getProperty name="ss" property="creationTime"/>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="isnew"> isnew</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Used to determine if a session is new.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">JSP</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> value</B></TD>
+ <TD WIDTH="20%"> No</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">If value is set to false the isnew tag includes
+ body of tag if session is not new.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Display whether the cients session is new --%>
+<sess:isnew>
+ This session is new.
+</sess:isnew>
+<sess:isnew value="false">
+ This session is not new.
+</sess:isnew>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="invalidate"> invalidate</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Invalidates a user session and removes it.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">Empty</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Invalidate the users session and remove it --%>
+<sess:invalidate/>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="maxinactiveinterval"> maxinactiveinterval</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Sets the max inactive interval in seconds using the content of the tag body.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">JSP</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Sets the session maximum inactive interval to 900 seconds --%>
+<sess:maxinactiveinterval>900</sess:maxinactiveinterval>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="attribute"> attribute</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Used to get the value of a single session attribute. </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">Empty</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> name</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Name of session attribute to get.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Output the value of the session attribute with name "test1" --%>
+<sess:attribute name="test1"/>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="attributes"> attributes</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Used to loop through all session attributes.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">JSP</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">Yes, available only within tag body.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> id</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Script variable id for use with standard
+ <B>jsp:getProperty</B> tag</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN=2 WIDTH="100%"><B>Properties</B></TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="60%">Name</TD>
+ <TD WIDTH="20%">Get</TD>
+ <TD WIDTH="20%">Set</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> name</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Session attribute name.</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> value</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Session attribute value.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Output the name and value of all the session attributes --%>
+<sess:attributes id="loop">
+Name: <jsp:getProperty name="loop" property="name"/>
+Value: <jsp:getProperty name="loop" property="value"/>
+</sess:attributes>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="existsattribute"> existsattribute</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Includes the body of the tag if the session attribute exists.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">JSP</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> name</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Name of session attribute.</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="60%"><B> value</B></TD>
+ <TD WIDTH="20%"> No</TD>
+ <TD WIDTH="20%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">If value is set to false the existsattribute tag includes body
+ of tag if session attribute does not exist.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<sess:existsattribute name="test1">
+ The session attribute with name test1 exists.
+</sess:existsattribute>
+<sess:existsattribute name="test1" value="false">
+ The session attribute with name test1 does not exist.
+</sess:existsattribute>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="removeattribute"> removeattribute</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Removes an attribute from a session.</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">Empty</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> name</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Name of session attribute to remove.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Remove the session attribute with name "test1" --%>
+<sess:removeattribute name="test1"/>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<TABLE BORDER="0" WIDTH="90%" CELLPADDING="3" CELLSPACING="0">
+ <TR>
+ <TD COLSPAN="2">
+ <TABLE BORDER="0" BGCOLOR="#CCCCCC" WIDTH="100%" CELLSPACING="0">
+ <TR>
+ <TD><B><FONT SIZE="+1"><A NAME="setattribute"> setattribute</A></FONT></B></TD>
+ <TD ALIGN="RIGHT">Availability: version 1.0 </TD>
+ </TR>
+ </TABLE>
+ </TD
+ </TR>
+ <TR>
+ <TD COLSPAN="2">Sets the value of the session attribute to the content of the tag body.</TD>
+ </TR>
+<TR>
+ <TD WIDTH="2%"> </TD>
+ <TD WIDTH="98%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="20%"><B>Tag Body</B></TD>
+ <TD WIDTH="80%">JSP</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Script Variable</B></TD>
+ <TD WIDTH="80%">No</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Restrictions</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Attributes</B></TD>
+ <TD WIDTH="80%"> </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"> </TD>
+ <TD WIDTH="80%">
+ <TABLE BORDER="0" WIDTH="100%">
+ <TR>
+ <TD WIDTH="40%">Name</TD>
+ <TD WIDTH="20%">Required</TD>
+ <TD WIDTH="40%">Runtime Expression Evaluation</TD>
+ </TR>
+ <TR BGCOLOR="#CCCCCC">
+ <TD WIDTH="40%"><B> name</B></TD>
+ <TD WIDTH="20%"> Yes</TD>
+ <TD WIDTH="40%"> No</TD>
+ </TR>
+ <TR>
+ <TD COLSPAN="3">Name of session attribute to set value for.</TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%"><B>Properties</B></TD>
+ <TD WIDTH="80%">None</TD>
+ </TR>
+ <TR>
+ <TD WIDTH="20%" VALIGN="TOP"><B>Example</B></TD>
+ <TD WIDTH="80%"><BR>
+<PRE>
+<%-- Set the session attribute with name "test1" --%>
+<sess:setattribute name="test1">Test Value</sess:setattribute>
+</PRE>
+ </TD>
+ </TR>
+ </TABLE>
+ </TD>
+ </TR>
+</TABLE>
+
+<A NAME="examples"><H3>Examples</H3></A>
+<P>See the example application session-examples.war for examples of the usage
+of the tags from this custom tag library.</P>
+
+<A NAME="javadocs"><H3>Java Docs</H3></A>
+<P>Java programmers can view the java class documentation for this tag library
+as <A HREF="javadoc/index.html">javadocs</A>.</P>
+
+<A NAME="history"><H3>Revision History</H3></A>
+<P>Review the complete <A HREF="changes.html">revision history</A> of this tag
+library.</P>
+</BODY>
+</HTML>