KickJava   Java API By Example, From Geeks To Geeks.

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


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.GenericServlet JavaDoc;
56 import javax.servlet.ServletContext JavaDoc;
57
58 import freemarker.template.ObjectWrapper;
59 import freemarker.template.TemplateHashModel;
60 import freemarker.template.TemplateModel;
61 import freemarker.template.TemplateModelException;
62
63 /**
64  * TemplateHashModel wrapper for a ServletContext attributes.
65  * @author Attila Szegedi
66  * @version $Id: ServletContextHashModel.java,v 1.12 2003/01/12 23:40:14 revusky Exp $
67  */
68 public final class ServletContextHashModel implements TemplateHashModel
69 {
70     private final GenericServlet JavaDoc servlet;
71     private final ServletContext JavaDoc servletctx;
72     private final ObjectWrapper wrapper;
73
74     public ServletContextHashModel(
75         GenericServlet JavaDoc servlet, ObjectWrapper wrapper)
76     {
77         this.servlet = servlet;
78         this.servletctx = servlet.getServletContext();
79         this.wrapper = wrapper;
80     }
81     
82     /**
83      * @deprecated use
84      * {@link #ServletContextHashModel(GenericServlet, ObjectWrapper)} instead.
85      */
86     public ServletContextHashModel(
87         ServletContext JavaDoc servletctx, ObjectWrapper wrapper)
88     {
89         this.servlet = null;
90         this.servletctx = servletctx;
91         this.wrapper = wrapper;
92     }
93
94     public TemplateModel get(String JavaDoc key) throws TemplateModelException
95     {
96         return wrapper.wrap(servletctx.getAttribute(key));
97     }
98
99     public boolean isEmpty()
100     {
101         return !servletctx.getAttributeNames().hasMoreElements();
102     }
103     
104     /**
105      * Returns the underlying servlet. Can return null if this object was
106      * created using the deprecated constructor.
107      */
108     public GenericServlet JavaDoc getServlet()
109     {
110         return servlet;
111     }
112 }
113
Popular Tags