001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.ext.servlet;
054:
055: import javax.servlet.GenericServlet;
056: import javax.servlet.ServletContext;
057:
058: import freemarker.template.ObjectWrapper;
059: import freemarker.template.TemplateHashModel;
060: import freemarker.template.TemplateModel;
061: import freemarker.template.TemplateModelException;
062:
063: /**
064: * TemplateHashModel wrapper for a ServletContext attributes.
065: * @author Attila Szegedi
066: * @version $Id: ServletContextHashModel.java,v 1.12 2003/01/12 23:40:14 revusky Exp $
067: */
068: public final class ServletContextHashModel implements TemplateHashModel {
069: private final GenericServlet servlet;
070: private final ServletContext servletctx;
071: private final ObjectWrapper wrapper;
072:
073: public ServletContextHashModel(GenericServlet servlet,
074: ObjectWrapper wrapper) {
075: this .servlet = servlet;
076: this .servletctx = servlet.getServletContext();
077: this .wrapper = wrapper;
078: }
079:
080: /**
081: * @deprecated use
082: * {@link #ServletContextHashModel(GenericServlet, ObjectWrapper)} instead.
083: */
084: public ServletContextHashModel(ServletContext servletctx,
085: ObjectWrapper wrapper) {
086: this .servlet = null;
087: this .servletctx = servletctx;
088: this .wrapper = wrapper;
089: }
090:
091: public TemplateModel get(String key) throws TemplateModelException {
092: return wrapper.wrap(servletctx.getAttribute(key));
093: }
094:
095: public boolean isEmpty() {
096: return !servletctx.getAttributeNames().hasMoreElements();
097: }
098:
099: /**
100: * Returns the underlying servlet. Can return null if this object was
101: * created using the deprecated constructor.
102: */
103: public GenericServlet getServlet() {
104: return servlet;
105: }
106: }
|