ServletHttpRequest (selenium-server 2.42.2 API)

java.lang.Object
- org.openqa.jetty.jetty.servlet.ServletHttpRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class ServletHttpRequest
extends Object
implements javax.servlet.http.HttpServletRequest
```
Servlet Request Wrapper. This class wraps a Jetty HTTP request as a 2.2 Servlet request.
Note that this wrapper is not synchronized and if a request is to be operated on by multiple threads, then higher level synchronizations may be required.

Version:

$Id: ServletHttpRequest.java,v 1.65 2005/08/13 00:01:27 gregwilkins Exp $

Author:

Greg Wilkins (gregw)

Field Summary

Fields
Modifier and Type Field and Description

static String __SESSIONID_COOKIE

static String __SESSIONID_NONE

static String __SESSIONID_NOT_CHECKED

static String __SESSIONID_URL
- 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 String`	`__SESSIONID_COOKIE`
`static String`	`__SESSIONID_NONE`
`static String`	`__SESSIONID_NOT_CHECKED`
`static String`	`__SESSIONID_URL`

Constructor Summary

Constructors
Constructor and Description

ServletHttpRequest(ServletHandler servletHandler, String pathInContext, HttpRequest request)
Constructor.

Constructors
Constructor and Description
`ServletHttpRequest(ServletHandler servletHandler, String pathInContext, HttpRequest request)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`String`	`getHeader(String name)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String s)`
`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()` This method is not recommended as it forces the generation of a non-optimal data structure.
`Enumeration`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)` Deprecated. As of Version 2.1 of the Java Servlet API, use `ServletContext.getRealPath(java.lang.String)` instead.
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String url)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`ServletHttpResponse`	`getServletHttpResponse()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()` Deprecated.
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setCharacterEncoding(String encoding)`
`String`	`toString()`
`static ServletHttpRequest`	`unwrap(javax.servlet.ServletRequest request)` Unwrap a ServletRequest.

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

- Field Detail
  - __SESSIONID_NOT_CHECKED
```
public static final String __SESSIONID_NOT_CHECKED
```
    See Also:
    Constant Field Values
  - __SESSIONID_URL
```
public static final String __SESSIONID_URL
```
    See Also:
    Constant Field Values
  - __SESSIONID_COOKIE
```
public static final String __SESSIONID_COOKIE
```
    See Also:
    Constant Field Values
  - __SESSIONID_NONE
```
public static final String __SESSIONID_NONE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ServletHttpRequest
```
public ServletHttpRequest(ServletHandler servletHandler,
                  String pathInContext,
                  HttpRequest request)
```
    Constructor.
- Method Detail
  - getServletHttpResponse
```
public ServletHttpResponse getServletHttpResponse()
```
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure 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
  - getHeaderNames
```
public Enumeration getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String name)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration getHeaders(String s)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String name)
                 throws NumberFormatException
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
    
    Throws:
    
    NumberFormatException
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath 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
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType 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
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal 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
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Specified by:
    
    isRequestedSessionIdValid 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
```
@Deprecated
public boolean isRequestedSessionIdFromUrl()
```
    Deprecated.
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - getAttributeNames
```
public Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                Object value)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
  - getParameterMap
```
public Map getParameterMap()
```
    This method is not recommended as it forces the generation of a non-optimal data structure.
    
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - getParameter
```
public String getParameter(String name)
```
    Specified by:
    
    getParameter 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
  - 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
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws UnsupportedEncodingException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - getRealPath
```
@Deprecated
public String getRealPath(String path)
```
    Deprecated. As of Version 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead.
    
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String url)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - unwrap
```
public static ServletHttpRequest unwrap(javax.servlet.ServletRequest request)
```
    Unwrap a ServletRequest.
    
    Parameters:
    request -
    
    Returns:
    The core ServletHttpRequest which must be the underlying request object
    See Also:
    ServletRequestWrapper, HttpServletRequestWrapper

Class ServletHttpRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__SESSIONID_NOT_CHECKED

__SESSIONID_URL

__SESSIONID_COOKIE

__SESSIONID_NONE

Constructor Detail

ServletHttpRequest

Method Detail

getServletHttpResponse

getLocale

getLocales

isSecure

getCookies

getDateHeader

getHeaderNames

getHeader

getHeaders

getIntHeader

getMethod

getContextPath

getPathInfo

getPathTranslated

getQueryString

getAuthType

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getAttributeNames

getAttribute

setAttribute

removeAttribute

setCharacterEncoding

getCharacterEncoding

getContentLength

getContentType

getInputStream

getParameterMap

getParameter

getParameterNames

getParameterValues

getProtocol

getScheme

getServerName

getServerPort

getRemotePort

getLocalName

getLocalAddr

getLocalPort

getReader

getRemoteAddr

getRemoteHost

getRealPath

getRequestDispatcher

toString

unwrap