cvs commit: jakarta-taglibs/session/src/org/apache/taglibs/session SessionData.java

[gl...@locus.apache.org]

glenn       00/10/29 15:01:44

  Added:       session/src/org/apache/taglibs/session SessionData.java
  Log:
  Cleanup for release
  
  Revision  Changes    Path
  1.1                  jakarta-taglibs/session/src/org/apache/taglibs/session/SessionData.java
  
  Index: SessionData.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-taglibs/session/src/org/apache/taglibs/session/SessionData.java,v 1.1 2000/10/29 23:01:44 glenn Exp $
   * $Revision: 1.1 $
   * $Date: 2000/10/29 23:01:44 $
   *
   * ====================================================================
   *
   * 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.session;
  
  import javax.servlet.*;
  import javax.servlet.http.*;
  import javax.servlet.jsp.*;
  import javax.servlet.jsp.tagext.*;
  
  /**
   * Used to store the scripting variable data provided by the JSP Tag
   * <b>session</b>, used to access HttpSession information using
   * the standard JSP &lt;jsp:getProperty&gt; tag.
   * <p>
   * The script variable of name <b>id</b> is available for use during
   * processing of the remainder of the JSP page.
   * <p>
   *
   * @see SessionTag
   *
   * @author Glenn Nielsen
   */
  
  public class SessionData extends TagSupport
  {
      private HttpSession sess;
  
      SessionData(HttpSession session)
      {
  	this.sess = session;
      }
  
      /**
       * Returns the time when this session was created, measured in
       * milliseconds since midnight January 1, 1970 GMT as a String.
       * <p>
       * &lt;jsp:getProperty name=<i>"id"</i> property="creationTime"/&gt;
       *
       * @return String - creation of session in milliseconds
       */
      public final String getCreationTime()
      {
  	return "" + sess.getCreationTime();
      }
  
      /**
       * Returns a string containing the unique identifier assigned to this
       * session.
       * <p>
       * &lt;jsp:getProperty name=<i>"id"</i> property="sessionId"/&gt;
       *
       * @return String - session id
       */
      public final String getSessionId()
      {
  	return sess.getId();
      }
  
      /**
       * Returns the last time the client sent a request associated with
       * this session, as the number of milliseconds since midnight
       * January 1, 1970 GMT as a String.
       * <p>
       * &lt;jsp:getProperty name=<i>"id"</i> property="lastAccessedTime"/&gt;
       *
       * @return String - last time session was accessed in milliseconds
       */
      public final String getLastAccessedTime()
      {
  	return "" + sess.getLastAccessedTime();
      }
  
      /**
       * Returns the maximum time interval, in seconds, that the servlet
       * container will keep this session open between client accesses.
       * <p>
       * &lt;jsp:getProperty name=<i>"id"</i> property="maxInactiveInterval"/&gt;
       *
       * @return String - the maximum inactive interval in seconds
       */
      public final String getMaxInactiveInterval()
      {
  	return "" + sess.getMaxInactiveInterval();
      }
  }