KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openejb > webadmin > HttpSession


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "OpenEJB" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of The OpenEJB Group. For written permission,
18  * please contact dev@openejb.org.
19  *
20  * 4. Products derived from this Software may not be called "OpenEJB"
21  * nor may "OpenEJB" appear in their names without prior written
22  * permission of The OpenEJB Group. OpenEJB is a registered
23  * trademark of The OpenEJB Group.
24  *
25  * 5. Due credit should be given to the OpenEJB Project
26  * (http://www.openejb.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE OPENEJB GROUP AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * THE OPENEJB GROUP OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 2001 (C) The OpenEJB Group. All Rights Reserved.
42  *
43  * $Id: HttpSession.java 1912 2005-06-16 22:29:56Z jlaskowski $
44  */
45 package org.openejb.webadmin;
46
47 /**
48  * @author <a HREF="mailto:david.blevins@visi.com">David Blevins</a>
49  */
50 public interface HttpSession {
51
52     public void removeAttribute(String JavaDoc name);
53
54     /**
55      * Returns the object bound with the specified name in this session, or
56      * <code>null</code> if no object is bound under the name.
57      *
58      * @param name a string specifying the name of the object
59      *
60      * @return the object with the specified name
61      */
62     public Object JavaDoc getAttribute(String JavaDoc name);
63
64     /**
65      * Binds an object to this session, using the name specified. If an object
66      * of the same name is already bound to the session, the object is
67      * replaced.
68      *
69      * @param name the name to which the object is bound; cannot be null
70      * @param value the object to be bound
71      */
72     public void setAttribute(String JavaDoc name, Object JavaDoc value);
73
74     /**
75      * Returns a string containing the unique identifier assigned to this
76      * session. The identifier is assigned by the ejb container and is
77      * implementation dependent.
78      *
79      * @return a string specifying the identifier assigned to this session
80      */
81     public String JavaDoc getId();
82 }
83
84
85
Popular Tags