Module com.aoapps.servlet.subrequest

Package com.aoapps.servlet.subrequest

Class ServletSubRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

com.aoapps.servlet.subrequest.ServletSubRequestWrapper

All Implemented Interfaces:

IServletSubRequest, ServletRequest

Direct Known Subclasses:

HttpServletSubRequestWrapper

public class ServletSubRequestWrapper
extends ServletRequestWrapper
implements IServletSubRequest

Wraps a servlet request with the intent to operate as a concurrent sub request. Any changes made to the request will only affect this request and will not be passed along to the wrapped request.

It is expected that the wrapped request will not change for the life of this wrapper. If it does change, the changes may or may not be visible depending on what has been accessed and changed on this request.

This class is not thread safe.

Constructor Summary

Constructors

Constructor	Description
ServletSubRequestWrapper(ServletRequest req)

Method Summary

Modifier and Type	Method	Description
AsyncContext	getAsyncContext()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
String	getCharacterEncoding()
ServletInputStream	getInputStream()
BufferedReader	getReader()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
void	removeAttribute(String name)
void	setAttribute(String name, Object o)
void	setCharacterEncoding(String enc)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest servletRequest, ServletResponse servletResponse)

Methods inherited from class javax.servlet.ServletRequestWrapper

getContentLength, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isSecure, isWrapperFor, isWrapperFor, setRequest

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

getContentLength, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isSecure

Constructor Details

ServletSubRequestWrapper

public ServletSubRequestWrapper(ServletRequest req)

Method Details

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface ServletRequest

Overrides:

getAttribute in class ServletRequestWrapper

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

Overrides:

getAttributeNames in class ServletRequestWrapper

setAttribute

public void setAttribute(String name,
 Object o)

Specified by:

setAttribute in interface ServletRequest

Overrides:

setAttribute in class ServletRequestWrapper

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletRequest

Overrides:

removeAttribute in class ServletRequestWrapper

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

Overrides:

getCharacterEncoding in class ServletRequestWrapper

setCharacterEncoding

public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Overrides:

setCharacterEncoding in class ServletRequestWrapper

Throws:

UnsupportedEncodingException

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Overrides:

getInputStream in class ServletRequestWrapper

Throws:

IOException

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Overrides:

getReader in class ServletRequestWrapper

Throws:

IOException

startAsync

public AsyncContext startAsync()
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Overrides:

startAsync in class ServletRequestWrapper

Throws:

IllegalStateException

startAsync

public AsyncContext startAsync(ServletRequest servletRequest,
 ServletResponse servletResponse)
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Overrides:

startAsync in class ServletRequestWrapper

Throws:

IllegalStateException

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

Overrides:

isAsyncStarted in class ServletRequestWrapper

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

Overrides:

isAsyncSupported in class ServletRequestWrapper

getAsyncContext

public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

Overrides:

getAsyncContext in class ServletRequestWrapper