HttpUtils.java
上传用户:tanyanyong
上传日期:2013-06-23
资源大小:1355k
文件大小:11k
源码类别:

电子政务应用

开发平台:

MultiPlatform

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution, if
  20.  *    any, must include the following acknowlegement:  
  21.  *       "This product includes software developed by the 
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowlegement may appear in the software itself,
  24.  *    if and wherever such third-party acknowlegements normally appear.
  25.  *
  26.  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
  27.  *    Foundation" must not be used to endorse or promote products derived
  28.  *    from this software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache"
  32.  *    nor may "Apache" appear in their names without prior written
  33.  *    permission of the Apache Group.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * ====================================================================
  55.  *
  56.  * This source code implements specifications defined by the Java
  57.  * Community Process. In order to remain compliant with the specification
  58.  * DO NOT add / change / or delete method signatures!
  59.  */ 
  60. package javax.servlet.http;
  61. import javax.servlet.ServletInputStream;
  62. import java.util.Hashtable;
  63. import java.util.ResourceBundle;
  64. import java.util.StringTokenizer;
  65. import java.io.IOException;
  66. /**
  67.  * Provides a collection of methods that are useful
  68.  * in writing HTTP servlets.
  69.  *
  70.  * @author Various
  71.  * @version  $Version$
  72.  *
  73.  */
  74. public class HttpUtils {
  75.     private static final String LSTRING_FILE =
  76. "javax.servlet.http.LocalStrings";
  77.     private static ResourceBundle lStrings =
  78. ResourceBundle.getBundle(LSTRING_FILE);
  79.     
  80.     static Hashtable nullHashtable = new Hashtable();
  81.     
  82.     
  83.     
  84.     /**
  85.      * Constructs an empty <code>HttpUtils</code> object.
  86.      *
  87.      */
  88.     public HttpUtils() {}
  89.     
  90.     
  91.     
  92.     
  93.     /**
  94.      *
  95.      * Parses a query string passed from the client to the
  96.      * server and builds a <code>HashTable</code> object
  97.      * with key-value pairs. 
  98.      * The query string should be in the form of a string
  99.      * packaged by the GET or POST method, that is, it
  100.      * should have key-value pairs in the form <i>key=value</i>,
  101.      * with each pair separated from the next by a & character.
  102.      *
  103.      * <p>A key can appear more than once in the query string
  104.      * with different values. However, the key appears only once in 
  105.      * the hashtable, with its value being
  106.      * an array of strings containing the multiple values sent
  107.      * by the query string.
  108.      * 
  109.      * <p>The keys and values in the hashtable are stored in their
  110.      * decoded form, so
  111.      * any + characters are converted to spaces, and characters
  112.      * sent in hexadecimal notation (like <i>%xx</i>) are
  113.      * converted to ASCII characters.
  114.      *
  115.      * @param s a string containing the query to be parsed
  116.      *
  117.      * @return a <code>HashTable</code> object built
  118.      *  from the parsed key-value pairs
  119.      *
  120.      * @exception IllegalArgumentException if the query string 
  121.      * is invalid
  122.      *
  123.      */
  124.     static public Hashtable parseQueryString(String s) {
  125. String valArray[] = null;
  126. if (s == null) {
  127.     throw new IllegalArgumentException();
  128. }
  129. Hashtable ht = new Hashtable();
  130. StringBuffer sb = new StringBuffer();
  131. StringTokenizer st = new StringTokenizer(s, "&");
  132. while (st.hasMoreTokens()) {
  133.     String pair = (String)st.nextToken();
  134.     int pos = pair.indexOf('=');
  135.     if (pos == -1) {
  136. // XXX
  137. // should give more detail about the illegal argument
  138. throw new IllegalArgumentException();
  139.     }
  140.     String key = parseName(pair.substring(0, pos), sb);
  141.     String val = parseName(pair.substring(pos+1, pair.length()), sb);
  142.     if (ht.containsKey(key)) {
  143. String oldVals[] = (String []) ht.get(key);
  144. valArray = new String[oldVals.length + 1];
  145. for (int i = 0; i < oldVals.length; i++) 
  146.     valArray[i] = oldVals[i];
  147. valArray[oldVals.length] = val;
  148.     } else {
  149. valArray = new String[1];
  150. valArray[0] = val;
  151.     }
  152.     ht.put(key, valArray);
  153. }
  154. return ht;
  155.     }
  156.     /**
  157.      *
  158.      * Parses data from an HTML form that the client sends to 
  159.      * the server using the HTTP POST method and the 
  160.      * <i>application/x-www-form-urlencoded</i> MIME type.
  161.      *
  162.      * <p>The data sent by the POST method contains key-value
  163.      * pairs. A key can appear more than once in the POST data
  164.      * with different values. However, the key appears only once in 
  165.      * the hashtable, with its value being
  166.      * an array of strings containing the multiple values sent
  167.      * by the POST method.
  168.      *
  169.      * <p>The keys and values in the hashtable are stored in their
  170.      * decoded form, so
  171.      * any + characters are converted to spaces, and characters
  172.      * sent in hexadecimal notation (like <i>%xx</i>) are
  173.      * converted to ASCII characters.
  174.      *
  175.      *
  176.      *
  177.      * @param len an integer specifying the length,
  178.      * in characters, of the 
  179.      * <code>ServletInputStream</code>
  180.      * object that is also passed to this
  181.      * method
  182.      *
  183.      * @param in the <code>ServletInputStream</code>
  184.      * object that contains the data sent
  185.      * from the client
  186.      * 
  187.      * @return a <code>HashTable</code> object built
  188.      * from the parsed key-value pairs
  189.      *
  190.      *
  191.      * @exception IllegalArgumentException if the data
  192.      * sent by the POST method is invalid
  193.      *
  194.      */
  195.      
  196.     static public Hashtable parsePostData(int len, 
  197.   ServletInputStream in)
  198.     {
  199. // XXX
  200. // should a length of 0 be an IllegalArgumentException
  201. if (len <=0)
  202.     return new Hashtable(); // cheap hack to return an empty hash
  203. if (in == null) {
  204.     throw new IllegalArgumentException();
  205. }
  206. //
  207. // Make sure we read the entire POSTed body.
  208. //
  209.         byte[] postedBytes = new byte [len];
  210.         try {
  211.             int offset = 0;
  212.        
  213.     do {
  214. int inputLen = in.read (postedBytes, offset, len - offset);
  215. if (inputLen <= 0) {
  216.     String msg = lStrings.getString("err.io.short_read");
  217.     throw new IllegalArgumentException (msg);
  218. }
  219. offset += inputLen;
  220.     } while ((len - offset) > 0);
  221. } catch (IOException e) {
  222.     throw new IllegalArgumentException(e.getMessage());
  223. }
  224.         // XXX we shouldn't assume that the only kind of POST body
  225.         // is FORM data encoded using ASCII or ISO Latin/1 ... or
  226.         // that the body should always be treated as FORM data.
  227.         //
  228.         try {
  229.             String postedBody = new String(postedBytes, 0, len, "8859_1");
  230.             return parseQueryString(postedBody);
  231.         } catch (java.io.UnsupportedEncodingException e) {
  232.             // XXX function should accept an encoding parameter & throw this
  233.             // exception.  Otherwise throw something expected.
  234.             throw new IllegalArgumentException(e.getMessage());
  235.         }
  236.     }
  237.     /*
  238.      * Parse a name in the query string.
  239.      */
  240.     static private String parseName(String s, StringBuffer sb) {
  241. sb.setLength(0);
  242. for (int i = 0; i < s.length(); i++) {
  243.     char c = s.charAt(i); 
  244.     switch (c) {
  245.     case '+':
  246. sb.append(' ');
  247. break;
  248.     case '%':
  249. try {
  250.     sb.append((char) Integer.parseInt(s.substring(i+1, i+3), 
  251.       16));
  252.     i += 2;
  253. } catch (NumberFormatException e) {
  254.     // XXX
  255.     // need to be more specific about illegal arg
  256.     throw new IllegalArgumentException();
  257. } catch (StringIndexOutOfBoundsException e) {
  258.     String rest  = s.substring(i);
  259.     sb.append(rest);
  260.     if (rest.length()==2)
  261. i++;
  262. }
  263. break;
  264.     default:
  265. sb.append(c);
  266. break;
  267.     }
  268. }
  269. return sb.toString();
  270.     }
  271.     /**
  272.      *
  273.      * Reconstructs the URL the client used to make the request,
  274.      * using information in the <code>HttpServletRequest</code> object.
  275.      * The returned URL contains a protocol, server name, port
  276.      * number, and server path, but it does not include query
  277.      * string parameters.
  278.      * 
  279.      * <p>Because this method returns a <code>StringBuffer</code>,
  280.      * not a string, you can modify the URL easily, for example,
  281.      * to append query parameters.
  282.      *
  283.      * <p>This method is useful for creating redirect messages
  284.      * and for reporting errors.
  285.      *
  286.      * @param req a <code>HttpServletRequest</code> object
  287.      * containing the client's request
  288.      * 
  289.      * @return a <code>StringBuffer</code> object containing
  290.      * the reconstructed URL
  291.      *
  292.      */
  293.     public static StringBuffer getRequestURL (HttpServletRequest req) {
  294. StringBuffer url = new StringBuffer ();
  295. String scheme = req.getScheme ();
  296. int port = req.getServerPort ();
  297. String urlPath = req.getRequestURI();
  298. //String servletPath = req.getServletPath ();
  299. //String pathInfo = req.getPathInfo ();
  300. url.append (scheme); // http, https
  301. url.append ("://");
  302. url.append (req.getServerName ());
  303. if ((scheme.equals ("http") && port != 80)
  304. || (scheme.equals ("https") && port != 443)) {
  305.     url.append (':');
  306.     url.append (req.getServerPort ());
  307. }
  308. //if (servletPath != null)
  309. //    url.append (servletPath);
  310. //if (pathInfo != null)
  311. //    url.append (pathInfo);
  312. url.append(urlPath);
  313. return url;
  314.     }
  315. }