HttpRequestImpl (TomEE :: Server

java.lang.Object
- org.apache.openejb.server.httpd.HttpRequestImpl

All Implemented Interfaces:

Serializable, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, HttpRequest
```
public class HttpRequestImpl
extends Object
implements HttpRequest
```
A class to take care of HTTP Requests. It parses headers, content, form and url parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class HttpRequestImpl.SessionInvalidateListener
- Nested classes/interfaces inherited from interface org.apache.openejb.server.httpd.HttpRequest
  HttpRequest.Method

Nested Classes
Modifier and Type	Class and Description
`protected class`	`HttpRequestImpl.SessionInvalidateListener`

Field Summary

Fields
Modifier and Type Field and Description

static InvocationHandler SERVLET_CONTEXT_HANDLER

static Class<?>[] SERVLET_CONTEXT_INTERFACES
- Fields inherited from interface org.apache.openejb.server.httpd.HttpRequest
  HEADER_ACCEPT, HEADER_ACCEPT_ENCODING, HEADER_ACCEPT_LANGUAGE, HEADER_CACHE_CONTROL, HEADER_CONNECTION, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_COOKIE, HEADER_HOST, HEADER_SET_COOKIE, HEADER_USER_AGENT, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Fields
Modifier and Type	Field and Description
`static InvocationHandler`	`SERVLET_CONTEXT_HANDLER`
`static Class<?>[]`	`SERVLET_CONTEXT_INTERFACES`

Constructor Summary

Constructors
Constructor and Description

HttpRequestImpl(URI socketURI)

Constructors
Constructor and Description
`HttpRequestImpl(URI socketURI)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addInternalParameter(String key, String val)`
`void`	`addQueryParams(String query)`
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse httpServletResponse)`
`String`	`changeSessionId()`
`void`	`destroy()`
`String`	`extractContextPath()`
`javax.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()`
`protected String`	`getCookie(String name)`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String s)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getFormParameter(String name)` Gets a form parameter based on the name passed in.
`Map<String,String>`	`getFormParameters()`
`String`	`getHeader(String name)` Gets a header based the header name passed in.
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String s)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`protected Map<?,?>`	`getInternalCookies()`
`int`	`getIntHeader(String s)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()` Gets the request method.
`String`	`getParameter(String name)` Gets a form or URL query parameter based on the name passed in.
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`Map<String,String>`	`getParameters()` Deprecated.
`String[]`	`getParameterValues(String s)`
`javax.servlet.http.Part`	`getPart(String s)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String s)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String s)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`HttpSession`	`getSession()`
`HttpSession`	`getSession(boolean create)`
`protected URI`	`getSocketURI()`
`URI`	`getURI()` Gets the URI for the current URL page.
`Principal`	`getUserPrincipal()`
`void`	`init()`
`void`	`initPathFromContext(String context)`
`void`	`initServletPath(String servlet)`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String s)`
`void`	`login(String s, String s1)`
`void`	`logout()`
`void`	`noPathInfo()`
`void`	`parseURI(StringTokenizer lineParts)` parses the URI into the different parts
`void`	`print(Logger log, boolean formatXml)`
`protected boolean`	`readMessage(InputStream input)` parses the request into the 3 different parts, request, headers, and body
`void`	`removeAttribute(String s)`
`String`	`requestRawPath()`
`void`	`setApplication(WebContext app)`
`void`	`setAttribute(String name, Object value)`
`void`	`setBeginListener(BeginWebBeansListener begin)`
`void`	`setCharacterEncoding(String s)`
`void`	`setEndListener(EndWebBeansListener end)`
`void`	`setPath(String path)`
`void`	`setUri(URI uri)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> httpUpgradeHandlerClass)`

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

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

- Field Detail
  - SERVLET_CONTEXT_INTERFACES
```
public static final Class<?>[] SERVLET_CONTEXT_INTERFACES
```
  - SERVLET_CONTEXT_HANDLER
```
public static final InvocationHandler SERVLET_CONTEXT_HANDLER
```
- Constructor Detail
  - HttpRequestImpl
```
public HttpRequestImpl(URI socketURI)
```
- Method Detail
  - setUri
```
public void setUri(URI uri)
```
  - getHeader
```
public String getHeader(String name)
```
    Gets a header based the header name passed in.
    
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
    
    Parameters:
    
    name - The name of the header to get
    
    Returns:
    
    The value of the header
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration<String> getHeaders(String s)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String s)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - getFormParameter
```
public String getFormParameter(String name)
```
    Gets a form parameter based on the name passed in.
    
    Parameters:
    
    name - The name of the form parameter to get
    
    Returns:
    
    The value of the parameter
  - getFormParameters
```
public Map<String,String> getFormParameters()
```
  - getMethod
```
public String getMethod()
```
    Gets the request method.
    
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
    
    Returns:
    
    the request method
  - getPart
```
public javax.servlet.http.Part getPart(String s)
                                throws IOException,
                                       javax.servlet.ServletException
```
    Specified by:
    
    getPart in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException
```
    Specified by:
    
    upgrade 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
  - noPathInfo
```
public void noPathInfo()
```
  - 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
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId 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
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - initServletPath
```
public void initServletPath(String servlet)
```
  - addQueryParams
```
public void addQueryParams(String query)
```
  - getURI
```
public URI getURI()
```
    Gets the URI for the current URL page.
    
    Specified by:
    
    getURI in interface HttpRequest
    
    Returns:
    
    the URI
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
    
    Specified by:
    
    getContentLength in interface HttpRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Specified by:
    
    getContentLengthLong in interface javax.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
    
    Specified by:
    
    getContentType in interface HttpRequest
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    Specified by:
    
    getDispatcherType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    Specified by:
    
    getLocales 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
  - readMessage
```
protected boolean readMessage(InputStream input)
                       throws IOException
```
    parses the request into the 3 different parts, request, headers, and body
    
    Parameters:
    
    input - the data input for this page
    
    Throws:
    
    IOException - if an exception is thrown
  - print
```
public void print(Logger log,
                  boolean formatXml)
```
  - parseURI
```
public void parseURI(StringTokenizer lineParts)
              throws IOException
```
    parses the URI into the different parts
    
    Parameters:
    
    lineParts - a StringTokenizer of the URI
    
    Throws:
    
    IOException - if an exeption is thrown
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse httpServletResponse)
                     throws IOException,
                            javax.servlet.ServletException
```
    Specified by:
    
    authenticate in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    IOException
    
    javax.servlet.ServletException
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - extractContextPath
```
public String extractContextPath()
```
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - getInternalCookies
```
protected Map<?,?> getInternalCookies()
```
  - getDateHeader
```
public long getDateHeader(String s)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getCookie
```
protected String getCookie(String name)
```
  - getSession
```
public HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSocketURI
```
protected URI getSocketURI()
```
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal 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
  - 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
  - isUserInRole
```
public boolean isUserInRole(String s)
```
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - login
```
public void login(String s,
                  String s1)
           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
  - getSession
```
public HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - changeSessionId
```
public String changeSessionId()
```
    Specified by:
    
    changeSessionId in interface javax.servlet.http.HttpServletRequest
  - getAsyncContext
```
public javax.servlet.AsyncContext getAsyncContext()
```
    Specified by:
    
    getAsyncContext in interface javax.servlet.ServletRequest
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
    
    Specified by:
    
    getAttribute in interface HttpRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object value)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
    
    Specified by:
    
    setAttribute in interface HttpRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String s)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - startAsync
```
public javax.servlet.AsyncContext startAsync()
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
  - startAsync
```
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
```
    Specified by:
    
    startAsync in interface javax.servlet.ServletRequest
  - addInternalParameter
```
public void addInternalParameter(String key,
                                 String val)
```
  - getParameter
```
public String getParameter(String name)
```
    Description copied from interface: HttpRequest
    
    Gets a form or URL query parameter based on the name passed in.
    
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
    
    Specified by:
    
    getParameter in interface HttpRequest
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String s)
```
    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
  - getRealPath
```
public String getRealPath(String s)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getParameters
```
@Deprecated
public Map<String,String> getParameters()
```
    Deprecated.
    
    Description copied from interface: HttpRequest
    
    Gets all the form and URL query parameters
    
    Specified by:
    
    getParameters in interface HttpRequest
    
    Returns:
    
    All the form and URL query parameters
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
    
    Specified by:
    
    getRemoteAddr in interface HttpRequest
  - 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 s)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort 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
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String s)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - setPath
```
public void setPath(String path)
```
  - requestRawPath
```
public String requestRawPath()
```
  - initPathFromContext
```
public void initPathFromContext(String context)
```
  - setEndListener
```
public void setEndListener(EndWebBeansListener end)
```
  - setApplication
```
public void setApplication(WebContext app)
```
  - setBeginListener
```
public void setBeginListener(BeginWebBeansListener begin)
```
  - init
```
public void init()
```
  - destroy
```
public void destroy()
```

Class HttpRequestImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.openejb.server.httpd.HttpRequest

Field Summary

Fields inherited from interface org.apache.openejb.server.httpd.HttpRequest

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.http.HttpServletRequest

Field Detail

SERVLET_CONTEXT_INTERFACES

SERVLET_CONTEXT_HANDLER

Constructor Detail

HttpRequestImpl

Method Detail

setUri

getHeader

getHeaderNames

getHeaders

getIntHeader

getFormParameter

getFormParameters

getMethod

getPart

upgrade

getParts

noPathInfo

getPathInfo

getPathTranslated

getQueryString

getRemoteUser

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

initServletPath

addQueryParams

getURI

getContentLength

getContentLengthLong

getContentType

getDispatcherType

getInputStream

getLocalAddr

getLocale

getLocales

getLocalName

getLocalPort

readMessage

print

parseURI

authenticate

getAuthType

getContextPath

extractContextPath

getCookies

getInternalCookies

getDateHeader

getCookie

getSession

getSocketURI

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL

isRequestedSessionIdValid

isUserInRole

login

logout

getSession

changeSessionId

getAsyncContext

getAttribute

getAttributeNames

getCharacterEncoding

setAttribute

setCharacterEncoding

startAsync

startAsync