WinstoneRequest (Winstone 0.9.10-jenkins-47 API)

java.lang.Object
- winstone.WinstoneRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest
```
public class WinstoneRequest
extends Object
implements HttpServletRequest
```
Implements the request interface required by the servlet spec.

Version:

$Id: WinstoneRequest.java,v 1.38 2007/10/28 16:29:02 rickknowles Exp $

Author:

Rick Knowles

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map`	`attributes`
`protected Stack`	`attributesStack`
`protected AuthenticationPrincipal`	`authenticatedUser`
`protected String`	`authorization`
`protected int`	`contentLength`
`protected String`	`contentType`
`protected Cookie[]`	`cookies`
`protected Map`	`currentSessionIds`
`protected String`	`deadRequestedSessionId`
`protected String`	`encoding`
`protected static DateFormat`	`headerDF`
`protected String[]`	`headers`
`protected HostGroup`	`hostGroup`
`protected WinstoneInputStream`	`inputData`
`protected BufferedReader`	`inputReader`
`protected boolean`	`isSecure`
`protected String`	`localAddr`
`protected List`	`locales`
`protected String`	`localName`
`protected int`	`localPort`
`protected String`	`method`
`protected Map`	`parameters`
`protected Stack`	`parametersStack`
`protected Boolean`	`parsedParameters` If true, it indicates that the request body was already consumed because of the call to `getParameterMap()` (or its sibling), which requires implicit form parameter parsing.
`protected String`	`pathInfo`
`protected String`	`protocol`
`protected String`	`queryString`
`protected String`	`remoteIP`
`protected String`	`remoteName`
`protected int`	`remotePort`
`protected ServletRequestAttributeListener[]`	`requestAttributeListeners`
`protected Map`	`requestedSessionIds`
`protected ServletRequestListener[]`	`requestListeners`
`protected String`	`requestURI`
`protected static Random`	`rnd`
`protected String`	`scheme`
`protected String`	`serverName`
`protected int`	`serverPort`
`protected ServletConfiguration`	`servletConfig`
`protected String`	`servletPath`
`protected WebAppConfiguration`	`webappConfig`

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

Constructor Summary

Constructors
Constructor and Description

WinstoneRequest()
InputStream factory method.

Constructors
Constructor and Description
`WinstoneRequest()` InputStream factory method.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addIncludeAttributes(String requestURI, String contextPath, String servletPath, String pathInfo, String queryString)`
`void`	`addIncludeQueryParameters(String queryString)`
`void`	`cleanUp()` Resets the request to be reused
`void`	`clearIncludeStackForForward()`
`static String`	`decodeURLToken(String in)`
`static String`	`decodeURLToken(String in, boolean isQueryString)`
`static String`	`decodeURLToken(String in, String encoding)` For decoding the URL encoding used on query strings
`static String`	`decodeURLToken(String in, String encoding, boolean isQueryString)`
`void`	`discardRequestBody()`
`static void`	`extractParameters(String urlEncodedParams, String encoding, Map outputParams, boolean overwrite)` Gets parameters from the url encoded parameter string
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`Map`	`getAttributes()`
`Stack`	`getAttributesStack()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`Cookie[]`	`getCookies()`
`Map`	`getCurrentSessionIds()`
`long`	`getDateHeader(String name)`
`String`	`getDeadRequestedSessionId()`
`String`	`getEncoding()`
`String`	`getHeader(String name)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String name)`
`HostGroup`	`getHostGroup()`
`ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`List`	`getListLocales()`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map`	`getParameterMap()`
`Enumeration`	`getParameterNames()`
`Map`	`getParameters()`
`Stack`	`getParametersStack()`
`String[]`	`getParameterValues(String name)`
`Boolean`	`getParsedParameters()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)` Deprecated.
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`RequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`Map`	`getRequestedSessionIds()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`ServletConfiguration`	`getServletConfig()`
`String`	`getServletPath()`
`HttpSession`	`getSession()`
`HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`WebAppConfiguration`	`getWebAppConfig()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()` Deprecated.
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`markSessionsAsRequestFinished(long lastAccessedTime, boolean saveSessions)`
`void`	`parseHeaders(List headerList)` Go through the list of headers, and build the headers/cookies arrays for the request object.
`void`	`parseRequestParameters()` This takes the parameters in the body of the request and puts them into the parameters map.
`void`	`removeAttribute(String name)`
`void`	`removeIncludeAttributes()`
`void`	`removeIncludeQueryString()`
`void`	`setAttribute(String name, Object o)`
`void`	`setAuthorization(String auth)`
`void`	`setCharacterEncoding(String encoding)`
`void`	`setContentLength(int len)`
`void`	`setContentType(String type)`
`void`	`setCurrentSessionIds(Map currentSessionIds)`
`void`	`setDeadRequestedSessionId(String deadRequestedSessionId)`
`void`	`setEncoding(String encoding)`
`void`	`setForwardQueryString(String forwardQueryString)`
`void`	`setHostGroup(HostGroup hostGroup)`
`void`	`setInputStream(WinstoneInputStream inputData)`
`void`	`setIsSecure(boolean isSecure)`
`void`	`setLocalAddr(String ip)`
`void`	`setLocales(List locales)`
`void`	`setLocalName(String name)`
`void`	`setLocalPort(int port)`
`void`	`setMethod(String method)`
`void`	`setParsedParameters(Boolean parsed)`
`void`	`setPathInfo(String pathInfo)`
`void`	`setProtocol(String protocolString)`
`void`	`setQueryString(String queryString)`
`void`	`setRemoteIP(String remoteIP)`
`void`	`setRemoteName(String name)`
`void`	`setRemotePort(int port)`
`void`	`setRemoteUser(AuthenticationPrincipal user)`
`void`	`setRequestAttributeListeners(ServletRequestAttributeListener[] ral)`
`void`	`setRequestedSessionIds(Map requestedSessionIds)`
`void`	`setRequestListeners(ServletRequestListener[] rl)`
`void`	`setRequestURI(String requestURI)`
`void`	`setScheme(String scheme)`
`void`	`setServerName(String name)`
`void`	`setServerPort(int port)`
`void`	`setServletConfig(ServletConfiguration servletConfig)`
`void`	`setServletPath(String servletPath)`
`void`	`setWebAppConfig(WebAppConfiguration webappConfig)`

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

Field Detail

headerDF
```
protected static DateFormat headerDF
```

rnd
```
protected static Random rnd
```

attributes
```
protected Map attributes
```

parameters
```
protected Map parameters
```

attributesStack
```
protected Stack attributesStack
```

parametersStack
```
protected Stack parametersStack
```

headers
```
protected String[] headers
```

cookies
```
protected Cookie[] cookies
```

method
```
protected String method
```

scheme
```
protected String scheme
```

serverName
```
protected String serverName
```

requestURI
```
protected String requestURI
```

servletPath
```
protected String servletPath
```

pathInfo
```
protected String pathInfo
```

queryString
```
protected String queryString
```

protocol
```
protected String protocol
```

contentLength
```
protected int contentLength
```

contentType
```
protected String contentType
```

encoding
```
protected String encoding
```

serverPort
```
protected int serverPort
```

remoteIP
```
protected String remoteIP
```

remoteName
```
protected String remoteName
```

remotePort
```
protected int remotePort
```

localAddr
```
protected String localAddr
```

localName
```
protected String localName
```

localPort
```
protected int localPort
```

parsedParameters
```
protected Boolean parsedParameters
```
If true, it indicates that the request body was already consumed because of the call to getParameterMap() (or its sibling), which requires implicit form parameter parsing. If false, it indicates that the request body shall not be consumed by the said method, because the application already called getInputStream() and showed the intent to parse the request body on its own. If null, it indicates that we haven't come to that decision.

requestedSessionIds
```
protected Map requestedSessionIds
```

currentSessionIds
```
protected Map currentSessionIds
```

deadRequestedSessionId

protected String deadRequestedSessionId

locales
```
protected List locales
```

authorization
```
protected String authorization
```

isSecure
```
protected boolean isSecure
```

inputData

protected WinstoneInputStream inputData

inputReader
```
protected BufferedReader inputReader
```

servletConfig

protected ServletConfiguration servletConfig

webappConfig

protected WebAppConfiguration webappConfig

hostGroup
```
protected HostGroup hostGroup
```

authenticatedUser

protected AuthenticationPrincipal authenticatedUser

requestAttributeListeners

protected ServletRequestAttributeListener[] requestAttributeListeners

requestListeners

protected ServletRequestListener[] requestListeners

Constructor Detail
- WinstoneRequest
```
public WinstoneRequest()
```
  InputStream factory method.

Method Detail

cleanUp
```
public void cleanUp()
```
Resets the request to be reused

getAttributes
```
public Map getAttributes()
```

getParameters
```
public Map getParameters()
```

getAttributesStack
```
public Stack getAttributesStack()
```

getParametersStack
```
public Stack getParametersStack()
```

getCurrentSessionIds
```
public Map getCurrentSessionIds()
```

getRequestedSessionIds
```
public Map getRequestedSessionIds()
```

getDeadRequestedSessionId

public String getDeadRequestedSessionId()

getHostGroup
```
public HostGroup getHostGroup()
```

getWebAppConfig

public WebAppConfiguration getWebAppConfig()

getServletConfig

public ServletConfiguration getServletConfig()

getEncoding
```
public String getEncoding()
```

getParsedParameters
```
public Boolean getParsedParameters()
```

getListLocales
```
public List getListLocales()
```

setInputStream

public void setInputStream(WinstoneInputStream inputData)

setHostGroup

public void setHostGroup(HostGroup hostGroup)

setWebAppConfig

public void setWebAppConfig(WebAppConfiguration webappConfig)

setServletConfig

public void setServletConfig(ServletConfiguration servletConfig)

setServerPort
```
public void setServerPort(int port)
```

setRemoteIP

public void setRemoteIP(String remoteIP)

setRemoteName

public void setRemoteName(String name)

setRemotePort
```
public void setRemotePort(int port)
```

setLocalAddr
```
public void setLocalAddr(String ip)
```

setLocalName

public void setLocalName(String name)

setLocalPort
```
public void setLocalPort(int port)
```

setMethod
```
public void setMethod(String method)
```

setIsSecure

public void setIsSecure(boolean isSecure)

setQueryString

public void setQueryString(String queryString)

setServerName

public void setServerName(String name)

setRequestURI

public void setRequestURI(String requestURI)

setScheme
```
public void setScheme(String scheme)
```

setServletPath

public void setServletPath(String servletPath)

setPathInfo

public void setPathInfo(String pathInfo)

setProtocol

public void setProtocol(String protocolString)

setRemoteUser

public void setRemoteUser(AuthenticationPrincipal user)

setContentLength

public void setContentLength(int len)

setContentType

public void setContentType(String type)

setAuthorization

public void setAuthorization(String auth)

setLocales
```
public void setLocales(List locales)
```

setCurrentSessionIds

public void setCurrentSessionIds(Map currentSessionIds)

setRequestedSessionIds

public void setRequestedSessionIds(Map requestedSessionIds)

setDeadRequestedSessionId

public void setDeadRequestedSessionId(String deadRequestedSessionId)

setEncoding

public void setEncoding(String encoding)

setParsedParameters

public void setParsedParameters(Boolean parsed)

setRequestListeners

public void setRequestListeners(ServletRequestListener[] rl)

setRequestAttributeListeners

public void setRequestAttributeListeners(ServletRequestAttributeListener[] ral)

extractParameters

public static void extractParameters(String urlEncodedParams,
                     String encoding,
                     Map outputParams,
                     boolean overwrite)

Gets parameters from the url encoded parameter string

decodeURLToken

public static String decodeURLToken(String in)

decodeURLToken

public static String decodeURLToken(String in,
                    String encoding)
                             throws UnsupportedEncodingException

For decoding the URL encoding used on query strings

Throws:: UnsupportedEncodingException

decodeURLToken

public static String decodeURLToken(String in,
                    boolean isQueryString)

decodeURLToken

public static String decodeURLToken(String in,
                    String encoding,
                    boolean isQueryString)
                             throws UnsupportedEncodingException

Parameters:: isQueryString - Decode query string, where '+' is an escape for ' '. Otherwise decode as path token, where '+' is not an escape character.
Throws:: UnsupportedEncodingException

discardRequestBody
```
public void discardRequestBody()
```

parseRequestParameters
```
public void parseRequestParameters()
```
This takes the parameters in the body of the request and puts them into the parameters map.

parseHeaders
```
public void parseHeaders(List headerList)
```
Go through the list of headers, and build the headers/cookies arrays for the request object.

addIncludeQueryParameters

public void addIncludeQueryParameters(String queryString)

addIncludeAttributes

public void addIncludeAttributes(String requestURI,
                        String contextPath,
                        String servletPath,
                        String pathInfo,
                        String queryString)

removeIncludeQueryString

public void removeIncludeQueryString()

clearIncludeStackForForward

public void clearIncludeStackForForward()

setForwardQueryString

public void setForwardQueryString(String forwardQueryString)

removeIncludeAttributes
```
public void removeIncludeAttributes()
```

getAttribute
```
public Object getAttribute(String name)
```
Specified by:

getAttribute in interface ServletRequest

getAttributeNames
```
public Enumeration getAttributeNames()
```
Specified by:

getAttributeNames in interface ServletRequest

removeAttribute
```
public void removeAttribute(String name)
```
Specified by:

removeAttribute in interface ServletRequest

setAttribute

public void setAttribute(String name,
                Object o)

Specified by:: setAttribute in interface ServletRequest

getCharacterEncoding
```
public String getCharacterEncoding()
```
Specified by:

getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException

Specified by:: setCharacterEncoding in interface ServletRequest
Throws:: UnsupportedEncodingException

getContentLength
```
public int getContentLength()
```
Specified by:

getContentLength in interface ServletRequest

getContentType
```
public String getContentType()
```
Specified by:

getContentType in interface ServletRequest

getLocale
```
public Locale getLocale()
```
Specified by:

getLocale in interface ServletRequest

getLocales
```
public Enumeration getLocales()
```
Specified by:

getLocales in interface ServletRequest

getProtocol
```
public String getProtocol()
```
Specified by:

getProtocol in interface ServletRequest

getScheme
```
public String getScheme()
```
Specified by:

getScheme in interface ServletRequest

isSecure
```
public boolean isSecure()
```
Specified by:

isSecure in interface ServletRequest

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:: getReader in interface ServletRequest
Throws:: IOException

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:: getInputStream in interface ServletRequest
Throws:: IOException

getParameter
```
public String getParameter(String name)
```
Specified by:

getParameter in interface ServletRequest

getParameterNames
```
public Enumeration getParameterNames()
```
Specified by:

getParameterNames in interface ServletRequest

getParameterValues
```
public String[] getParameterValues(String name)
```
Specified by:

getParameterValues in interface ServletRequest

getParameterMap
```
public Map getParameterMap()
```
Specified by:

getParameterMap in interface ServletRequest

getServerName
```
public String getServerName()
```
Specified by:

getServerName in interface ServletRequest

getServerPort
```
public int getServerPort()
```
Specified by:

getServerPort in interface ServletRequest

getRemoteAddr
```
public String getRemoteAddr()
```
Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost
```
public String getRemoteHost()
```
Specified by:

getRemoteHost in interface ServletRequest

getRemotePort
```
public int getRemotePort()
```
Specified by:

getRemotePort in interface ServletRequest

getLocalAddr
```
public String getLocalAddr()
```
Specified by:

getLocalAddr in interface ServletRequest

getLocalName
```
public String getLocalName()
```
Specified by:

getLocalName in interface ServletRequest

getLocalPort
```
public int getLocalPort()
```
Specified by:

getLocalPort in interface ServletRequest

getRequestDispatcher
```
public RequestDispatcher getRequestDispatcher(String path)
```
Specified by:

getRequestDispatcher in interface ServletRequest

getContextPath
```
public String getContextPath()
```
Specified by:

getContextPath in interface HttpServletRequest

getCookies
```
public Cookie[] getCookies()
```
Specified by:

getCookies in interface HttpServletRequest

getDateHeader
```
public long getDateHeader(String name)
```
Specified by:

getDateHeader in interface HttpServletRequest

getIntHeader
```
public int getIntHeader(String name)
```
Specified by:

getIntHeader in interface HttpServletRequest

getHeader
```
public String getHeader(String name)
```
Specified by:

getHeader in interface HttpServletRequest

getHeaderNames
```
public Enumeration getHeaderNames()
```
Specified by:

getHeaderNames in interface HttpServletRequest

getHeaders
```
public Enumeration getHeaders(String name)
```
Specified by:

getHeaders in interface HttpServletRequest

getMethod
```
public String getMethod()
```
Specified by:

getMethod in interface HttpServletRequest

getPathInfo
```
public String getPathInfo()
```
Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated
```
public String getPathTranslated()
```
Specified by:

getPathTranslated in interface HttpServletRequest

getQueryString
```
public String getQueryString()
```
Specified by:

getQueryString in interface HttpServletRequest

getRequestURI
```
public String getRequestURI()
```
Specified by:

getRequestURI in interface HttpServletRequest

getServletPath
```
public String getServletPath()
```
Specified by:

getServletPath in interface HttpServletRequest

getRequestedSessionId
```
public String getRequestedSessionId()
```
Specified by:

getRequestedSessionId in interface HttpServletRequest

getRequestURL
```
public StringBuffer getRequestURL()
```
Specified by:

getRequestURL in interface HttpServletRequest

getUserPrincipal
```
public Principal getUserPrincipal()
```
Specified by:

getUserPrincipal in interface HttpServletRequest

isUserInRole
```
public boolean isUserInRole(String role)
```
Specified by:

isUserInRole in interface HttpServletRequest

getAuthType
```
public String getAuthType()
```
Specified by:

getAuthType in interface HttpServletRequest

getRemoteUser
```
public String getRemoteUser()
```
Specified by:

getRemoteUser in interface HttpServletRequest

isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

getSession
```
public HttpSession getSession()
```
Specified by:

getSession in interface HttpServletRequest

getSession
```
public HttpSession getSession(boolean create)
```
Specified by:

getSession in interface HttpServletRequest

markSessionsAsRequestFinished

public void markSessionsAsRequestFinished(long lastAccessedTime,
                                 boolean saveSessions)

getRealPath
```
public String getRealPath(String path)
```
Deprecated.

Specified by:

getRealPath in interface ServletRequest

isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

Class WinstoneRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

headerDF

rnd

attributes

parameters

attributesStack

parametersStack

headers

cookies

method

scheme

serverName

requestURI

servletPath

pathInfo

queryString

protocol

contentLength

contentType

encoding

serverPort

remoteIP

remoteName

remotePort

localAddr

localName

localPort

parsedParameters

requestedSessionIds

currentSessionIds

deadRequestedSessionId

locales

authorization

isSecure

inputData

inputReader

servletConfig

webappConfig

hostGroup

authenticatedUser

requestAttributeListeners

requestListeners

Constructor Detail

WinstoneRequest

Method Detail

cleanUp

getAttributes

getParameters

getAttributesStack

getParametersStack

getCurrentSessionIds

getRequestedSessionIds

getDeadRequestedSessionId

getHostGroup

getWebAppConfig

getServletConfig

getEncoding

getParsedParameters

getListLocales

setInputStream

setHostGroup

setWebAppConfig

setServletConfig

setServerPort

setRemoteIP

setRemoteName

setRemotePort

setLocalAddr

setLocalName

setLocalPort

setMethod

setIsSecure

setQueryString

setServerName