HttpServletRequestParameters.java

/*
 * $Source$
 * $Revision$
 *
 * Copyright (C) 2000 William Chesters
 *
 * Part of Melati (http://melati.org), a framework for the rapid
 * development of clean, maintainable web applications.
 *
 * Melati is free software; Permission is granted to copy, distribute
 * and/or modify this software under the terms either:
 *
 * a) the GNU General Public License as published by the Free Software
 *    Foundation; either version 2 of the License, or (at your option)
 *    any later version,
 *
 *    or
 *
 * b) any version of the Melati Software License, as published
 *    at http://melati.org
 *
 * You should have received a copy of the GNU General Public License and
 * the Melati Software License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
 * GNU General Public License and visit http://melati.org to obtain the
 * Melati Software License.
 *
 * Feel free to contact the Developers of Melati (http://melati.org),
 * if you would like to work out a different arrangement than the options
 * outlined here.  It is our intention to allow Melati to be used by as
 * wide an audience as possible.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * Contact details for copyright holder:
 *
 *     William Chesters <williamc At paneris.org>
 *     http://paneris.org/~williamc
 *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
 */

package org.melati.util;

import java.util.Enumeration;
import java.util.Hashtable;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpServletRequest;

/**
 * The parameters of an Http Servlet Request.
 */
public class HttpServletRequestParameters {

  final Hashtable<String,Object> parameters;
  final String requestURL;
  final String queryString;
  final String method;
  final String sessionID;

  /**
   * Constructor.
   * @param request to extract parameters from
   */
  @SuppressWarnings("unchecked")
  public HttpServletRequestParameters(HttpServletRequest request) {
    parameters = new Hashtable<String,Object> ();
    for (Enumeration<String> p = request.getParameterNames();
         p.hasMoreElements();) {
      String name = (String)p.nextElement();
      parameters.put(name, request.getParameterValues(name));
    }

    requestURL = HttpUtil.getRelativeRequestURL(request);
    queryString = request.getQueryString();
    method = request.getMethod();
    HttpSession session = request.getSession(true);
    sessionID = session == null ? null : session.getId();
  }

  /**
   * @return the extracted parameters
   */
  public Hashtable<String, Object> getParameters() {
    return parameters;
  }

  /**
   * @return URL String 
   */
  public String continuationURL() {
    return
        requestURL +
        (method.equals("PUT") || queryString == null ? "" : "?" + queryString);
  }
}