KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > ext > servlet > HttpSessionHashModel


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */

52
53 package freemarker.ext.servlet;
54
55 import javax.servlet.http.HttpServletRequest JavaDoc;
56 import javax.servlet.http.HttpServletResponse JavaDoc;
57 import javax.servlet.http.HttpSession JavaDoc;
58
59 import freemarker.template.ObjectWrapper;
60 import freemarker.template.TemplateHashModel;
61 import freemarker.template.TemplateModel;
62 import freemarker.template.TemplateModelException;
63
64 /**
65  * TemplateHashModel wrapper for a HttpSession attributes.
66  * @author Attila Szegedi
67  * @version $Id: HttpSessionHashModel.java,v 1.14 2003/01/12 23:40:14 revusky Exp $
68  */

69
70 public final class HttpSessionHashModel
71 implements
72     TemplateHashModel
73 {
74     private HttpSession JavaDoc session;
75     private final ObjectWrapper wrapper;
76
77     // These are required for lazy initializing session
78
private final FreemarkerServlet servlet;
79     private final HttpServletRequest JavaDoc request;
80     private final HttpServletResponse JavaDoc response;
81     
82     /**
83      * Use this constructor when the session already exists.
84      * @param session the session
85      * @param wrapper an object wrapper used to wrap session attributes
86      */

87     public HttpSessionHashModel(HttpSession JavaDoc session, ObjectWrapper wrapper)
88     {
89         this.session = session;
90         this.wrapper = wrapper;
91
92         this.servlet = null;
93         this.request = null;
94         this.response = null;
95     }
96
97     /**
98      * Use this constructor when the session isn't already created. It is passed
99      * enough parameters so that the session can be properly initialized after
100      * it is detected that it was created.
101      * @param servlet the FreemarkerServlet that created this model. If the
102      * model is not created through FreemarkerServlet, leave this argument as
103      * null.
104      * @param request the actual request
105      * @param response the actual response
106      * @param wrapper an object wrapper used to wrap session attributes
107      */

108     public HttpSessionHashModel(FreemarkerServlet servlet, HttpServletRequest JavaDoc request, HttpServletResponse JavaDoc response, ObjectWrapper wrapper)
109     {
110         this.wrapper = wrapper;
111         
112         this.servlet = servlet;
113         this.request = request;
114         this.response = response;
115     }
116
117     public TemplateModel get(String JavaDoc key) throws TemplateModelException
118     {
119         checkSessionExistence();
120         return wrapper.wrap(session != null ? session.getAttribute(key) : null);
121     }
122
123     private void checkSessionExistence() throws TemplateModelException
124     {
125         if(session == null) {
126             session = request.getSession(false);
127             if(session != null && servlet != null) {
128                 try {
129                     servlet.initializeSession(request, response);
130                 }
131                 catch(Exception JavaDoc e) {
132                     throw new TemplateModelException(e);
133                 }
134             }
135         }
136     }
137
138     public boolean isEmpty()
139     throws
140         TemplateModelException
141     {
142         checkSessionExistence();
143         return session == null || !session.getAttributeNames().hasMoreElements();
144     }
145 }
146
Popular Tags