HttpServletRequestImpl (OfficeFloor 2.18.0 API)

java.lang.Object
- net.officefloor.plugin.servlet.container.HttpServletRequestImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, ServletRequestForwarder
```
public class HttpServletRequestImpl
extends Object
implements javax.servlet.http.HttpServletRequest, ServletRequestForwarder
```
HttpServletRequest implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields
Modifier and Type Field and Description

static String RFC1123_HEADER_DATE_FORMAT
RFC 1123 header date format.
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
- Fields inherited from interface net.officefloor.plugin.servlet.container.ServletRequestForwarder
  ATTRIBUTE_FORWARDER

Fields
Modifier and Type	Field and Description
`static String`	`RFC1123_HEADER_DATE_FORMAT` RFC 1123 header date format.

Constructor Summary

Constructors
Constructor and Description
`HttpServletRequestImpl(ServerHttpConnection connection, HttpRequestState requestAttributes, HttpServletSecurity security, String sessionIdIdentifierName, javax.servlet.http.HttpSession session, javax.servlet.ServletContext servletContext, Locale defaultLocale, TaskContext<?,?,?> taskContext)` Initiate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse arg0)`
`String`	`changeSessionId()`
`void`	`forward(String workName, String taskName, Object parameter)` Forwards the `ServletRequest`.
`javax.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String name)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String name)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map`	`getParameterMap()`
`Enumeration`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`javax.servlet.http.Part`	`getPart(String arg0)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String arg0, String arg1)`
`void`	`logout()`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`void`	`setCharacterEncoding(String env)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest arg0, javax.servlet.ServletResponse arg1)`
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> handlerClass)`

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

- Field Detail
  - RFC1123_HEADER_DATE_FORMAT
```
public static final String RFC1123_HEADER_DATE_FORMAT
```
    RFC 1123 header date format.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpServletRequestImpl
```
public HttpServletRequestImpl(ServerHttpConnection connection,
                              HttpRequestState requestAttributes,
                              HttpServletSecurity security,
                              String sessionIdIdentifierName,
                              javax.servlet.http.HttpSession session,
                              javax.servlet.ServletContext servletContext,
                              Locale defaultLocale,
                              TaskContext<?,?,?> taskContext)
                       throws IOException,
                              HttpRequestTokeniseException
```
    Initiate.
    
    Parameters:
    
    connection - ServerHttpConnection.
    
    requestAttributes - HttpRequestState.
    
    security - HttpServletSecurity.
    
    sessionIdIdentifierName - Name of identifier (e.g. cookie or parameter name) providing the session Id.
    
    session - HttpSession.
    
    servletContext - ServletContext.
    
    defaultLocale - Default Locale if not specified.
    
    taskContext - TaskContext.
    
    Throws:
    
    IOException - If fails to read data from the HttpRequest.
    
    HttpRequestTokeniseException - If fails to tokenise the HttpRequest.
- Method Detail
  - forward
```
public void forward(String workName,
                    String taskName,
                    Object parameter)
             throws javax.servlet.ServletException
```
    Description copied from interface: ServletRequestForwarder
    
    Forwards the ServletRequest.
    
    Specified by:
    
    forward in interface ServletRequestForwarder
    
    Parameters:
    
    workName - Name of Work to forward the ServletRequest.
    
    taskName - Name of Task on the Work to forward the ServletRequest.
    
    parameter - Parameter for the Task.
    
    Throws:
    
    javax.servlet.ServletException - If fails to forward the ServletRequest.
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - getParameterMap
```
public Map getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getParameterNames
```
public Enumeration getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String name)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public Enumeration getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration getHeaders(String name)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String name)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Specified by:
    
    getServletContext in interface javax.servlet.ServletRequest
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    Specified by:
    
    isAsyncStarted in interface javax.servlet.ServletRequest
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    Specified by:
    
    isAsyncSupported in interface javax.servlet.ServletRequest
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest arg0,
                                             javax.servlet.ServletResponse arg1)
                                      throws IllegalStateException
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
    
    Throws:
    
    IllegalStateException
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse arg0)
                     throws IOException,
                            javax.servlet.ServletException
```
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getPart
```
public javax.servlet.http.Part getPart(String arg0)
                                throws IOException,
                                       javax.servlet.ServletException
```
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getParts
```
public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException
```
    Specified by:
    
    getParts in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - login
```
public void login(String arg0,
                  String arg1)
           throws javax.servlet.ServletException
```
    Specified by:
    
    login in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    Specified by:
    
    logout in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    javax.servlet.ServletException
  - getContentLengthLong
```
public long getContentLengthLong()
```
  - changeSessionId
```
public String changeSessionId()
```
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException
```
    Throws:
    
    IOException
    
    javax.servlet.ServletException

Class HttpServletRequestImpl

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Fields inherited from interface net.officefloor.plugin.servlet.container.ServletRequestForwarder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RFC1123_HEADER_DATE_FORMAT

Constructor Detail

HttpServletRequestImpl

Method Detail

forward

getContextPath

getMethod

getServletPath

getPathInfo

getPathTranslated

getQueryString

getRequestURI

getRequestURL

getContentLength

getParameter

getParameterMap

getParameterNames

getParameterValues

getProtocol

getReader

getInputStream

getScheme

getCookies

getDateHeader

getHeader

getHeaderNames

getHeaders

getIntHeader

getServerName

getServerPort

getRequestedSessionId

getSession

getSession

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdValid

getAttribute

getAttributeNames

removeAttribute

setAttribute

getCharacterEncoding

setCharacterEncoding

getContentType

getLocale

getLocales

getLocalAddr

getLocalName

getLocalPort

getRemoteAddr

getRemoteHost

getRemotePort

getRequestDispatcher

isSecure

getAuthType

getUserPrincipal

getRemoteUser

isUserInRole

getRealPath

isRequestedSessionIdFromUrl

getAsyncContext

getDispatcherType

getServletContext

isAsyncStarted

isAsyncSupported

startAsync

startAsync

authenticate

getPart

getParts

login

logout

getContentLengthLong