DefaultWebApplicationRequest (Piranha 20.4.0 API)

java.lang.Object
- java.io.InputStream
- - javax.servlet.ServletInputStream
  - - cloud.piranha.DefaultWebApplicationRequest

All Implemented Interfaces:

cloud.piranha.api.WebApplicationRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

Direct Known Subclasses:

DefaultWebApplicationServerRequest
```
public class DefaultWebApplicationRequest
extends javax.servlet.ServletInputStream
implements cloud.piranha.api.WebApplicationRequest
```
The default WebApplicationRequest.

Author:

Manfred Riem ([email protected])

Field Summary

Fields
Modifier and Type	Field	Description
`protected javax.servlet.AsyncContext`	`asyncContext`	Stores the async context.
`protected boolean`	`asyncStarted`	Stores if async is started.
`protected boolean`	`asyncSupported`	Stores if async is supported.
`protected cloud.piranha.api.AttributeManager`	`attributeManager`	Stores the attribute manager.
`protected java.lang.String`	`authType`	Stores the auth type.
`protected java.lang.String`	`characterEncoding`	Stores the character encoding.
`protected long`	`contentLength`	Stores the content length.
`protected java.lang.String`	`contentType`	Stores the content type.
`protected java.lang.String`	`contextPath`	Stores the context path.
`protected javax.servlet.http.Cookie[]`	`cookies`	Stores the cookies.
`protected java.lang.String`	`currentSessionId`	Stores the current session id.
`protected javax.servlet.DispatcherType`	`dispatcherType`	Stores the dispatcher type.
`protected boolean`	`gotInputStream`	Stores the gotInputStream flag.
`protected boolean`	`gotReader`	Stores the gotReader flag.
`protected cloud.piranha.api.HttpHeaderManager`	`headerManager`	Stores the header manager.
`protected java.io.InputStream`	`inputStream`	Stores the input stream.
`protected java.lang.String`	`localAddress`	Stores the local address.
`protected java.lang.String`	`localName`	Stores the local name.
`protected int`	`localPort`	Stores the local port.
`protected java.lang.String`	`method`	Stores the method.
`protected java.util.HashMap<java.lang.String,java.lang.String[]>`	`parameters`	Stores the parameters.
`protected boolean`	`parametersParsed`	Stores the parameters parsed flag.
`protected java.util.HashMap<java.lang.String,javax.servlet.http.Part>`	`parts`	Stores the parts.
`protected java.lang.String`	`pathInfo`	Stores the path info.
`protected java.lang.String`	`protocol`	Stores the protocol.
`protected java.lang.String`	`queryString`	Stores the query string.
`protected java.io.BufferedReader`	`reader`	Stores the reader.
`protected java.lang.String`	`remoteAddr`	Stores the remote address.
`protected java.lang.String`	`remoteHost`	Stores the remote host.
`protected int`	`remotePort`	Stores the remote port.
`protected java.lang.String`	`requestedSessionId`	Stores the requested session id.
`protected boolean`	`requestedSessionIdFromCookie`	Stores the requested session id from cookie flag.
`protected boolean`	`requestedSessionIdFromURL`	Stores the requested session id from url flag.
`protected java.lang.String`	`scheme`	Stores the scheme.
`protected java.lang.String`	`serverName`	Stores the server name.
`protected int`	`serverPort`	Stores the server port.
`protected java.lang.String`	`servletPath`	Stores the servlet path.
`protected boolean`	`upgraded`	Stores the upgraded flag.
`protected javax.servlet.http.HttpUpgradeHandler`	`upgradeHandler`	Stores the upgrade handler.
`protected java.security.Principal`	`userPrincipal`	Stores the user principal.
`protected cloud.piranha.api.WebApplication`	`webApplication`	Stores the web application

Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor Description

DefaultWebApplicationRequest()
Constructor.

Constructors
Constructor	Description
`DefaultWebApplicationRequest()`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`	Authenticate.
`java.lang.String`	`changeSessionId()`	Change the session id.
`javax.servlet.AsyncContext`	`getAsyncContext()`	Get the async context.
`java.lang.Object`	`getAttribute(java.lang.String name)`	Get the attribute.
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()`	Get attribute names.
`java.lang.String`	`getAuthType()`	Get the auth type.
`java.lang.String`	`getCharacterEncoding()`	Get the character encoding.
`int`	`getContentLength()`	Get the content length.
`long`	`getContentLengthLong()`	Get the content length.
`java.lang.String`	`getContentType()`	Get the content type.
`java.lang.String`	`getContextPath()`	Get the context path.
`javax.servlet.http.Cookie[]`	`getCookies()`	Get the cookies.
`long`	`getDateHeader(java.lang.String name)`	Get the date header.
`javax.servlet.DispatcherType`	`getDispatcherType()`	Get the dispatcher type.
`java.lang.String`	`getHeader(java.lang.String name)`	Get the header.
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()`	Get the header names.
`java.util.Enumeration<java.lang.String>`	`getHeaders(java.lang.String name)`	Get the headers.
`javax.servlet.ServletInputStream`	`getInputStream()`	Get the input stream.
`int`	`getIntHeader(java.lang.String name)`	Get the int header.
`java.lang.String`	`getLocalAddr()`	Get the local address.
`java.util.Locale`	`getLocale()`	Get locale.
`java.util.Enumeration<java.util.Locale>`	`getLocales()`	Get the locales.
`java.lang.String`	`getLocalName()`	Get the local name.
`int`	`getLocalPort()`	Get the local port.
`java.lang.String`	`getMethod()`	Get the request method.
`java.lang.String`	`getParameter(java.lang.String name)`	Get the parameter.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()`	Get the parameter map.
`java.util.Enumeration<java.lang.String>`	`getParameterNames()`	Get the parameter names.
`protected void`	`getParametersFromRequest()`	Get the parameters from the request.
`java.lang.String[]`	`getParameterValues(java.lang.String name)`	Get the parameter values.
`javax.servlet.http.Part`	`getPart(java.lang.String name)`	Get the part.
`java.util.Collection<javax.servlet.http.Part>`	`getParts()`	Get the parts.
`java.lang.String`	`getPathInfo()`	Get the path info.
`java.lang.String`	`getPathTranslated()`	Get the translated path.
`java.lang.String`	`getProtocol()`	Get the protocol.
`java.lang.String`	`getQueryString()`	Get the query string.
`java.io.BufferedReader`	`getReader()`	Get the reader.
`java.lang.String`	`getRealPath(java.lang.String path)`	Deprecated.
`java.lang.String`	`getRemoteAddr()`	Get the remote address.
`java.lang.String`	`getRemoteHost()`	Get the remote host.
`int`	`getRemotePort()`	Get the remote port.
`java.lang.String`	`getRemoteUser()`	Get the remote user.
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(java.lang.String path)`	Get the request dispatcher.
`java.lang.String`	`getRequestedSessionId()`	Get the requested session id.
`java.lang.String`	`getRequestURI()`	Get the request URI.
`java.lang.StringBuffer`	`getRequestURL()`	Get the request URL.
`java.lang.String`	`getScheme()`	Get the scheme.
`java.lang.String`	`getServerName()`	Get the server name.
`int`	`getServerPort()`	Get the server port.
`cloud.piranha.api.WebApplication`	`getServletContext()`	Get the servlet context.
`java.lang.String`	`getServletPath()`	Get the servlet path.
`javax.servlet.http.HttpSession`	`getSession()`	Get the session.
`javax.servlet.http.HttpSession`	`getSession(boolean create)`	Get the session.
`javax.servlet.http.HttpUpgradeHandler`	`getUpgradeHandler()`	Get the upgrade handler.
`java.security.Principal`	`getUserPrincipal()`	Get the user principal.
`boolean`	`isAsyncStarted()`	Is async started.
`boolean`	`isAsyncSupported()`	Is async supported.
`boolean`	`isFinished()`	Is the Servlet input stream finished?
`boolean`	`isReady()`	Is the Servlet input stream ready?
`boolean`	`isRequestedSessionIdFromCookie()`	Is the requested session id from cookie.
`boolean`	`isRequestedSessionIdFromUrl()`	Deprecated.
`boolean`	`isRequestedSessionIdFromURL()`	Is the requested session id from the request url.
`boolean`	`isRequestedSessionIdValid()`	Is the requested session id valid?
`boolean`	`isSecure()`	Is the request secure.
`boolean`	`isUpgraded()`	Is the request upgraded.
`boolean`	`isUserInRole(java.lang.String role)`	Is the user in the specified role.
`void`	`login(java.lang.String username, java.lang.String password)`	Login.
`void`	`logout()`	Logout.
`int`	`read()`	Read from the Servlet input stream.
`void`	`removeAttribute(java.lang.String name)`	Remove the attribute.
`void`	`setAsyncSupported(boolean asyncSupported)`	Set the async supported flag.
`void`	`setAttribute(java.lang.String name, java.lang.Object value)`	Set the attribute.
`void`	`setAuthType(java.lang.String authType)`	Set the auth type.
`void`	`setCharacterEncoding(java.lang.String characterEncoding)`	Set the character encoding.
`void`	`setContentLength(int contentLength)`	Set the content length.
`void`	`setContentType(java.lang.String contentType)`	Set the content type.
`void`	`setContextPath(java.lang.String contextPath)`	Set the context path.
`void`	`setCookies(javax.servlet.http.Cookie[] cookies)`	Set the cookies.
`void`	`setDispatcherType(javax.servlet.DispatcherType dispatcherType)`	Set the dispatcher type.
`void`	`setHeader(java.lang.String name, java.lang.String value)`	Set the header.
`void`	`setInputStream(java.io.InputStream inputStream)`	Set the input stream.
`void`	`setLocalAddr(java.lang.String localAddress)`	Set the local address.
`void`	`setLocalName(java.lang.String localName)`	Set the local name.
`void`	`setLocalPort(int localPort)`	Set the local port.
`void`	`setMethod(java.lang.String method)`	Set the method.
`void`	`setParameter(java.lang.String name, java.lang.String[] values)`	Set the parameter values.
`void`	`setPathInfo(java.lang.String pathInfo)`	Set the path info.
`void`	`setProtocol(java.lang.String protocol)`	Set the protocol.
`void`	`setQueryString(java.lang.String queryString)`	Set the query string.
`void`	`setReadListener(javax.servlet.ReadListener listener)`	Set the read listener.
`void`	`setRemoteAddr(java.lang.String remoteAddr)`	Set the remote address.
`void`	`setRemoteHost(java.lang.String remoteHost)`	Set the remote host.
`void`	`setRemotePort(int remotePort)`	Set the remote port.
`void`	`setRequestedSessionId(java.lang.String requestedSessionId)`	Set the requested session id.
`void`	`setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)`	Set the requested session id from cookie.
`void`	`setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)`	Set the request session id from URL flag.
`void`	`setScheme(java.lang.String scheme)`	Set the scheme.
`void`	`setServerName(java.lang.String serverName)`	Set the server name.
`void`	`setServerPort(int serverPort)`	Set the server port.
`void`	`setServletPath(java.lang.String servletPath)`	Set the servlet path.
`void`	`setUpgraded(boolean upgraded)`	Set the upgraded flag.
`void`	`setUserPrincipal(java.security.Principal userPrincipal)`	Set the user principal.
`void`	`setWebApplication(cloud.piranha.api.WebApplication webApplication)`	Set the web application.
`javax.servlet.AsyncContext`	`startAsync()`	Start async.
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)`	Start async.
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(java.lang.Class<T> handlerClass)`	Upgrade the request.
`protected void`	`verifyMultipartFormData()`	Verify the method is of type "multipart/form-data"

Methods inherited from interface javax.servlet.http.HttpServletRequest
getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

Methods inherited from class java.io.InputStream
available, close, mark, markSupported, read, read, readAllBytes, readNBytes, reset, skip, transferTo

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

Methods inherited from class javax.servlet.ServletInputStream
readLine

- Field Detail
  - authType
```
protected java.lang.String authType
```
    Stores the auth type.
  - asyncContext
```
protected javax.servlet.AsyncContext asyncContext
```
    Stores the async context.
  - asyncStarted
```
protected boolean asyncStarted
```
    Stores if async is started.
  - asyncSupported
```
protected boolean asyncSupported
```
    Stores if async is supported.
  - attributeManager
```
protected cloud.piranha.api.AttributeManager attributeManager
```
    Stores the attribute manager.
  - characterEncoding
```
protected java.lang.String characterEncoding
```
    Stores the character encoding.
  - contentLength
```
protected long contentLength
```
    Stores the content length.
  - contentType
```
protected java.lang.String contentType
```
    Stores the content type.
  - contextPath
```
protected java.lang.String contextPath
```
    Stores the context path.
  - cookies
```
protected javax.servlet.http.Cookie[] cookies
```
    Stores the cookies.
  - currentSessionId
```
protected java.lang.String currentSessionId
```
    Stores the current session id.
  - dispatcherType
```
protected javax.servlet.DispatcherType dispatcherType
```
    Stores the dispatcher type.
  - gotInputStream
```
protected boolean gotInputStream
```
    Stores the gotInputStream flag.
  - gotReader
```
protected boolean gotReader
```
    Stores the gotReader flag.
  - headerManager
```
protected cloud.piranha.api.HttpHeaderManager headerManager
```
    Stores the header manager.
  - inputStream
```
protected java.io.InputStream inputStream
```
    Stores the input stream.
  - localAddress
```
protected java.lang.String localAddress
```
    Stores the local address.
  - localName
```
protected java.lang.String localName
```
    Stores the local name.
  - localPort
```
protected int localPort
```
    Stores the local port.
  - method
```
protected java.lang.String method
```
    Stores the method.
  - parameters
```
protected java.util.HashMap<java.lang.String,java.lang.String[]> parameters
```
    Stores the parameters.
  - parametersParsed
```
protected boolean parametersParsed
```
    Stores the parameters parsed flag.
  - parts
```
protected java.util.HashMap<java.lang.String,javax.servlet.http.Part> parts
```
    Stores the parts.
  - pathInfo
```
protected java.lang.String pathInfo
```
    Stores the path info.
  - protocol
```
protected java.lang.String protocol
```
    Stores the protocol.
  - queryString
```
protected java.lang.String queryString
```
    Stores the query string.
  - reader
```
protected java.io.BufferedReader reader
```
    Stores the reader.
  - remoteAddr
```
protected java.lang.String remoteAddr
```
    Stores the remote address.
  - remoteHost
```
protected java.lang.String remoteHost
```
    Stores the remote host.
  - remotePort
```
protected int remotePort
```
    Stores the remote port.
  - requestedSessionId
```
protected java.lang.String requestedSessionId
```
    Stores the requested session id.
  - requestedSessionIdFromCookie
```
protected boolean requestedSessionIdFromCookie
```
    Stores the requested session id from cookie flag.
  - requestedSessionIdFromURL
```
protected boolean requestedSessionIdFromURL
```
    Stores the requested session id from url flag.
  - scheme
```
protected java.lang.String scheme
```
    Stores the scheme.
  - serverName
```
protected java.lang.String serverName
```
    Stores the server name.
  - serverPort
```
protected int serverPort
```
    Stores the server port.
  - servletPath
```
protected java.lang.String servletPath
```
    Stores the servlet path.
  - upgraded
```
protected boolean upgraded
```
    Stores the upgraded flag.
  - upgradeHandler
```
protected javax.servlet.http.HttpUpgradeHandler upgradeHandler
```
    Stores the upgrade handler.
  - userPrincipal
```
protected java.security.Principal userPrincipal
```
    Stores the user principal.
  - webApplication
```
protected cloud.piranha.api.WebApplication webApplication
```
    Stores the web application
- Constructor Detail
  - DefaultWebApplicationRequest
```
public DefaultWebApplicationRequest()
```
    Constructor.
- Method Detail
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws java.io.IOException,
                            javax.servlet.ServletException
```
    Authenticate.
    
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    response - the HTTP servlet response.
    
    Returns:
    
    true if authenticated, false otherwise.
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.
    
    javax.servlet.ServletException - when a Servlet error occurs.
  - changeSessionId
```
public java.lang.String changeSessionId()
```
    Change the session id.
    
    Specified by:
    
    changeSessionId in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the changed session id.
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Get the async context.
    
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
    
    Returns:
    
    the async context.
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Get the attribute.
    
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
    
    Parameters:
    
    name - the attribute name.
    
    Returns:
    
    the value.
  - getAttributeNames
```
public java.util.Enumeration<java.lang.String> getAttributeNames()
```
    Get attribute names.
    
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
    
    Returns:
    
    the attribute names.
  - getAuthType
```
public java.lang.String getAuthType()
```
    Get the auth type.
    
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the auth type.
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Get the character encoding.
    
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
    
    Returns:
    
    the character encoding.
  - getContentLength
```
public int getContentLength()
```
    Get the content length.
    
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
    
    Returns:
    
    the content length.
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Get the content length.
    
    Specified by:
    
    getContentLengthLong in interface javax.servlet.ServletRequest
    
    Returns:
    
    the content length.
  - getContentType
```
public java.lang.String getContentType()
```
    Get the content type.
    
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
    
    Returns:
    
    the content type.
  - getContextPath
```
public java.lang.String getContextPath()
```
    Get the context path.
    
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the context path.
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Get the cookies.
    
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the cookies.
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Get the date header.
    
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    name - the header name.
    
    Returns:
    
    the date header.
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Get the dispatcher type.
    
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest
    
    Returns:
    
    the dispatcher type.
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Get the header.
    
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    name - the header name.
    
    Returns:
    
    the header value.
  - getHeaderNames
```
public java.util.Enumeration<java.lang.String> getHeaderNames()
```
    Get the header names.
    
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the header names.
  - getHeaders
```
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
```
    Get the headers.
    
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    name - the header name.
    
    Returns:
    
    the header values.
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
```
    Get the input stream.
    
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Returns:
    
    the input stream.
    
    Throws:
    
    java.io.IOException - when a serious I/O error occurs.
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Get the int header.
    
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    name - the name.
    
    Returns:
    
    the int header.
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Get the local address.
    
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
    
    Returns:
    
    the local address.
  - getLocalName
```
public java.lang.String getLocalName()
```
    Get the local name.
    
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
    
    Returns:
    
    the local name.
  - getLocalPort
```
public int getLocalPort()
```
    Get the local port.
    
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
    
    Returns:
    
    the local port.
  - getLocale
```
public java.util.Locale getLocale()
```
    Get locale.
    
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
    
    Returns:
    
    the locale.
  - getLocales
```
public java.util.Enumeration<java.util.Locale> getLocales()
```
    Get the locales.
    
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
    
    Returns:
    
    the locales.
  - getMethod
```
public java.lang.String getMethod()
```
    Get the request method.
    
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the request method.
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Get the parameter.
    
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
    
    Parameters:
    
    name - the name.
    
    Returns:
    
    the value.
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Get the parameter map.
    
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
    
    Returns:
    
    the parameter map.
  - getParameterNames
```
public java.util.Enumeration<java.lang.String> getParameterNames()
```
    Get the parameter names.
    
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
    
    Returns:
    
    the parameter names.
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Get the parameter values.
    
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
    
    Parameters:
    
    name - the parameter name.
    
    Returns:
    
    the parameter values.
  - getParametersFromRequest
```
protected void getParametersFromRequest()
```
    Get the parameters from the request.
  - getPart
```
public javax.servlet.http.Part getPart(java.lang.String name)
                                throws java.io.IOException,
                                       javax.servlet.ServletException
```
    Get the part.
    
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    name - the name.
    
    Returns:
    
    the part, or null.
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.
    
    javax.servlet.ServletException - when a servlet error occurs.
  - getParts
```
public java.util.Collection<javax.servlet.http.Part> getParts()
                                                       throws java.io.IOException,
                                                              javax.servlet.ServletException
```
    Get the parts.
    
    Specified by:
    
    getParts in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the parts.
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.
    
    javax.servlet.ServletException - when a servlet error occurs.
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Get the path info.
    
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the path info.
  - getPathTranslated
```
public java.lang.String getPathTranslated()
```
    Get the translated path.
    
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the translated path.
  - getProtocol
```
public java.lang.String getProtocol()
```
    Get the protocol.
    
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
    
    Returns:
    
    the protocol.
  - getQueryString
```
public java.lang.String getQueryString()
```
    Get the query string.
    
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the query string.
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.IOException
```
    Get the reader.
    
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Returns:
    
    the reader.
    
    Throws:
    
    java.io.IOException - when a serious I/O error occurs.
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Deprecated.
    
    Get the real path.
    
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
    
    Parameters:
    
    path - the path.
    
    Returns:
    
    the real path.
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Get the remote address.
    
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
    
    Returns:
    
    the remote address.
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Get the remote host.
    
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
    
    Returns:
    
    the remote host.
  - getRemotePort
```
public int getRemotePort()
```
    Get the remote port.
    
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
    
    Returns:
    
    the remote port.
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Get the remote user.
    
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the remote user.
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
```
    Get the request dispatcher.
    
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
    
    Parameters:
    
    path - the path.
    
    Returns:
    
    the request dispatcher.
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Get the request URI.
    
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the request URI.
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Get the request URL.
    
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the request URL.
  - getRequestedSessionId
```
public java.lang.String getRequestedSessionId()
```
    Get the requested session id.
    
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the requested session id.
  - getScheme
```
public java.lang.String getScheme()
```
    Get the scheme.
    
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
    
    Returns:
    
    the scheme.
  - getServerName
```
public java.lang.String getServerName()
```
    Get the server name.
    
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
    
    Returns:
    
    the server name.
  - getServerPort
```
public int getServerPort()
```
    Get the server port.
    
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
    
    Returns:
    
    the server port.
  - getServletContext
```
public cloud.piranha.api.WebApplication getServletContext()
```
    Get the servlet context.
    
    Specified by:
    
    getServletContext in interface javax.servlet.ServletRequest
    
    Returns:
    
    the servlet context.
  - getServletPath
```
public java.lang.String getServletPath()
```
    Get the servlet path.
    
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the servlet path.
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Get the session.
    
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the session.
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    Get the session.
    
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    create - to create it or not.
    
    Returns:
    
    the session.
  - getUpgradeHandler
```
public javax.servlet.http.HttpUpgradeHandler getUpgradeHandler()
```
    Get the upgrade handler.
    
    Returns:
    
    the upgrade handler.
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
    Get the user principal.
    
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the user principal.
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Is async started.
    
    Specified by:
    
    isAsyncStarted in interface javax.servlet.ServletRequest
    
    Returns:
    
    is async started.
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Is async supported.
    
    Specified by:
    
    isAsyncSupported in interface javax.servlet.ServletRequest
    
    Returns:
    
    true if is async is supported.
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Is the requested session id from cookie.
    
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    if the requested session id from cookie.
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Is the requested session id from the request url.
    
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    if the requested session id from the request url.
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Deprecated.
    
    Is the requested session id from the request url.
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    if the requested session id from the request url.
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Is the requested session id valid?
    
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    true if it is, false otherwise.
  - isSecure
```
public boolean isSecure()
```
    Is the request secure.
    
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
    
    Returns:
    
    is the request secure.
  - isUpgraded
```
public boolean isUpgraded()
```
    Is the request upgraded.
    
    Returns:
    
    false
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Is the user in the specified role.
    
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    role - the role.
    
    Returns:
    
    if the user in the specified role.
  - login
```
public void login(java.lang.String username,
                  java.lang.String password)
           throws javax.servlet.ServletException
```
    Login.
    
    Specified by:
    
    login in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    username - the username.
    
    password - the password.
    
    Throws:
    
    javax.servlet.ServletException - when a serious error occurs.
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Logout.
    
    Specified by:
    
    logout in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException - when a serious error occurs.
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Remove the attribute.
    
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
    
    Parameters:
    
    name - the name.
  - setAsyncSupported
```
public void setAsyncSupported(boolean asyncSupported)
```
    Set the async supported flag.
    
    Parameters:
    
    asyncSupported - the async supported flag.
  - setAttribute
```
public void setAttribute(java.lang.String name,
                         java.lang.Object value)
```
    Set the attribute.
    
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
    
    Parameters:
    
    name - the name.
    
    value - the value.
  - setAuthType
```
public void setAuthType(java.lang.String authType)
```
    Set the auth type.
    
    Parameters:
    
    authType - the auth type.
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String characterEncoding)
                          throws java.io.UnsupportedEncodingException
```
    Set the character encoding.
    
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Parameters:
    
    characterEncoding - the character encoding.
    
    Throws:
    
    java.io.UnsupportedEncodingException - when the encoding is not supported.
  - setContentLength
```
public void setContentLength(int contentLength)
```
    Set the content length.
    
    Parameters:
    
    contentLength - the content length.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Set the content type.
    
    Parameters:
    
    contentType - the content type.
  - setContextPath
```
public void setContextPath(java.lang.String contextPath)
```
    Set the context path.
    
    Parameters:
    
    contextPath - the context path.
  - setCookies
```
public void setCookies(javax.servlet.http.Cookie[] cookies)
```
    Set the cookies.
    
    Parameters:
    
    cookies - the cookies.
  - setDispatcherType
```
public void setDispatcherType(javax.servlet.DispatcherType dispatcherType)
```
    Set the dispatcher type.
    
    Specified by:
    
    setDispatcherType in interface cloud.piranha.api.WebApplicationRequest
    
    Parameters:
    
    dispatcherType - the dispatcher type.
  - setHeader
```
public void setHeader(java.lang.String name,
                      java.lang.String value)
```
    Set the header.
    
    Parameters:
    
    name - the name.
    
    value - the value (string).
  - setInputStream
```
public void setInputStream(java.io.InputStream inputStream)
```
    Set the input stream.
    
    Parameters:
    
    inputStream - the input stream.
  - setLocalAddr
```
public void setLocalAddr(java.lang.String localAddress)
```
    Set the local address.
    
    Parameters:
    
    localAddress - the local address.
  - setLocalName
```
public void setLocalName(java.lang.String localName)
```
    Set the local name.
    
    Parameters:
    
    localName - the local name.
  - setLocalPort
```
public void setLocalPort(int localPort)
```
    Set the local port.
    
    Parameters:
    
    localPort - the local port.
  - setMethod
```
public void setMethod(java.lang.String method)
```
    Set the method.
    
    Parameters:
    
    method - the method.
  - setParameter
```
public void setParameter(java.lang.String name,
                         java.lang.String[] values)
```
    Set the parameter values.
    
    Parameters:
    
    name - the parameter name.
    
    values - the values.
  - setPathInfo
```
public void setPathInfo(java.lang.String pathInfo)
```
    Set the path info.
    
    Parameters:
    
    pathInfo - the path info.
  - setProtocol
```
public void setProtocol(java.lang.String protocol)
```
    Set the protocol.
    
    Parameters:
    
    protocol - the protocol.
  - setQueryString
```
public void setQueryString(java.lang.String queryString)
```
    Set the query string.
    
    Parameters:
    
    queryString - the query string.
  - setRemoteAddr
```
public void setRemoteAddr(java.lang.String remoteAddr)
```
    Set the remote address.
    
    Parameters:
    
    remoteAddr - the remote address.
  - setRemoteHost
```
public void setRemoteHost(java.lang.String remoteHost)
```
    Set the remote host.
    
    Parameters:
    
    remoteHost - the remote host.
  - setRemotePort
```
public void setRemotePort(int remotePort)
```
    Set the remote port.
    
    Parameters:
    
    remotePort - the remote port.
  - setRequestedSessionId
```
public void setRequestedSessionId(java.lang.String requestedSessionId)
```
    Set the requested session id.
    
    Parameters:
    
    requestedSessionId - the requested session id.
  - setRequestedSessionIdFromCookie
```
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdFromCookie)
```
    Set the requested session id from cookie.
    
    Parameters:
    
    requestedSessionIdFromCookie - the requested session id from cookie.
  - setRequestedSessionIdFromURL
```
public void setRequestedSessionIdFromURL(boolean requestedSessionIdFromURL)
```
    Set the request session id from URL flag.
    
    Parameters:
    
    requestedSessionIdFromURL - the requested session if from URL flag.
  - setScheme
```
public void setScheme(java.lang.String scheme)
```
    Set the scheme.
    
    Parameters:
    
    scheme - the scheme.
  - setServerName
```
public void setServerName(java.lang.String serverName)
```
    Set the server name.
    
    Parameters:
    
    serverName - the server name.
  - setServerPort
```
public void setServerPort(int serverPort)
```
    Set the server port.
    
    Parameters:
    
    serverPort - the server port.
  - setServletPath
```
public void setServletPath(java.lang.String servletPath)
```
    Set the servlet path.
    
    Parameters:
    
    servletPath - the servlet path.
  - setUpgraded
```
public void setUpgraded(boolean upgraded)
```
    Set the upgraded flag.
    
    Parameters:
    
    upgraded - the upgraded flag.
  - setUserPrincipal
```
public void setUserPrincipal(java.security.Principal userPrincipal)
```
    Set the user principal.
    
    Parameters:
    
    userPrincipal - the user principal.
  - setWebApplication
```
public void setWebApplication(cloud.piranha.api.WebApplication webApplication)
```
    Set the web application.
    
    Parameters:
    
    webApplication - the web application.
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
                                      throws java.lang.IllegalStateException
```
    Start async.
    
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Returns:
    
    the async context.
    
    Throws:
    
    java.lang.IllegalStateException - when async is not supported.
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest request,
                                             javax.servlet.ServletResponse response)
                                      throws java.lang.IllegalStateException
```
    Start async.
    
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Parameters:
    
    request - the request.
    
    response - the response.
    
    Returns:
    
    the async context.
    
    Throws:
    
    java.lang.IllegalStateException - when async is not supported.
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass)
                                                            throws java.io.IOException,
                                                                   javax.servlet.ServletException
```
    Upgrade the request.
    
    Specified by:
    
    upgrade in interface javax.servlet.http.HttpServletRequest
    
    Type Parameters:
    
    T - the type.
    
    Parameters:
    
    handlerClass - the handler class.
    
    Returns:
    
    the upgrade handler.
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.
    
    javax.servlet.ServletException - when a serious error occurs.
  - verifyMultipartFormData
```
protected void verifyMultipartFormData()
                                throws javax.servlet.ServletException
```
    Verify the method is of type "multipart/form-data"
    
    Throws:
    
    javax.servlet.ServletException - the exception thrown when it is not.
  - isFinished
```
public boolean isFinished()
```
    Is the Servlet input stream finished?
    
    Specified by:
    
    isFinished in class javax.servlet.ServletInputStream
    
    Returns:
    
    true if it is, false otherwise.
  - isReady
```
public boolean isReady()
```
    Is the Servlet input stream ready?
    
    Specified by:
    
    isReady in class javax.servlet.ServletInputStream
    
    Returns:
    
    true if it is, false otherwise.
  - setReadListener
```
public void setReadListener(javax.servlet.ReadListener listener)
```
    Set the read listener.
    
    Specified by:
    
    setReadListener in class javax.servlet.ServletInputStream
    
    Parameters:
    
    listener - the read listener.
  - read
```
public int read()
         throws java.io.IOException
```
    Read from the Servlet input stream.
    
    Specified by:
    
    read in class java.io.InputStream
    
    Returns:
    
    the read value.
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.

Class DefaultWebApplicationRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from interface javax.servlet.http.HttpServletRequest

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Methods inherited from class javax.servlet.ServletInputStream

Field Detail

authType

asyncContext

asyncStarted

asyncSupported

attributeManager

characterEncoding

contentLength

contentType

contextPath

cookies

currentSessionId

dispatcherType

gotInputStream

gotReader

headerManager

inputStream

localAddress

localName

localPort

method

parameters

parametersParsed

parts

pathInfo

protocol

queryString

reader

remoteAddr

remoteHost

remotePort

requestedSessionId

requestedSessionIdFromCookie

requestedSessionIdFromURL

scheme

serverName

serverPort

servletPath

upgraded

upgradeHandler

userPrincipal

webApplication

Constructor Detail

DefaultWebApplicationRequest

Method Detail

authenticate

changeSessionId

getAsyncContext

getAttribute

getAttributeNames

getAuthType

getCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getContextPath

getCookies

getDateHeader

getDispatcherType

getHeader

getHeaderNames

getHeaders

getInputStream

getIntHeader

getLocalAddr

getLocalName

getLocalPort

getLocale

getLocales

getMethod

getParameter