KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
68  * APIAwareSession.java
69  *
70  * Copyright 2000, 2001 Jcorporate Ltd.
71  */
72
73 import javax.servlet.ServletException JavaDoc;
74 import javax.servlet.http.HttpServletRequest JavaDoc;
75 import java.io.Serializable JavaDoc;
76 import java.util.Enumeration JavaDoc;
77
78
79 /**
80  * APIAwareSession defines a wrapper for a session object that can
81  * store & retrieve serializable objects into the session, using the
82  * calls appropriate to the selected Servlet API
83  */
84 public interface APIAwareSession {
85
86     /**
87      * Get an attribute from the session
88      *
89      * @param req The HttpServletRequest object
90      * @param code the attribute code
91      * @return Serializable object as stored in the session
92      */
93     public Serializable JavaDoc getAttribute(HttpServletRequest JavaDoc req, String JavaDoc code)
94             throws ServletException JavaDoc;
95
96     /* getAttribute(HttpServletRequest, String) */
97
98     /**
99      * Get all the attribute names from the request
100      *
101      * @param req The servlet request object
102      * @return java.util.Enumeration
103      * @throws ServletException upon error
104      */
105     public Enumeration JavaDoc getAttributeNames(HttpServletRequest JavaDoc req)
106             throws ServletException JavaDoc;
107
108
109     /**
110      * Set an attribute in the session
111      *
112      * @param req The servlet request
113      * @param code The attribute &quot;Key&quot;
114      * @param value the value of the object
115      */
116     public void setAttribute(HttpServletRequest JavaDoc req, String JavaDoc code,
117                              Serializable JavaDoc value)
118             throws ServletException JavaDoc;
119
120
121     /**
122      * Remove an attribute from the session
123      *
124      * @param req The servlet request object
125      * @param code the key to remove
126      * @throws ServletException upon error
127      */
128     public void removeAttribute(HttpServletRequest JavaDoc req, String JavaDoc code)
129             throws ServletException JavaDoc;
130
131     /* removeAttribute(HttpServletRequest, String) */
132
133     /**
134      * Invalidate teh session
135      *
136      * @param req the servlet request
137      */
138     public void invalidate(HttpServletRequest JavaDoc req);
139
140
141     /**
142      * Retrieve the context path
143      *
144      * @param req the http servlet request
145      * @return the context path: java.lang.String
146      */
147     public String JavaDoc getContextPath(HttpServletRequest JavaDoc req);
148
149     /**
150      * Get the session id
151      *
152      * @param req the httpservlet request
153      * @return the session id string
154      */
155     public String JavaDoc getId(HttpServletRequest JavaDoc req);
156
157
158 }
159
160 /* APIAwareSession */
Popular Tags