javax.servlet.http: public class: HttpServletRequestWrapper

javax.servlet.http
public class: HttpServletRequestWrapper [javadoc | source]

java.lang.Object
   javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper

All Implemented Interfaces:
HttpServletRequest, ServletRequest

Provides a convenient implementation of the HttpServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

Also see:

javax.servlet.http.HttpServletRequest

since: v - 2.3

Constructor:

Constructor:
public HttpServletRequestWrapper(HttpServletRequest request) { super(request); } Constructs a request object wrapping the given request. Throws: `java.lang.IllegalArgumentException` - if the request is null

 public HttpServletRequestWrapper(HttpServletRequest request) {
	    super(request);
}

Constructs a request object wrapping the given request.

Throws:

java.lang.IllegalArgumentException - if the request is null

Method from javax.servlet.http.HttpServletRequestWrapper Summary:
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestURI, getRequestURL, getRequestedSessionId, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdFromUrl, isRequestedSessionIdValid, isUserInRole

Method from javax.servlet.http.HttpServletRequestWrapper Summary:

getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestURI, getRequestURL, getRequestedSessionId, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromURL, isRequestedSessionIdFromUrl, isRequestedSessionIdValid, isUserInRole

Methods from javax.servlet.ServletRequestWrapper:
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

Methods from javax.servlet.ServletRequestWrapper:

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocalName, getLocalPort, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.servlet.http.HttpServletRequestWrapper Detail:
public String getAuthType() { return this._getHttpServletRequest().getAuthType(); } The default behavior of this method is to return getAuthType() on the wrapped request object.
public String getContextPath() { return this._getHttpServletRequest().getContextPath(); } The default behavior of this method is to return getContextPath() on the wrapped request object.
public Cookie[] getCookies() { return this._getHttpServletRequest().getCookies(); } The default behavior of this method is to return getCookies() on the wrapped request object.
public long getDateHeader(String name) { return this._getHttpServletRequest().getDateHeader(name); } The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
public String getHeader(String name) { return this._getHttpServletRequest().getHeader(name); } The default behavior of this method is to return getHeader(String name) on the wrapped request object.
public Enumeration getHeaderNames() { return this._getHttpServletRequest().getHeaderNames(); } The default behavior of this method is to return getHeaderNames() on the wrapped request object.
public Enumeration getHeaders(String name) { return this._getHttpServletRequest().getHeaders(name); } The default behavior of this method is to return getHeaders(String name) on the wrapped request object.
public int getIntHeader(String name) { return this._getHttpServletRequest().getIntHeader(name); } The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
public String getMethod() { return this._getHttpServletRequest().getMethod(); } The default behavior of this method is to return getMethod() on the wrapped request object.
public String getPathInfo() { return this._getHttpServletRequest().getPathInfo(); } The default behavior of this method is to return getPathInfo() on the wrapped request object.
public String getPathTranslated() { return this._getHttpServletRequest().getPathTranslated(); } The default behavior of this method is to return getPathTranslated() on the wrapped request object.
public String getQueryString() { return this._getHttpServletRequest().getQueryString(); } The default behavior of this method is to return getQueryString() on the wrapped request object.
public String getRemoteUser() { return this._getHttpServletRequest().getRemoteUser(); } The default behavior of this method is to return getRemoteUser() on the wrapped request object.
public String getRequestURI() { return this._getHttpServletRequest().getRequestURI(); } The default behavior of this method is to return getRequestURI() on the wrapped request object.
public StringBuffer getRequestURL() { return this._getHttpServletRequest().getRequestURL(); } The default behavior of this method is to return getRequestURL() on the wrapped request object.
public String getRequestedSessionId() { return this._getHttpServletRequest().getRequestedSessionId(); } The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
public String getServletPath() { return this._getHttpServletRequest().getServletPath(); } The default behavior of this method is to return getServletPath() on the wrapped request object.
public HttpSession getSession() { return this._getHttpServletRequest().getSession(); } The default behavior of this method is to return getSession() on the wrapped request object.
public HttpSession getSession(boolean create) { return this._getHttpServletRequest().getSession(create); } The default behavior of this method is to return getSession(boolean create) on the wrapped request object.
public Principal getUserPrincipal() { return this._getHttpServletRequest().getUserPrincipal(); } The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
public boolean isRequestedSessionIdFromCookie() { return this._getHttpServletRequest().isRequestedSessionIdFromCookie(); } The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.
public boolean isRequestedSessionIdFromURL() { return this._getHttpServletRequest().isRequestedSessionIdFromURL(); } The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.
public boolean isRequestedSessionIdFromUrl() { return this._getHttpServletRequest().isRequestedSessionIdFromUrl(); } The default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object.
public boolean isRequestedSessionIdValid() { return this._getHttpServletRequest().isRequestedSessionIdValid(); } The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.
public boolean isUserInRole(String role) { return this._getHttpServletRequest().isUserInRole(role); } The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.

Method from javax.servlet.http.HttpServletRequestWrapper Detail:

 public String getAuthType() {
	return this._getHttpServletRequest().getAuthType();
}

The default behavior of this method is to return getAuthType() on the wrapped request object.

 public String getContextPath() {
	return this._getHttpServletRequest().getContextPath();
}

The default behavior of this method is to return getContextPath() on the wrapped request object.

 public Cookie[] getCookies() {
	return this._getHttpServletRequest().getCookies();
}

The default behavior of this method is to return getCookies() on the wrapped request object.

 public long getDateHeader(String name) {
	return this._getHttpServletRequest().getDateHeader(name);
}

The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.

 public String getHeader(String name) {
	return this._getHttpServletRequest().getHeader(name);
}

The default behavior of this method is to return getHeader(String name) on the wrapped request object.

 public Enumeration getHeaderNames() {
	return this._getHttpServletRequest().getHeaderNames();
}

The default behavior of this method is to return getHeaderNames() on the wrapped request object.

 public Enumeration getHeaders(String name) {
	return this._getHttpServletRequest().getHeaders(name);
}

The default behavior of this method is to return getHeaders(String name) on the wrapped request object.

 public int getIntHeader(String name) {
	return this._getHttpServletRequest().getIntHeader(name);
}

The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.

 public String getMethod() {
	return this._getHttpServletRequest().getMethod();
}

The default behavior of this method is to return getMethod() on the wrapped request object.

 public String getPathInfo() {
	return this._getHttpServletRequest().getPathInfo();
}

The default behavior of this method is to return getPathInfo() on the wrapped request object.

 public String getPathTranslated() {
	return this._getHttpServletRequest().getPathTranslated();
}

The default behavior of this method is to return getPathTranslated() on the wrapped request object.

 public String getQueryString() {
	return this._getHttpServletRequest().getQueryString();
}

The default behavior of this method is to return getQueryString() on the wrapped request object.

 public String getRemoteUser() {
	return this._getHttpServletRequest().getRemoteUser();
}

The default behavior of this method is to return getRemoteUser() on the wrapped request object.

 public String getRequestURI() {
	return this._getHttpServletRequest().getRequestURI();
}

The default behavior of this method is to return getRequestURI() on the wrapped request object.

 public StringBuffer getRequestURL() {
	return this._getHttpServletRequest().getRequestURL();
}

The default behavior of this method is to return getRequestURL() on the wrapped request object.

 public String getRequestedSessionId() {
	return this._getHttpServletRequest().getRequestedSessionId();
}

The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.

 public String getServletPath() {
	return this._getHttpServletRequest().getServletPath();
}

The default behavior of this method is to return getServletPath() on the wrapped request object.

 public HttpSession getSession() {
	return this._getHttpServletRequest().getSession();
}

The default behavior of this method is to return getSession() on the wrapped request object.

 public HttpSession getSession(boolean create) {
	return this._getHttpServletRequest().getSession(create);
}

The default behavior of this method is to return getSession(boolean create) on the wrapped request object.

 public Principal getUserPrincipal() {
	return this._getHttpServletRequest().getUserPrincipal();
}

The default behavior of this method is to return getUserPrincipal() on the wrapped request object.

 public boolean isRequestedSessionIdFromCookie() {
	return this._getHttpServletRequest().isRequestedSessionIdFromCookie();
}

The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.

 public boolean isRequestedSessionIdFromURL() {
	return this._getHttpServletRequest().isRequestedSessionIdFromURL();
}

The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.

 public boolean isRequestedSessionIdFromUrl() {
	return this._getHttpServletRequest().isRequestedSessionIdFromUrl();
}

The default behavior of this method is to return isRequestedSessionIdFromUrl() on the wrapped request object.

 public boolean isRequestedSessionIdValid() {
	return this._getHttpServletRequest().isRequestedSessionIdValid();
}

The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.

 public boolean isUserInRole(String role) {
	return this._getHttpServletRequest().isUserInRole(role);
}

The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.