Module com.aoapps.servlet.subrequest

Package com.aoapps.servlet.subrequest

Class HttpServletSubRequest

java.lang.Object

com.aoapps.servlet.subrequest.ServletSubRequest

com.aoapps.servlet.subrequest.HttpServletSubRequest

All Implemented Interfaces:

IHttpServletSubRequest, IServletSubRequest, HttpServletRequest, ServletRequest

public class HttpServletSubRequest
extends ServletSubRequest
implements IHttpServletSubRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
HttpServletSubRequest(HttpServletRequest req)

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(HttpServletResponse response)
String	changeSessionId()
String	getAuthType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String name)
String	getHeader(String name)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
int	getIntHeader(String name)
String	getMethod()
Part	getPart(String name)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getQueryString()
String	getRemoteUser()
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
boolean	isLoggedOut()	Checks if HttpServletRequest.logout() was called during the subrequest.
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()	Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isUserInRole(String role)
void	login(String username, String password)
void	logout()
void	setMethod(String method)	Overrides the method for the subrequest.
<T extends HttpUpgradeHandler> T	upgrade(Class<T> type)

Methods inherited from class com.aoapps.servlet.subrequest.ServletSubRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, 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, setAttribute, setCharacterEncoding, 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, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, 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, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Details

HttpServletSubRequest

public HttpServletSubRequest(HttpServletRequest req)

Method Details

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface HttpServletRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletRequest

getHeaders

public Enumeration<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpServletRequest

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface HttpServletRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

setMethod

public void setMethod(String method)

Description copied from interface: IHttpServletSubRequest

Overrides the method for the subrequest.

Specified by:

setMethod in interface IHttpServletSubRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdFromUrl

@Deprecated(forRemoval=false)
public boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

login

public void login(String username,
 String password)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

isLoggedOut

public boolean isLoggedOut()

Description copied from interface: IHttpServletSubRequest

Checks if HttpServletRequest.logout() was called during the subrequest.

Specified by:

isLoggedOut in interface IHttpServletSubRequest

getParts

public Collection<Part> getParts()
                          throws IOException,
ServletException

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

getPart

public Part getPart(String name)
             throws IOException,
ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

upgrade

public <T extends HttpUpgradeHandler> T upgrade(Class<T> type)
                                         throws IOException,
ServletException

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException