/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Velocity", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */


package org.apache.velocity.tools.view.servlet;


import org.apache.velocity.tools.view.ViewToolInfo;


/**
 * <p>ToolInfo implementation that holds scope information for tools
 * used in a servlet environment.  The ServletToolboxManager uses
 * this to allow tool definitions to specify the scope/lifecycle
 * of individual view tools.</p>
 *
 * <p>Example of toolbox.xml definitions for servlet tools:<pre>
 *  &lt;tool&gt;
 *    &lt;key&gt;link&lt;/key&gt;
 *    &lt;scope&gt;request&lt;/scope&gt;
 *    &lt;class&gt;org.apache.velocity.tools.struts.StrutsLinkTool&lt;/class&gt;
 *  &lt;/tool&gt;
 *  &lt;tool&gt;
 *    &lt;key&gt;math&lt;/key&gt;
 *    &lt;scope&gt;application&lt;/scope&gt;
 *    &lt;class&gt;org.apache.velocity.tools.generic.MathTool&lt;/class&gt;
 *  &lt;/tool&gt;
 *  &lt;tool&gt;
 *    &lt;key&gt;user&lt;/key&gt;
 *    &lt;scope&gt;session&lt;/scope&gt;
 *    &lt;class&gt;com.mycompany.tools.MyUserTool&lt;/class&gt;
 *  &lt;/tool&gt;
 *  </pre></p>
 *
 * @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
 *
 * @version $Id: ServletToolInfo.java,v 1.3 2003/05/28 00:17:16 nbubna Exp $
 */
public class ServletToolInfo extends ViewToolInfo
{

    public static final String REQUEST_SCOPE = "request";
    public static final String SESSION_SCOPE = "session";
    public static final String APPLICATION_SCOPE = "application";
        
    private String scope;


    /**
     * Creates a new tool of the specified class with the given key and scope.
     */
    public ServletToolInfo(String key, String classname, String scope)
        throws Exception
    {
        super(key, classname);
        this.scope = scope;
    }


    /**
     * @return the scope of the tool
     */
    public String getScope()
    {
        return scope;
    }


}

@@ -3662,29 +3662,29 @@
 v 1.
-3
+4
  2003/0
-5/28 00:17:16
+7/22 18:31:30
  nbu
@@ -3758,119 +3758,364 @@
     
-public static final String REQUEST_SCOPE = %22request%22;%0A    public static final String SESSION_SCOPE = %22session%22;
+/** @deprecated use ServletToolboxManager.REQUEST_SCOPE */%0A    public static final String REQUEST_SCOPE = ServletToolboxManager.REQUEST_SCOPE;%0A    /** @deprecated use ServletToolboxManager.SESSION_SCOPE */%0A    public static final String SESSION_SCOPE = ServletToolboxManager.SESSION_SCOPE;%0A    /** @deprecated use ServletToolboxManager.APPLICATION_SCOPE */
 %0A   
@@ -4166,21 +4166,47 @@
 E = 
-%22application%22
+ServletToolboxManager.APPLICATION_SCOPE
 ;%0A  
@@ -4248,231 +4248,79 @@
     
-/**%0A     * Creates a new tool of the specified class with the given key and scope.%0A     */%0A    public ServletToolInfo(String key, String classname, String scope)%0A        throws Exception%0A    %7B%0A        super(key, classname);
+public ServletToolInfo() %7B%7D%0A%0A%0A    public void setScope(String scope) %7B 
 %0A   
@@ -4469,11 +4469,10 @@
 %0A    %7D%0A%0A
-%0A
 %7D%0A

make implementation more bean-ish and Digester friendly (use set methods instead of complex constructor). also deprecate/move constants only used by ServletToolboxManager