KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > jsdkapi > ServletAPI2_2Session


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.core.jsdkapi;
66
67 import com.jcorporate.expresso.core.misc.StringUtil;
68
69 import javax.servlet.ServletException JavaDoc;
70 import javax.servlet.http.HttpServletRequest JavaDoc;
71 import javax.servlet.http.HttpSession JavaDoc;
72 import java.io.Serializable JavaDoc;
73 import java.util.Enumeration JavaDoc;
74
75
76 /**
77  *
78  */
79 public class ServletAPI2_2Session
80         implements APIAwareSession {
81     private static final String JavaDoc thisClass = ServletAPI2_2Session.class.getName() + ".";
82
83     /**
84      * @param req The Servlet Request
85      * @param code The Attribute 'key'
86      * @return a Serializable Object attribute
87      */
88     public Serializable JavaDoc getAttribute(HttpServletRequest JavaDoc req, String JavaDoc code)
89             throws ServletException JavaDoc {
90         StringUtil.assertNotBlank(code, "You must specify an attribute name");
91
92         String JavaDoc myName = thisClass +
93                 "getAttribute(HttpServletRequest, String)";
94         HttpSession JavaDoc session = req.getSession(true);
95
96         if (session == null) {
97             return null;
98         }
99
100         Object JavaDoc o = session.getAttribute(code);
101
102         if (o == null) {
103             return null;
104         }
105         if (!(o instanceof Serializable JavaDoc)) {
106             throw new ServletException JavaDoc(myName +
107                     ":Object stored in session with key '" +
108                     code +
109                     "' was not Serializable - it was of class '" +
110                     o.getClass().getName() + "'");
111         }
112
113         return (Serializable JavaDoc) o;
114     } /* getAttribute(HttpServletRequest, String) */
115
116
117     public Enumeration JavaDoc getAttributeNames(HttpServletRequest JavaDoc req)
118             throws ServletException JavaDoc {
119         HttpSession JavaDoc session = req.getSession(true);
120
121         return session.getAttributeNames();
122     }
123
124     /**
125      * Sets a session attribute
126      *
127      * @param req The servlet request
128      * @param code The attribute 'key'
129      * @param value The new value to set this attribute value to.
130      */
131     public void setAttribute(HttpServletRequest JavaDoc req, String JavaDoc code,
132                              Serializable JavaDoc value)
133             throws ServletException JavaDoc {
134         HttpSession JavaDoc session = req.getSession(true);
135         session.setAttribute(code, value);
136     } /* setAttribute(HttpServletRequest, String, Serializable) */
137
138
139     /**
140      * Removes a session attribute
141      *
142      * @param req The servlet request
143      * @param code The attribute 'key' that you wish to removed
144      */
145     public void removeAttribute(HttpServletRequest JavaDoc req, String JavaDoc code)
146             throws ServletException JavaDoc {
147         HttpSession JavaDoc session = req.getSession(true);
148         session.removeAttribute(code);
149     } /* removeAttribute(HttpServletRequest, String) */
150
151
152     /**
153      * Invalidates the current user's session
154      *
155      * @param req The servlet request object
156      */
157     public void invalidate(HttpServletRequest JavaDoc req) {
158         HttpSession JavaDoc session = req.getSession(true);
159         session.invalidate();
160     } /* invalidate(HttpServletRequest) */
161
162     /**
163      * Gets the Session ID
164      *
165      * @param req A servlet request object
166      * @return The session ID as a String
167      */
168     public String JavaDoc getId(HttpServletRequest JavaDoc req) {
169         HttpSession JavaDoc session = req.getSession(true);
170
171         return session.getId();
172     } /* invalidate(HttpServletRequest) */
173
174     /**
175      * Get a sessions's current context path
176      *
177      * @param req a Servlet Request Object
178      * @return The context path
179      */
180     public String JavaDoc getContextPath(HttpServletRequest JavaDoc req) {
181         return req.getContextPath();
182     } /* getContextPath(HttpServletRequest) */
183
184 } /* ServletAPI2_2Session */
185
186 /* ServletAPI2_2Session */
Popular Tags