butorservletrequest.java

一个实用工具类

/*
 * Copyright (C) butor.com. All rights reserved.
 *
 * This software is published under the terms of the GNU Library General
 * Public License (GNU LGPL), a copy of which has been included with this
 * distribution in the LICENSE.txt file. 
 */

package org.butor.web.helper;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.security.Principal;
import java.util.Enumeration;
import java.util.Locale;
import java.util.Map;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletInputStream;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

/**
 * This class implements the Wrapper or Decorator pattern. Methods default to
 * calling through to the wrapped request object.
 *
 * @see    javax.servlet.http.HttpServletRequest
 * @author nacroaz
 */

public class ButorServletRequest implements HttpServletRequest {

    /**
     * String identifier for Basic authentication. Value "BASIC"
     */
    public static final String BASIC_AUTH = HttpServletRequest.BASIC_AUTH;
    /**
     * String identifier for Basic authentication. Value "FORM"
     */
    public static final String FORM_AUTH = HttpServletRequest.FORM_AUTH;
    /**
     * String identifier for Basic authentication. Value "CLIENT_CERT"
     */
    public static final String CLIENT_CERT_AUTH = HttpServletRequest.CLIENT_CERT_AUTH;

    /**
     * String identifier for Basic authentication. Value "DIGEST"
     */
    public static final String DIGEST_AUTH = HttpServletRequest.DIGEST_AUTH;

	/**
	 * The wrapped request 
	 */	
	protected HttpServletRequest f_request = null;
	
	protected ButorSession f_javaroSession;

	/**
	 * 
	 */
	public ButorServletRequest(HttpServletRequest request) {
		f_request = request;
		f_javaroSession = new ButorSession(request.getSession());
	}
	
	public HttpServletRequest getRequest() {
		return f_request;	
	}

	/**
	 * @see HttpServletRequest#getAuthType()
	 */
	public String getAuthType() {
		return f_request.getAuthType();
	}

	/**
	 * @see HttpServletRequest#getCookies()
	 */
	public Cookie[] getCookies() {
		return f_request.getCookies();
	}

	/**
	 * @see HttpServletRequest#getDateHeader(String)
	 */
	public long getDateHeader(String arg0) {
		return f_request.getDateHeader(arg0);
	}

	/**
	 * @see HttpServletRequest#getHeader(String)
	 */
	public String getHeader(String arg0) {
		return f_request.getHeader(arg0);
	}

	/**
	 * @see HttpServletRequest#getHeaders(String)
	 */
	public Enumeration getHeaders(String arg0) {
		return f_request.getHeaders(arg0);
	}

	/**
	 * @see HttpServletRequest#getHeaderNames()
	 */
	public Enumeration getHeaderNames() {
		return f_request.getHeaderNames();
	}

	/**
	 * @see HttpServletRequest#getIntHeader(String)
	 */
	public int getIntHeader(String arg0) {
		return f_request.getIntHeader(arg0);
	}

	/**
	 * @see HttpServletRequest#getMethod()
	 */
	public String getMethod() {
		return f_request.getMethod();
	}

	/**
	 * @see HttpServletRequest#getPathInfo()
	 */
	public String getPathInfo() {
		return f_request.getPathInfo();
	}

	/**
	 * @see HttpServletRequest#getPathTranslated()
	 */
	public String getPathTranslated() {
		return f_request.getPathTranslated();
	}

	/**
	 * @see HttpServletRequest#getContextPath()
	 */
	public String getContextPath() {
		return f_request.getContextPath();
	}

	/**
	 * @see HttpServletRequest#getQueryString()
	 */
	public String getQueryString() {
		return f_request.getQueryString();
	}

	/**
	 * @see HttpServletRequest#getRemoteUser()
	 */
	public String getRemoteUser() {
		//TODO
		String user = f_request.getRemoteUser();
		if (user == null) {
			HttpSession session = getSession();
			if (session != null) {
				user = (String)session.getAttribute("username");
			}
		}
		return user;
	}

	/**
	 * @see HttpServletRequest#isUserInRole(String)
	 */
	public boolean isUserInRole(String arg0) {
		return f_request.isUserInRole(arg0);
	}

	/**
	 * @see HttpServletRequest#getUserPrincipal()
	 */
	public Principal getUserPrincipal() {
		return f_request.getUserPrincipal();
	}

	/**
	 * @see HttpServletRequest#getRequestedSessionId()
	 */
	public String getRequestedSessionId() {
		return f_request.getRequestedSessionId();
	}

	/**
	 * @see HttpServletRequest#getRequestURI()
	 */
	public String getRequestURI() {
		return f_request.getRequestURI();
	}

	/**
	 * @see HttpServletRequest#getRequestURL()
	 */
	public StringBuffer getRequestURL() {
		return f_request.getRequestURL();
	}

	/**
	 * @see HttpServletRequest#getServletPath()
	 */
	public String getServletPath() {
		return f_request.getServletPath();
	}

	/**
	 * @see HttpServletRequest#getSession(boolean)
	 */
	public HttpSession getSession(boolean create) {
		if (create) {
			return new ButorSession(f_request.getSession(true));
		} 
		return f_javaroSession;
	}

	/**
	 * @see HttpServletRequest#getSession()
	 */
	public HttpSession getSession() {
		return f_javaroSession;
	}

	/**
	 * @see HttpServletRequest#isRequestedSessionIdValid()
	 */
	public boolean isRequestedSessionIdValid() {
		return f_request.isRequestedSessionIdValid();
	}

	/**
	 * @see HttpServletRequest#isRequestedSessionIdFromCookie()
	 */
	public boolean isRequestedSessionIdFromCookie() {
		return f_request.isRequestedSessionIdFromCookie();
	}

	/**
	 * @see HttpServletRequest#isRequestedSessionIdFromURL()
	 */
	public boolean isRequestedSessionIdFromURL() {
		return f_request.isRequestedSessionIdFromURL();
	}

	/*
	 * @see HttpServletRequest#isRequestedSessionIdFromUrl()
	 * @deprecated
	 *
	public boolean isRequestedSessionIdFromUrl() {
		return f_request.isRequestedSessionIdFromUrl();
	} */

	/**
	 * @see ServletRequest#getAttribute(String)
	 */
	public Object getAttribute(String arg0) {
		return f_request.getAttribute(arg0);
	}

	/**
	 * @see ServletRequest#getAttributeNames()
	 */
	public Enumeration getAttributeNames() {
		return f_request.getAttributeNames();
	}

	/**
	 * @see ServletRequest#getCharacterEncoding()
	 */
	public String getCharacterEncoding() {
		return f_request.getCharacterEncoding();
	}

	/**
	 * @see ServletRequest#setCharacterEncoding(String)
	 */
	public void setCharacterEncoding(String arg0)
		throws UnsupportedEncodingException {
		f_request.setCharacterEncoding(arg0);
	}

	/**
	 * @see ServletRequest#getContentLength()
	 */
	public int getContentLength() {
		return f_request.getContentLength();
	}

	/**
	 * @see ServletRequest#getContentType()
	 */
	public String getContentType() {
		return f_request.getContentType();
	}

	/**
	 * @see ServletRequest#getInputStream()
	 */
	public ServletInputStream getInputStream() throws IOException {
		return f_request.getInputStream();
	}

	/**
	 * @see ServletRequest#getParameter(String)
	 */
	public String getParameter(String arg0) {
		return f_request.getParameter(arg0);
	}

	/**
	 * @see ServletRequest#getParameterNames()
	 */
	public Enumeration getParameterNames() {
		return f_request.getParameterNames();
	}

	/**
	 * @see ServletRequest#getParameterValues(String)
	 */
	public String[] getParameterValues(String arg0) {
		return f_request.getParameterValues(arg0);
	}

	/**
	 * @see ServletRequest#getParameterMap()
	 */
	public Map getParameterMap() {
		return f_request.getParameterMap();
	}

	/**
	 * @see ServletRequest#getProtocol()
	 */
	public String getProtocol() {
		return f_request.getProtocol();
	}

	/**
	 * @see ServletRequest#getScheme()
	 */
	public String getScheme() {
		return f_request.getScheme();
	}

	/**
	 * @see ServletRequest#getServerName()
	 */
	public String getServerName() {
		return f_request.getServerName();
	}

	/**
	 * @see ServletRequest#getServerPort()
	 */
	public int getServerPort() {
		return f_request.getServerPort();
	}

	/**
	 * @see ServletRequest#getReader()
	 */
	public BufferedReader getReader() throws IOException {
		return f_request.getReader();
	}

	/**
	 * @see ServletRequest#getRemoteAddr()
	 */
	public String getRemoteAddr() {
		return f_request.getRemoteAddr();
	}

	/**
	 * @see ServletRequest#getRemoteHost()
	 */
	public String getRemoteHost() {
		return f_request.getRemoteHost();
	}

	/**
	 * @see ServletRequest#setAttribute(String, Object)
	 */
	public void setAttribute(String arg0, Object arg1) {
		f_request.setAttribute(arg0, arg1);
	}

	/**
	 * @see ServletRequest#removeAttribute(String)
	 */
	public void removeAttribute(String arg0) {
		f_request.removeAttribute(arg0);
	}

	/**
	 * @see ServletRequest#getLocale()
	 */
	public Locale getLocale() {
		return f_request.getLocale();
	}

	/**
	 * @see ServletRequest#getLocales()
	 */
	public Enumeration getLocales() {
		return f_request.getLocales();
	}

	/**
	 * @see ServletRequest#isSecure()
	 */
	public boolean isSecure() {
		return f_request.isSecure();
	}

	/**
	 * @see ServletRequest#getRequestDispatcher(String)
	 */
	public RequestDispatcher getRequestDispatcher(String arg0) {
		return f_request.getRequestDispatcher(arg0);
	}

	/**
	 * @see HttpServletRequest#isRequestedSessionIdFromUrl()
	 * @deprecated
	 */
	public boolean isRequestedSessionIdFromUrl() {
		return f_request.isRequestedSessionIdFromURL();
	}

	/**
	 * @see ServletRequest#getRealPath(String)
	 * @deprecated
	 */
	public String getRealPath(String path) {
		return null;
	}

}