KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > transport > http > AxisHttpSession


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56 package org.jboss.axis.transport.http;
57
58 import org.jboss.axis.session.Session;
59
60 import javax.servlet.http.HttpServletRequest JavaDoc;
61 import javax.servlet.http.HttpSession JavaDoc;
62 import java.util.Enumeration JavaDoc;
63
64 /**
65  * An HTTP/Servlet implementation of Axis sessions.
66  *
67  * @author Glen Daniels (gdaniels@macromedia.com)
68  */
69 public class AxisHttpSession implements Session
70 {
71    private HttpSession JavaDoc rep;
72    private HttpServletRequest JavaDoc req;
73
74    public AxisHttpSession(HttpServletRequest JavaDoc realRequest)
75    {
76       req = realRequest;
77    }
78
79    public AxisHttpSession(HttpSession JavaDoc realSession)
80    {
81       rep = realSession;
82    }
83
84    /**
85     * Get the internal HttpSession.
86     */
87    public HttpSession JavaDoc getRep()
88    {
89       ensureSession();
90       return rep;
91    }
92
93    /**
94     * Set our internal HttpSession to the passed
95     * servlet HttpSession. Not sure if we'll really
96     * need this method...
97     */
98    public void setRep(HttpSession JavaDoc realSession)
99    {
100       rep = realSession;
101    }
102
103    /**
104     * Get a property from the session
105     *
106     * @param key the name of the property desired.
107     */
108    public Object JavaDoc get(String JavaDoc key)
109    {
110       ensureSession();
111       return rep.getAttribute(key);
112    }
113
114    /**
115     * Set a property in the session
116     *
117     * @param key the name of the property to set.
118     * @param value the value of the property.
119     */
120    public void set(String JavaDoc key, Object JavaDoc value)
121    {
122       ensureSession();
123       rep.setAttribute(key, value);
124    }
125
126    /**
127     * Remove a property from the session
128     *
129     * @param key the name of the property desired.
130     */
131    public void remove(String JavaDoc key)
132    {
133       ensureSession();
134       rep.removeAttribute(key);
135    }
136
137    /**
138     * Get an enumeration of the keys in this session
139     */
140    public Enumeration JavaDoc getKeys()
141    {
142       ensureSession();
143       return rep.getAttributeNames();
144    }
145
146    /**
147     * Set the session's time-to-live.
148     * <p/>
149     * This is implementation-specific, but basically should be the #
150     * of seconds of inactivity which will cause the session to time
151     * out and invalidate. "inactivity" is implementation-specific.
152     */
153    public void setTimeout(int timeout)
154    {
155       ensureSession();
156       rep.setMaxInactiveInterval(timeout);
157    }
158
159    /**
160     * Return the sessions' time-to-live.
161     *
162     * @return the timeout value for this session.
163     */
164    public int getTimeout()
165    {
166       ensureSession();
167       return rep.getMaxInactiveInterval();
168    }
169
170    /**
171     * "Touch" the session (mark it recently used)
172     */
173    public void touch()
174    {
175       // ???
176 }
177
178    protected void ensureSession()
179    {
180       if (rep == null)
181       {
182          rep = req.getSession();
183       }
184    }
185
186    /**
187     * Get an Object suitable for synchronizing the session. This method
188     * exists because different session implementations might provide
189     * different ways of getting at shared data. For a simple hashtable-
190     * based session, this would just be the hashtable, but for sessions
191     * which use database connections, etc. it might be an object wrapping
192     * a table ID or somesuch.
193     */
194    public Object JavaDoc getLockObject()
195    {
196       ensureSession();
197       return rep;
198    }
199 }
200
Popular Tags