Spring Framework

org.springframework.web.context.support
Class ContextExposingHttpServletRequest

java.lang.Object
  extended by javax.servlet.ServletRequestWrapper
      extended by javax.servlet.http.HttpServletRequestWrapper
          extended by org.springframework.web.context.support.ContextExposingHttpServletRequest
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class ContextExposingHttpServletRequest
extends javax.servlet.http.HttpServletRequestWrapper

HttpServletRequest decorator that makes all Spring beans in a given WebApplicationContext accessible as request attributes, through lazy checking once an attribute gets accessed.

Since:
2.5
Author:
Juergen Hoeller

Field Summary
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
ContextExposingHttpServletRequest(javax.servlet.http.HttpServletRequest originalRequest, WebApplicationContext context)
          Create a new ContextExposingHttpServletRequest for the given request.
ContextExposingHttpServletRequest(javax.servlet.http.HttpServletRequest originalRequest, WebApplicationContext context, java.util.Set<java.lang.String> exposedContextBeanNames)
          Create a new ContextExposingHttpServletRequest for the given request.
 
Method Summary
 java.lang.Object getAttribute(java.lang.String name)
           
 WebApplicationContext getWebApplicationContext()
          Return the WebApplicationContext that this request runs in.
 void setAttribute(java.lang.String name, java.lang.Object value)
           
 
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper
authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout
 
Methods inherited from class javax.servlet.ServletRequestWrapper
getAsyncContext, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setCharacterEncoding, setRequest, startAsync, startAsync
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setCharacterEncoding, startAsync, startAsync
 

Constructor Detail

ContextExposingHttpServletRequest

public ContextExposingHttpServletRequest(javax.servlet.http.HttpServletRequest originalRequest,
                                         WebApplicationContext context)
Create a new ContextExposingHttpServletRequest for the given request.

Parameters:
originalRequest - the original HttpServletRequest
context - the WebApplicationContext that this request runs in

ContextExposingHttpServletRequest

public ContextExposingHttpServletRequest(javax.servlet.http.HttpServletRequest originalRequest,
                                         WebApplicationContext context,
                                         java.util.Set<java.lang.String> exposedContextBeanNames)
Create a new ContextExposingHttpServletRequest for the given request.

Parameters:
originalRequest - the original HttpServletRequest
context - the WebApplicationContext that this request runs in
exposedContextBeanNames - the names of beans in the context which are supposed to be exposed (if this is non-null, only the beans in this Set are eligible for exposure as attributes)
Method Detail

getWebApplicationContext

public final WebApplicationContext getWebApplicationContext()
Return the WebApplicationContext that this request runs in.


getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Specified by:
getAttribute in interface javax.servlet.ServletRequest
Overrides:
getAttribute in class javax.servlet.ServletRequestWrapper

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
Specified by:
setAttribute in interface javax.servlet.ServletRequest
Overrides:
setAttribute in class javax.servlet.ServletRequestWrapper

Spring Framework