cvs commit: jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools ImportTool.java

[ma...@apache.org]

marino      2003/10/29 16:11:56

  Added:       src/java/org/apache/velocity/tools/view/tools
                        ImportTool.java
  Log:
  a tool that extends ImportTool and makes it possible to import local resources of many kinds or arbitrary URLs into a velocity template.
  
  Revision  Changes    Path
  1.1                  jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/ImportTool.java
  
  Index: ImportTool.java
  ===================================================================
  /*
   * 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.tools;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.http.HttpSession;
  import javax.servlet.ServletContext;
  
  import org.apache.velocity.app.Velocity;
  import org.apache.velocity.tools.view.ImportSupport;
  import org.apache.velocity.tools.view.context.ViewContext;
  import org.apache.velocity.tools.view.tools.ViewTool;
  
  /**
   * <p>Title: ImportTool</p>
   * <p>Description: a general-purpose text-importing mechanism for templates</p>
   * <p>Usage:
   *
   * Just call $import.getString("http://www.foo.com/bleh.jsp?sneh=bar") to insert the contents of the named
   * resource into the template.
   *
   * @author <a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a>
   * @version $Revision: 1.1 $ $Date: 2003/10/30 00:11:56 $
   */
  public class ImportTool extends ImportSupport
      implements ViewTool {
  
      protected ViewContext context;
  
      /**
       * Default constructor. Tool must be initialized before use.
       */
      public ImportTool() {}
  
      /**
       * Initializes this tool.
       *
       * @param obj the current ViewContext
       * @throws IllegalArgumentException if the param is not a ViewContext
       */
      public void init(Object obj) {
          if (! (obj instanceof ViewContext)) {
              throw new IllegalArgumentException("Tool can only be initialized with a ViewContext");
          }
  
          this.context = (ViewContext) obj;
          this.request = context.getRequest();
          this.response = context.getResponse();
          this.application = context.getServletContext();
      }
  
      /**
       *
       * @param url the URL to import
       * @return the URL as a string
       */
      public String read(String url) {
          try {
              // check the URL
              if (url == null || url.equals("")) {
                  Velocity.warn("import URL is null or empty");
                  return null;
              }
  
              return acquireString(url);
          }
          catch (Exception ex) {
              Velocity.error("Exeption importing URL: " + ex.getMessage());
              return null;
          }
      }
  
  
  }
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org